腾讯云对象存储升级到 XML JavaScript SDK

如果您细心对比过 JSON JavaScript SDK 和 XML JavaScript SDK 的文档，您会发现并不是一个简单的增量更新。XML JavaScript SDK 在架构、可用性和安全性上有了非常大的提升，而且在易用性、健壮性和性能上也做了非常大的改进。如果您想要升级到 XML JavaScript SDK，请参考下面的指引，完成 JavaScript SDK 的升级工作。

功能对比

升级步骤

1. 更新 JavaScript SDK

XML JavaScript SDK 发布在 npm 仓库，推荐您使用 npm 安装依赖包。

npm install cos-js-sdk-v5

您也可以在 github 源码中下载 js 文件 dist/cos-js-sdk-v5.min.js ，通过 script 标签加入页面 html。

2. 更改存储桶名称和可用区域简称

XML JavaScript SDK 的存储桶名称和可用区域简称与 JSON JavaScript SDK 的不同，需要您进行相应的更改。

存储桶 Bucket

XML JavaScript SDK 存储桶名称由两部分组成：用户自定义字符串和 APPID，两者以中划线“-”相连。
例如 examplebucket-1250000000，其中 examplebucket 为用户自定义字符串，1250000000 为 APPID。说明APPID 是腾讯云账户的账户标识之一，用于关联云资源。在用户成功申请腾讯云账户后，系统自动为用户分配一个 APPID。您可通过腾讯云控制台，在 账号信息 查看 APPID。查询 Bucket 的对象列表，请参考以下示例代码：

cos.getBucket({    Bucket: 'examplebucket-1250000000', /* 必须 */    Region: 'COS_REGION',     /* 存储桶所在地域，必须字段 */    Prefix: 'a/',           /* 非必须 */}, function(err, data) {    console.log(err || data.Contents);});

存储桶可用区域简称 Region

XML JavaScript SDK 的存储桶可用区域简称发生了变化，不同区域在 JSON JavaScript SDK 和 XML JavaScript SDK 中的对应关系请查看下表：

您也可以参考 地域和访问域名 文档。在调用每个方法时，请将存储桶所在区域的简称设置到参数 Region 中：

cos.headBucket({    Bucket: 'examplebucket-1250000000', /* 必须 */    Region: 'COS_REGION',     /* 存储桶所在地域，必须字段 */}, function(err, data) {    console.log(err || data);});

3. 更改 API

升级到 XML JavaScript SDK 之后，一些操作的 API 发生了变化，请您根据实际需求进行相应的更改。同时我们做了封装让 SDK 更加易用，具体请参考我们的 示例代码 和 快速入门。API 变化主要有以下变化：（1）没有单独的目录接口在 XML SDK 中，不再提供单独的目录接口。对象存储中本身是没有文件夹和目录的概念的，对象存储不会因为上传对象project/a.txt 而创建一个 project 文件夹。为了满足用户使用习惯，对象存储在控制台、COSBrowser 等图形化工具中模拟了文件夹或目录的展示方式，具体实现是通过创建一个键值为project/，内容为空的对象，在展示方式上模拟了传统文件夹。例如：上传对象project/doc/a.txt，分隔符/会模拟文件夹的展示方式，于是可以看到控制台上出现文件夹project 和 doc，其中 doc 是 project 下一级文件夹，并包含 a.txt 文件。因此，如果您的应用场景只是上传文件，可以直接上传即可，不需要先创建文件夹。使用场景里面有文件夹的概念，则需要提供创建文件夹的功能，您可以上传一个路径以/结尾的0KB 文件。这样在您调用 GetBucket 接口时，就可以将该文件当做文件夹。（2）使用临时密钥鉴权由于密钥放在前端代码有安全风险，后端计算签名给前端权限不好控制，XML JavaScript SDK 推荐您使用临时密钥的方式。具体代码参考以下示例：

var COS = require('cos-js-sdk-v5');var cos = new COS({    // 必选参数    getAuthorization: function (options, callback) {        // 服务端 JS 和 PHP 例子：https://github.com/tencentyun/cos-js-sdk-v5/blob/master/server/        // 服务端其他语言参考 COS STS SDK ：https://github.com/tencentyun/qcloud-cos-sts-sdk        // STS 详细文档指引看：https://cloud.tencent.com/document/product/436/14048        $.get('http://example.com/server/sts.php', {            // 可从 options 取需要的参数        }, function (data) {            callback({                TmpSecretId: data.TmpSecretId,                TmpSecretKey: data.TmpSecretKey,                SecurityToken: data.SecurityToken,                ExpiredTime: data.ExpiredTime, // SDK 在 ExpiredTime 时间前，不会再次调用 getAuthorization            });        });    }});

如果您仍然采用后台手动计算签名，再返回前端使用的方式，请注意我们的签名算法发生了改变。签名不再区分单次和多次签名，而是通过设置签名的有效期来保证安全性。请参考 XML 请求签名 文档更新您签名的实现。（3）参数和返回统一格式参数是一个对象，除了一些工具方法，接口格式都是通过一个回调返回错误信息或成功结果，如下示例：

cos.putObject({    Bucket: 'examplebucket-1250000000', /* 必须 */    Region: 'COS_REGION',     /* 存储桶所在地域，必须字段 */    Key: 'exampleobject',              /* 必须 */    StorageClass: 'STANDARD',    Body: file, // 上传文件对象    onProgress: function(progressData) {        console.log(JSON.stringify(progressData));    }}, function(err, data) {    console.log(err || data);});

（4）新增 APIXML JavaScript SDK 新增 API，您可根据需求进行调用。包括：存储桶的操作，例如 getService 、putBucket、getBucket 等。存储桶 ACL 的操作，例如 getBucketAcl、putBucketAcl 等。存储桶 Policy 的操作，putBucketPolicy、getBucketPolicy、 deleteBucketPolicy。存储桶生命周期的操作，例如 putBucketLifecycle、getBucketLifecycle、 deleteBucketLifecycle。对象 ACL 操作：getObjectAcl、putObjectAcl。对象复制操作：putObjectCopy、sliceCopyFile。工具方法：getObjectUrl。对象上传队列：pauseTask、restartTask、cancelTask、getTaskList 方法以及 list-update 事件。了解更多请参见 JavaScript SDK 快速入门 文档。
对象存储官网1折活动，限时活动，即将结束，速速收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利。同意关联立享优惠