Merge pull request #112 from livehigh/feat/add-uploadFile

carsonxu · web-flow · commit 33d02bf1be9d · 2021-06-11T16:16:09.000+08:00
Feat/add upload file
diff --git a/demo/demo.js b/demo/demo.js
@@ -1155,6 +1155,28 @@ function abortUploadTask() {
     });
 }
 
+function uploadFile() {
+    var filename = '10mb.zip';
+    var blob = util.createFile({size: 1024 * 1024 * 10});
+    cos.uploadFile({
+        Bucket: config.Bucket, // Bucket 格式：test-1250000000
+        Region: config.Region,
+        Key: filename,
+        Body: blob,
+        SliceSize: 1024 * 1024 * 5, // 大于5mb才进行分块上传
+        onProgress: function (info) {
+            var percent = Math.floor(info.percent * 10000) / 100;
+            var speed = Math.floor(info.speed / 1024 / 1024 * 100) / 100;
+            logger.log('进度：' + percent + '%; 速度：' + speed + 'Mb/s;');
+        },
+        onFileFinish: function (err, data, options) {
+            logger.log(options.Key + ' 上传' + (err ? '失败' : '完成'));
+        },
+    }, function (err, data) {
+        logger.log('uploadFile:', err || data);
+    });
+}
+
 function sliceUploadFile() {
     var blob = util.createFile({size: 1024 * 1024 * 3});
     cos.sliceUploadFile({
@@ -1688,6 +1710,7 @@ function CIExample4(){
         'putObject_base64ToBlob',
 
         'header-高级操作',
+        'uploadFile',
         'sliceUploadFile',
         'selectFileToUpload',
         'sliceCopyFile',
@@ -1711,6 +1734,7 @@ function CIExample4(){
     var labelMap = {
         putObject: '简单上传',
         putObject_base64ToBlob: '简单上传：base64转blob',
+        uploadFile: '高级上传',
         sliceUploadFile: '分片上传',
         sliceCopyFile: '分片复制',
         uploadFiles: '批量上传文件',
diff --git a/dist/cos-js-sdk-v5.js b/dist/cos-js-sdk-v5.js
@@ -2422,7 +2422,7 @@ base.init(COS, task);
 advance.init(COS, task);
 
 COS.getAuthorization = util.getAuth;
-COS.version = '1.2.12';
+COS.version = '1.2.13';
 
 module.exports = COS;
 
@@ -9342,6 +9342,52 @@ function abortUploadTaskArray(params, callback) {
     });
 }
 
+// 高级上传
+function uploadFile(params, callback) {
+    var self = this;
+
+    // 判断多大的文件使用分片上传
+    var SliceSize = params.SliceSize === undefined ? self.options.SliceSize : params.SliceSize;
+
+    var taskList = [];
+
+    var Body = params.Body;
+    var FileSize = Body.size || Body.length || 0;
+    var fileInfo = { TaskId: '' };
+
+    // 整理 option，用于返回给回调
+    util.each(params, function (v, k) {
+        if (typeof v !== 'object' && typeof v !== 'function') {
+            fileInfo[k] = v;
+        }
+    });
+
+    // 处理文件 TaskReady
+    var _onTaskReady = params.onTaskReady;
+    var onTaskReady = function (tid) {
+        fileInfo.TaskId = tid;
+        _onTaskReady && _onTaskReady(tid);
+    };
+    params.onTaskReady = onTaskReady;
+
+    // 处理文件完成
+    var _onFileFinish = params.onFileFinish;
+    var onFileFinish = function (err, data) {
+        _onFileFinish && _onFileFinish(err, data, fileInfo);
+        callback && callback(err, data);
+    };
+
+    // 添加上传任务,超过阈值使用分块上传，小于等于则简单上传
+    var api = FileSize > SliceSize ? 'sliceUploadFile' : 'putObject';
+    taskList.push({
+        api: api,
+        params: params,
+        callback: onFileFinish
+    });
+
+    self._addTasks(taskList);
+}
+
 // 批量上传文件
 function uploadFiles(params, callback) {
     var self = this;
@@ -9676,6 +9722,7 @@ function copySliceItem(params, callback) {
 var API_MAP = {
     sliceUploadFile: sliceUploadFile,
     abortUploadTask: abortUploadTask,
+    uploadFile: uploadFile,
     uploadFiles: uploadFiles,
     sliceCopyFile: sliceCopyFile
 };
diff --git a/dist/cos-js-sdk-v5.min.js b/dist/cos-js-sdk-v5.min.js
diff --git a/index.d.ts b/index.d.ts
@@ -1732,6 +1732,34 @@ Bulk：批量模式，恢复时间为24 - 48小时。 */
     }[],
   }
 
+  // uploadFile 高级上传
+  interface FileFinishInfo {
+    err: Error;
+    data: UploadFileItemResult;
+    options: UploadFileItemParams;
+  }
+  type onFileFinish = (params: FileFinishInfo) => void;
+
+  type UploadFileParams = (PutObjectParams | SliceUploadFileParams) & {
+    /** 要上传的本地文件路径 */
+    Body: UploadBody,
+    /** 使用 uploadFile 高级上传时，文件大小大于该数值将使用按分块上传，否则将调用简单上传，单位 Byte，默认值1048576（1MB） */
+    SliceSize?: number,
+    /** 上传的进度回调方法 */
+    onProgress?: onProgress,
+    /** 上传完成回调方法 */
+    onFileFinish?: onFileFinish,
+  }
+
+  interface UploadFileResult extends GeneralResult {
+     /** 对象的实体标签（Entity Tag），是对象被创建时标识对象内容的信息标签，可用于检查对象的内容是否发生变化，例如"8e0b617ca298a564c3331da28dcb50df"。此头部并不一定返回对象的 MD5 值，而是根据对象上传和加密方式而有所不同 */
+     ETag: ETag,
+     /** 创建的存储桶访问地址，不带 https:// 前缀，例如 examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/images/1.jpg */
+     Location: string,
+     /** 对象的版本 ID */
+     VersionId?: VersionId,
+  }
+
   // sliceCopyFile
   /** sliceCopyFile 接口参数 */
   interface SliceCopyFileParams extends ObjectParams {
@@ -2119,7 +2147,11 @@ declare class COS {
   abortUploadTask(params: COS.AbortUploadTaskParams, callback: (err: COS.CosError, data: COS.AbortUploadTaskResult) => void): void;
   abortUploadTask(params: COS.AbortUploadTaskParams): Promise<COS.AbortUploadTaskResult>;
 
-  /** 分片复制文件 */
+  /** 高级上传文件 */
+  uploadFile(params: COS.UploadFileParams, callback: (err: COS.CosError, data: COS.UploadFileResult) => void): void;
+  uploadFile(params: COS.UploadFileParams): Promise<COS.UploadFileResult>;
+
+  /** 批量上传文件 */
   uploadFiles(params: COS.UploadFilesParams, callback: (err: COS.CosError, data: COS.UploadFilesResult) => void): void;
   uploadFiles(params: COS.UploadFilesParams): Promise<COS.UploadFilesResult>;
 
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "cos-js-sdk-v5",
-  "version": "1.2.12",
+  "version": "1.2.13",
   "description": "JavaScript SDK for [腾讯云对象存储](https://cloud.tencent.com/product/cos)",
   "main": "index.js",
   "types": "index.d.ts",
diff --git a/src/advance.js b/src/advance.js
@@ -778,6 +778,51 @@ function abortUploadTaskArray(params, callback) {
     });
 }
 
+// 高级上传
+function uploadFile(params, callback) {
+    var self = this;
+
+    // 判断多大的文件使用分片上传
+    var SliceSize = params.SliceSize === undefined ? self.options.SliceSize : params.SliceSize;
+
+    var taskList = [];
+
+    var Body = params.Body;
+    var FileSize = Body.size || Body.length || 0;
+    var fileInfo = {TaskId: ''};
+
+    // 整理 option，用于返回给回调
+    util.each(params, function (v, k) {
+        if (typeof v !== 'object' && typeof v !== 'function') {
+            fileInfo[k] = v;
+        }
+    });
+
+    // 处理文件 TaskReady
+    var _onTaskReady = params.onTaskReady;
+    var onTaskReady = function (tid) {
+        fileInfo.TaskId = tid;
+        _onTaskReady && _onTaskReady(tid);
+    };
+    params.onTaskReady = onTaskReady;
+
+    // 处理文件完成
+    var _onFileFinish = params.onFileFinish;
+    var onFileFinish = function (err, data) {
+        _onFileFinish && _onFileFinish(err, data, fileInfo);
+        callback && callback(err, data);
+    };
+
+    // 添加上传任务,超过阈值使用分块上传，小于等于则简单上传
+    var api = FileSize > SliceSize ? 'sliceUploadFile' : 'putObject';
+    taskList.push({
+        api: api,
+        params: params,
+        callback: onFileFinish,
+    });
+
+    self._addTasks(taskList);
+}
 
 // 批量上传文件
 function uploadFiles(params, callback) {
@@ -1113,6 +1158,7 @@ function copySliceItem(params, callback) {
 var API_MAP = {
     sliceUploadFile: sliceUploadFile,
     abortUploadTask: abortUploadTask,
+    uploadFile: uploadFile,
     uploadFiles: uploadFiles,
     sliceCopyFile: sliceCopyFile,
 };
diff --git a/src/cos.js b/src/cos.js
@@ -64,6 +64,6 @@ base.init(COS, task);
 advance.init(COS, task);
 
 COS.getAuthorization = util.getAuth;
-COS.version = '1.2.12';
+COS.version = '1.2.13';
 
 module.exports = COS;
diff --git a/test/test.js b/test/test.js
@@ -3629,6 +3629,51 @@ group('restoreObject()', function () {
     });
 });
 
+group('uploadFile()', function () {
+    // 高级上传
+    test('uploadFile() 高级上传', function (done, assert) {
+        var filename = '3m.zip';
+        var blob = util.createFile({size: 1024 * 1024 * 3});
+        cos.uploadFile({
+          Bucket: config.Bucket,
+          Region: config.Region,
+          Key: filename,
+          Body: blob,
+        }, function (err, data) {
+            console.log(data);
+            assert.ok(!err);
+            done();
+        });
+    });
+    test('uploadFile() 高级上传内容为空', function (done, assert) {
+        var filename = '3m.zip';
+        cos.uploadFile({
+          Bucket: config.Bucket,
+          Region: config.Region,
+          Key: filename,
+          Body: '',
+        }, function (err, data) {
+            assert.ok(!err);
+            done();
+        });
+    });
+    test('uploadFile() 高级上传 大于5mb则分块上传', function (done, assert) {
+        var filename = '3m.zip';
+        var blob = util.createFile({size: 1024 * 1024 * 3});
+        cos.uploadFile({
+          Bucket: config.Bucket,
+          Region: config.Region,
+          Key: filename,
+          Body: blob,
+          SliceSize: 1024 * 1024 * 5,
+        }, function (err, data) {
+            assert.ok(!err);
+            done();
+        });
+    });
+});
+
+
 group('uploadFiles()', function () {
     test('uploadFiles()', function (done, assert) {
         var filename = '1.zip';

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "cos-js-sdk-v5",`
`3`		`- "version": "1.2.12",`
	`3`	`+ "version": "1.2.13",`
`4`	`4`	`"description": "JavaScript SDK for [腾讯云对象存储](https://cloud.tencent.com/product/cos)",`
`5`	`5`	`"main": "index.js",`
`6`	`6`	`"types": "index.d.ts",`