当下载大文件时,如果网络不稳定或者程序异常退出,会导致下载失败,甚至重试多次仍无法完成下载。为此OSS提供了断点续传下载功能。
断点续传下载将需要下载的文件分成若干个分片分别下载,所有分片都下载完成后,将所有分片合并成完整的文件。
您可以通过ossClient.downloadFile方法实现断点续传下载。此方法的DownloadFileRequest请求包含的参数请参见下表。
| 参数 | 是否必选 | 示例值 | 描述 | 如何设置 |
|---|---|---|---|---|
| bucketName | 是 | examplebucket | 存储空间(Bucket)名称。 | 通过构造方法设置。 |
| key | 是 | exampledir/exampleobject.txt | Object完整路径。Object完整路径中不能包含Bucket名称。 | 通过构造方法设置。 |
| downloadFile | 否 | D:\\localpath\\examplefile.txt | 本地文件的完整路径。OSS文件将下载到该本地文件。 | 通过构造方法或setDownloadFile设置。 |
| partSize | 否 | 1 * 1024 * 1024 | 分片大小,取值范围为1 B~5 GB。 | 通过setPartSize设置。 |
| taskNum | 否 | 10 | 分片下载的并发数。默认值为1。 | 通过setTaskNum设置。 |
| enableCheckpoint | 否 | true | 是否开启断点续传功能。取值范围如下:
|
通过setEnableCheckpoint设置。 |
| checkpointFile | 否 | D:\\localpath\\examplefile.txt.dcp | 记录本地分片下载结果的文件。开启断点续传功能时需要设置此参数。下载过程中的进度信息会保存在该文件中,如果某一分片下载失败,再次下载时会根据文件中记录的点继续下载。下载完成后,该文件会被删除。 文件默认名称为downloadFile.dcp,且与downloadFile处于相同路径。 |
通过setCheckpointFile设置。 |
以下代码用于断点续传下载。
// 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";
// 填写Bucket名称,例如examplebucket。
String bucketName = "examplebucket";
// 填写Object完整路径,例如exampledir/exampleobject.txt。Object完整路径中不能包含Bucket名称。
String objectName = "exampledir/exampleobject.txt";
// 创建OSSClient实例。
OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);
// 下载请求,10个任务并发下载,启动断点续传。
DownloadFileRequest downloadFileRequest = new DownloadFileRequest(bucketName, objectName);
downloadFileRequest.setDownloadFile("D:\\localpath\\examplefile.txt");
downloadFileRequest.setPartSize(1 * 1024 * 1024);
downloadFileRequest.setTaskNum(10);
downloadFileRequest.setEnableCheckpoint(true);
// 设置断点记录文件的完整路径。只有当Object下载中断产生了断点记录文件后,如果需要继续下载该Object,才需要设置对应的断点记录文件。
//downloadFileRequest.setCheckpointFile("D:\\localpath\\examplefile.txt.dcp");
// 下载文件。
DownloadFileResult downloadRes = ossClient.downloadFile(downloadFileRequest);
// 下载成功时,会返回文件元信息。
ObjectMetadata objectMetadata = downloadRes.getObjectMetadata();
System.out.println(objectMetadata.getETag());
System.out.println(objectMetadata.getLastModified());
System.out.println(objectMetadata.getUserMetadata().get("meta"));
// 关闭OSSClient。
ossClient.shutdown();