当下载大文件时,如果网络不稳定或者程序异常退出,会导致下载失败,甚至重试多次仍无法完成下载。为此,OSS提供了断点续传下载功能。断点续传下载将需要下载的文件分成若干个分片分别下载,所有分片都下载完成后,将所有分片合并成完整的文件。

实现方法

您可以通过 OssClient .ResumableDownloadObject 方法实现断点续传下载。此方法的 DownloadObjectRequest 请求包含以下参数:

参数 描述 是否必需 默认值 如何设置
bucket 存储空间名称。 通过构造方法设置。
key OSS文件完整路径。 通过构造方法设置。
filePath 本地文件完整路径。 OSS文件名称 通过构造方法设置。
partSize 分片大小,取值范围为100 KB~5 GB。 8 MB 通过setPartSize设置。
threadNum 分片下载的并发数。 3 通过构造方法或者 setThreadNum 设置。
checkpointDir 记录本地分片下载结果的文件。开启断点续传功能时需要设置此参数。下载过程中的进度信息会保存在该文件中,如果某一分片下载失败,再次下载时会根据文件中记录的点继续下载。下载完成后,该文件会被删除。 与DownloadFile同目录。 通过构造方法或者 setCheckpointDir 设置。

示例代码

以下代码用于断点续传下载:

#include <alibabacloud/oss/OssClient.h>
using namespace AlibabaCloud::OSS;

int main(void)
{
    /* 初始化OSS账号信息 */
    /* 阿里云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维,请登录RAM控制台创建RAM用户。*/
    std::string AccessKeyId = "yourAccessKeyId";
    std::string AccessKeySecret = "yourAccessKeySecret";
    /* 填写Bucket所在地域对应的Endpoint。以华东1(杭州)为例,Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。*/
    std::string Endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
    /* 填写Bucket名称,例如examplebucket。*/
    std::string BucketName = "examplebucket";
    /* 填写Object完整路径,完整路径中不能包含Bucket名称,例如exampledir/exampleobject.txt。*/
    std::string ObjectName = "exampledir/exampleobject.txt";
    /* 下载Object到本地文件examplefile.txt,并保存到指定的本地路径中(D:\\localpath)。如果指定的本地文件存在会覆盖,不存在则新建。*/
    /* 如果未指定本地路径,则下载后的文件默认保存到示例程序所属项目对应本地路径中。*/
    std::string DownloadFilePath = "D:\\localpath\\examplefile.txt";
    /* 设置断点记录文件的完整路径,例如D:\\localpath\\examplefile.txt.dcp。*/
    /* 只有当Object下载中断产生了断点记录文件后,如果需要继续下载该Object,才需要设置对应的断点记录文件。下载完成后,该文件会被删除。*/
    std::string CheckpointFilePath = "D:\\localpath\\examplefile.txt.dcp";

    /* 初始化网络等资源。*/
    InitializeSdk();

    ClientConfiguration conf;
    OssClient client(Endpoint, AccessKeyId, AccessKeySecret, conf);

    /* 断点续传下载。*/
    DownloadObjectRequest request(BucketName, ObjectName, DownloadFilePath, CheckpointFilePath);
    auto outcome = client.ResumableDownloadObject(request);

    if (!outcome.isSuccess()) {
        /* 异常处理。*/
        std::cout << "ResumableDownloadObject fail" <<
        ",code:" << outcome.error().Code() <<
        ",message:" << outcome.error().Message() <<
        ",requestId:" << outcome.error().RequestId() << std::endl;
        ShutdownSdk();
        return -1;
    }

    /* 释放网络等资源。*/
    ShutdownSdk();
    return 0;
}

相关文档

  • 关于断点续传下载的完整示例代码,请参见GitHub示例
  • 关于断点续传下载的API接口说明,请参见GetObject