断点续传下载

功能说明

对范围下载的封装和加强，解决下载大对象到本地时由于网络不稳定或程序崩溃导致下载失败的问题。

方法定义

ObsClient.downloadFile

请求参数

返回结果（InterfaceResult）

代码样例

本示例用于断点续传下载examplebucket桶里的objectname对象并打印进度。

// 使用npm安装
var ObsClient = require('esdk-obs-nodejs');

// 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量AccessKeyID和SecretAccessKey。
// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
const AK = process.env.AccessKeyID
const SK = process.env.SecretAccessKey
// 【可选】如果使用临时AKSK和SecurityToken访问OBS，则同样推荐通过环境变量获取
const security_token= process.env.SecurityToken
//  server填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写。
const server = "https://obs.cn-north-4.myhuaweicloud.com"
var obsClient = new ObsClient({
    access_key_id: AK,
    secret_access_key: SK,
    server: server,
});
const Bucket = 'examplebucket'
// 下载的目标对象
const Key = 'objectname'
// 设置下载对象的本地文件路径
const DownloadFile = 'D:\\example'
// 设置分段大小为10MB
const PartSize = 10 * 1024 * 1024
// 并发数
const TaskNum = 10
// 接收取消断点续传下载任务控制参数
var hook;
// 断点续传下载
try {
    obsClient.downloadFile({
        Bucket,
        Key,
        DownloadFile,
        PartSize,
        TaskNum,
        // 开启断点续传模式
        EnableCheckpoint: true,
        // 进度回调
        ProgressCallback: function (transferredAmount, totalAmount, totalSeconds) {
            // 打印下载速度，单位KB/S
            console.log(transferredAmount * 1.0 / totalSeconds / 1024);
            // 打印下载百分比
            console.log(transferredAmount * 100.0 / totalAmount);
            // 当下载进度到达50%时暂停任务
            // if(hook && (transferredAmount / totalAmount) > 0.5){
            //     // 暂停断点续传任务
            //     hook.cancel();
            // }
        },
        ResumeCallback : function(resumeHook){
            // 获取取消断点续传下载任务控制参数
            hook = resumeHook;
        }
    }, (err, result) => {
        if (err) {
            console.log('DownloadFile Failed')
            console.error('Error-->' + err);
        } else {
            if (result.CommonMsg.Status < 300) {
                console.log('DownloadFile Succeeded')
                console.log('RequestId-->' + result.InterfaceResult.RequestId);
                console.log('LastModified-->' + result.InterfaceResult.LastModified);
                console.log('Metadata-->' + JSON.stringify(result.InterfaceResult.Metadata)); 
            } else {
                console.log('DownloadFile Failed')
                console.log('ErrorCode-->' + result.CommonMsg.Code);
                console.log('ErrorMessage-->' + result.CommonMsg.Message);
            }
        }
    });
} catch (error) {
    console.log('DownloadFile Failed')
    console.error('Error-->' + error);
}