更新时间:2023-11-09 GMT+08:00

断点续传上传

开发过程中,您有任何问题可以在github上提交issue接口参考文档详细介绍了每个接口的参数和使用方法。

当上传大文件时,经常出现因网络不稳定或程序崩溃导致上传失败的情况。失败后再次重新上传不仅浪费资源,而且当网络不稳定时仍然有上传失败的风险。断点续传上传接口能有效地解决此类问题引起的上传失败,其原理是将待上传的文件分成若干个分段分别上传,并实时地将每段上传结果统一记录在checkpoint文件中,仅当所有分段都上传成功时返回上传成功的结果,否则在回调函数中返回错误码提醒用户再次调用接口进行重新上传(重新上传时因为有checkpoint文件记录当前的上传进度,避免重新上传所有分段,从而节省资源提高效率)。

  • 断点续传上传接口传入的文件总大小至少要100K以上。

您可以通过ObsClient.uploadFile进行断点续传上传。该接口可设置的主要参数如下:

参数

作用

Bucket

桶名,必选参数。

Key

对象名,必选参数。

UploadFile

待上传的本地文件,必选参数。

PartSize

分段大小,单位字节,取值范围是100KB~5GB,默认为5MB。

TaskNum

分段上传时的最大并发数,默认为20。

EnableCheckpoint

是否开启断点续传模式,默认为false,表示不开启。

CheckpointFile

记录上传进度的文件,只在断点续传模式下有效。当该值为空时,默认与待上传的本地文件同目录。

EnableCheckSum

是否校验待上传文件的内容,只在断点续传模式下有效。默认为false,表示不校验。

以下代码展示了如何使用断点续传上传接口上传文件:

// 引入obs库
// 使用npm安装
var ObsClient = require('esdk-obs-nodejs');
// 使用源码安装
// var ObsClient = require('./lib/obs');

// 创建ObsClient实例
var obsClient = new ObsClient({
       //推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险。
       //您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/intl/zh-cn/usermanual-ca/ca_01_0003.html
       access_key_id: process.env.ACCESS_KEY_ID,
       secret_access_key: process.env.SECRET_ACCESS_KEY,
       server : 'https://your-endpoint'
});

obsClient.uploadFile({
       Bucket : 'bucketname',
       Key : 'objectname',
       // 设置待上传的本地文件,localfile为待上传的本地文件路径,需要指定到具体的文件名
       UploadFile : 'localfile',
       // 设置分段大小为10MB
       PartSize : 10 * 1024 * 1024,
       // 开启断点续传模式
       EnableCheckpoint : true
}, (err, result) => {
    if(err){
        console.error('Error-->' + err);
    }else{
        console.log('RequestId-->' + result.InterfaceResult.RequestId);
        console.log('Bucket-->' + result.InterfaceResult.Bucket);
        console.log('Key-->' + result.InterfaceResult.Key);
        console.log('Location-->' + result.InterfaceResult.Location);
    }
});
  • 断点续传上传接口是利用分段上传特性实现的,是对分段上传的封装和加强。
  • 断点续传上传接口不仅能在失败重传时节省资源提高效率,还因其对分段进行并发上传的机制能加快上传速度,能帮助用户快速完成上传业务;且其对用户透明,用户不用关心checkpoint文件的创建和删除、分段任务的切分、并发上传的实现等内部细节。
  • EnableCheckpoint参数默认是false,代表不启用断点续传模式,此时断点续传上传接口退化成对分段上传的简单封装,不会产生checkpoint文件。
  • CheckpointFile参数EnableCheckSum参数仅在EnableCheckpoint参数为true时有效。