通过断点续传上传的方式将文件上传到OSS前,您可以指定断点记录点。上传过程中,如果出现网络异常或程序崩溃导致文件上传失败时,将从断点记录处继续上传未上传完成的部分。
参数
您可以通过ossClient.uploadFile方法实现断点续传上传。此方法的uploadFileRequest请求包含的参数请参见下表。
参数 | 描述 |
---|---|
BucketName | 存储空间名称。 |
Key | 上传到OSS的文件名称。 |
UploadFile | 待上传的本地文件路径。 |
TaskNum | 上传并发线程数,默认值为1。 |
PartSize | 上传的分片大小,单位为Byte,取值范围为100 KB~5 GB。默认值为100 KB。 |
EnableCheckpoint | 是否开启断点续传功能,默认关闭。 |
CheckpointFile | 记录本地分片上传结果的文件。上传过程中的进度信息会保存在该文件中,如果某一分片上传失败,再次上传时会根据文件中记录的点继续上传。上传完成后,该文件会被删除。如果未设置该值,默认与待上传的本地文件同路径,名称为${uploadFile}.ucp。 |
Callback | 使用上传回调。关于上传回调的更多信息,请参见Callback和上传回调。 |
示例
以下代码用于断点续传上传。
/// yourEndpoint填写Bucket所在地域对应的Endpoint。以华东1(杭州)为例,Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。 String endpoint = "yourEndpoint"; // 阿里云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维,请登录RAM控制台创建RAM用户。 String accessKeyId = "yourAccessKeyId"; String accessKeySecret = "yourAccessKeySecret"; // 创建OSSClient实例。 OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret); ObjectMetadata meta = new ObjectMetadata(); // 指定上传的内容类型。 meta.setContentType("text/plain"); // 文件上传时设置访问权限ACL。 // meta.setObjectAcl(CannedAccessControlList.Private); // 通过UploadFileRequest设置多个参数。 // 填写Bucket名称和Object完整路径。Object完整路径中不能包含Bucket名称。 UploadFileRequest uploadFileRequest = new UploadFileRequest("examplebucket","exampleobject.txt"); // 通过UploadFileRequest设置单个参数。 // 填写Bucket名称。 //uploadFileRequest.setBucketName("examplebucket"); // 填写Object完整路径。Object完整路径中不能包含Bucket名称。 //uploadFileRequest.setKey("exampleobject.txt"); // 填写本地文件的完整路径。如果未指定本地路径,则默认从示例程序所属项目对应本地路径中上传文件。 uploadFileRequest.setUploadFile("D:\\localpath\\examplefile.txt"); // 指定上传并发线程数,默认值为1。 uploadFileRequest.setTaskNum(5); // 指定上传的分片大小。 uploadFileRequest.setPartSize(1 * 1024 * 1024); // 开启断点续传,默认关闭。 uploadFileRequest.setEnableCheckpoint(true); // 记录本地分片上传结果的文件。上传过程中的进度信息会保存在该文件中。 uploadFileRequest.setCheckpointFile("yourCheckpointFile"); // 文件的元数据。 uploadFileRequest.setObjectMetadata(meta); // 设置上传成功回调,参数为Callback类型。 //uploadFileRequest.setCallback("yourCallbackEvent"); // 断点续传上传。 ossClient.uploadFile(uploadFileRequest); // 关闭OSSClient。 ossClient.shutdown();