baiduYunBos

来自于：厦门软云网络科技有限公司立即使用

init putObject downloadObject deleteObject copyObject initiateMultipartUpload abortMultipartUpload listPartsRequest

概述

baiduYunBos模块封装了百度云对象存储服务BOS。

百度对象存储BOS(Baidu Object Storage)提供稳定、安全、高效、高可扩展的云存储服务。您可以将任意数量和形式的非结构化数据存入BOS，并对数据进行管理和处理。BOS支持标准、低频、冷存储等多种存储类型，满足您各类场景的存储需求。

使用前需了解百度云对象存储相关内容，可查看百度云对象存储文档。

环境要求

1.ios系统版本：ios8.0及以上, 请注意编译时在编译界面的高级设置里面选择支持的系统版本。

2.Android: 编译时需勾选“使用升级环境编译”。

3.必须注册有百度云用户账户，并开通Bos服务。。

使用此模块之前先配置 config 文件，配置方法如下：

  • 名称：baiduYunBos
  • 参数：ak、sk、endPoint
  • 配置示例:
  1. <feature name="baiduYunBos">
  2.     <param name="ak" value="f773bf0ba565412b*****" />
  3.     <param name="sk" value="6175cbefdf4e42******" />
  4.     <param name="endPoint" value="https://gz.bcebos.com" />
  5. </feature>

模块接口

init

初始化sdk （调用优先级最高，只需要调用一次） 如果有输入参数，则使用输入的参数，否则默认从config文件中读取参数。

init({params}, callback(ret, err))

示例代码

  1. var bos = api.require('baiduYunBos');
  2. bos.init();

params

accessKey：

  • 类型：字符串
  • 描述：（可选项）从百度云获取的Access Key

secretKey：

  • 类型：字符串
  • 描述：（可选项）从百度云获取的Secret Key

endpoint：

  • 类型：字符串
  • 描述：（可选项）百度云Bos服务在各个区域的地址，如：https://gz.bcebos.com

token：

  • 类型：字符串
  • 描述：（可选项）STS临时授权访问使用的签名[临时授权访问]

type：

  • 类型：数字
  • 描述：（可选项）1-使用ak\sk初始化模块；2-STS临时授权访问, 使用该模式必须传accessKey、secretKey、token参数，推荐使用该模式进行开发
  • 默认值： 1

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     eventType: 'onError',    //字符串类型；事件类型
  3.                              //取值范围：
  4.                              //onError（失败）
  5. }

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

putObject

简单上传，支持不超过5GB的Object上传；如果文件超过5GB请使用分块上传

putObject({params}, callback(ret, err))

params

bucket：

  • 类型：字符串
  • 描述：文件存储桶的名称，如：module-test

objectKey：

  • 类型：字符串
  • 描述：文件存储在云上的命名，如：test/test.jpg，云会自动创建test文件夹，以便存储文件

filePath：

  • 类型：字符串
  • 描述：上传对象，需上传本地文件路径，支持fs://、widget://等文件路径协议及真实路径

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     eventType: 'onComplete',    //字符串类型；事件类型
  3.                              //取值范围：
  4.                              //onComplete（成功）
  5.                              //onProgress（进度）
  6.                              //onError（失败）
  7.     progress: '',             //字符串类型；已上传进度，仅onProgress有值
  8.     key: '',           //字符串类型；文件在云上的名称，仅onComplete有值
  9.     etag: '',           //字符串类型；ETag (entity tag) 在每个Object生成的时候被创建，用于标示一个Object的内容。仅onComplete有值
  10.     requestID: '',           //字符串类型；仅onComplete有值(仅ios有值)
  11. }

示例代码

  1. var bos = api.require('baiduYunBos');
  2. bos.putObject({
  3.     bucket: "module-test",
  4.     objectKey: "test/img2",
  5.     filePath: "widget://image/test.jpg"
  6. }, function(ret, err){      
  7.     if( ret ){
  8.         alert( JSON.stringify( ret ) );
  9.     }else{
  10.         alert( JSON.stringify( err ) );
  11.     }
  12. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

downloadObject

下载文件

downloadObject({params}, callback(ret, err))

params

bucket：

  • 类型：字符串
  • 描述：文件存储桶的名称，如：module-test

objectKey：

  • 类型：字符串
  • 描述：文件存储在云上的命名，如：test/test.jpg

filePath：

  • 类型：字符串
  • 描述：文件下载后的路径, 如：test.jpg

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     eventType: 'onComplete',    //字符串类型；事件类型
  3.                              //取值范围：
  4.                              //onComplete（成功）
  5.                              //onProgress（进度）
  6.                              //onError（失败）
  7.     progress: '',             //字符串类型；已上传进度，仅onProgress有值
  8.     localPath: ''              //字符串类型；文件下载的本地地址，仅onComplete有值
  9. }

示例代码

  1. var bos = api.require('baiduYunBos');
  2. bos.downloadObject({
  3.     bucket: "module-test",
  4.     objectKey: "test/img1",
  5.     filePath: "test.jpg"
  6. }, function(ret, err){      
  7.     if( ret ){
  8.         alert( JSON.stringify( ret ) );
  9.     }else{
  10.         alert( JSON.stringify( err ) );
  11.     }
  12. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

deleteObject

删除文件

deleteObject({params}, callback(ret, err))

params

bucket：

  • 类型：字符串
  • 描述：文件存储桶的名称，如：module-test

objectKey：

  • 类型：字符串
  • 描述：文件存储在云上的命名，如：test/test.jpg

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     eventType: 'onComplete',    //字符串类型；事件类型
  3.                              //取值范围：
  4.                              //onComplete（成功）
  5.                                 //onError（失败）
  6. }

示例代码

  1. var bos = api.require('baiduYunBos');
  2. bos.deleteObject({
  3.     bucket: "module-test",
  4.     objectKey: "test/img1"
  5. }, function(ret, err){      
  6.     if( ret ){
  7.         alert( JSON.stringify( ret ) );
  8.     }else{
  9.         alert( JSON.stringify( err ) );
  10.     }
  11. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

copyObject

复制文件

copyObject({params}, callback(ret, err))

params

srcBucket：

  • 类型：字符串
  • 描述：目标文件存储桶的名称，如：module-test

srcObjectKey：

  • 类型：字符串
  • 描述：目标文件存储在云上的命名，如：test/test1.jpg

dstBucket：

  • 类型：字符串
  • 描述：复制文件存储桶的名称，如：module-test

dstObjectKey：

  • 类型：字符串
  • 描述：复制文件存储在云上的命名，如：test/test2.jpg

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     eventType: 'onComplete',    //字符串类型；事件类型
  3.                              //取值范围：
  4.                              //onComplete（成功）
  5.                              //onError（失败）
  6. }

示例代码

  1. var bos = api.require('baiduYunBos');
  2. bos.copyObject({
  3.     srcBucket: "module-test",
  4.     srcObjectKey: "test/img1",
  5.     dstBucket: "module-test",
  6.     dstObjectKey: "test/img2"
  7. }, function(ret, err){      
  8. if( ret ){
  9.         alert( JSON.stringify( ret ) );
  10.     }else{
  11.         alert( JSON.stringify( err ) );
  12.     }
  13. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

initiateMultipartUpload

分块上传，使用场景：需要支持断点上传、上传超过5GB大小的文件、网络条件较差，和BOS的服务器之间的连接经常断开、需要流式地上传文件、上传文件之前，无法确定上传文件的大小等。

initiateMultipartUpload({params}, callback(ret, err))

params

bucket：

  • 类型：字符串
  • 描述：文件存储桶的名称，如：module-test

objectKey：

  • 类型：字符串
  • 描述：文件存储在云上的命名，如：test/test.jpg，云会自动创建test文件夹，以便存储文件

filePath：

  • 类型：字符串
  • 描述：上传对象，需上传本地文件路径，支持fs://、widget://等文件路径协议及真实路径

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     eventType: 'onComplete',    //字符串类型；事件类型
  3.                              //取值范围：
  4.                              //onInitComplete（初始化分块上传成功）
  5.                              //onComplete（成功）
  6.                              //onProgress（进度）
  7.                              //onError（失败）
  8.     uploadID: '',             //字符串类型；区分分块上传事件的唯一标识，仅onInitComplete有值
  10.     partNumber: '',             //字符串类型；上传分块的标记，仅onProgress有值
  11.     progress: '',             //字符串类型；上传分块的进度，仅onProgress有值
  12.     partSize: '',             //字符串类型；上传分块的大小，仅onProgress有值
  13.     allNumber: '',             //字符串类型；总的分块数，仅onProgress有值
  14.     allSize: '',             //字符串类型；文件的总大小，仅onProgress有值
  16.     location: '',           //字符串类型；文件的访问链接，仅onComplete有值
  17.     key: '',           //字符串类型；文件在云上的名称，仅onComplete有值
  18.     etag: '',           //字符串类型；ETag (entity tag) 在每个Object生成的时候被创建，用于标示一个Object的内容。仅onComplete有值
  19. }

示例代码

  1. var bos = api.require('baiduYunBos');
  2. bos.initiateMultipartUpload({
  3.     bucket: "module-test",
  4.     objectKey: "test/test.zip",
  5.     filePath: "widget://res/test.zip"
  6. }, function(ret, err){      
  7. if( ret ){
  8.         alert( JSON.stringify( ret ) );
  9.     }else{
  10.         alert( JSON.stringify( err ) );
  11.     }
  12. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

abortMultipartUpload

取消分块上传

abortMultipartUpload({params}, callback(ret, err))

params

bucket：

  • 类型：字符串
  • 描述：文件存储桶的名称，如：module-test

objectKey：

  • 类型：字符串
  • 描述：文件存储在云上的命名，如：test/test.jpg，云会自动创建test文件夹，以便存储文件

uploadID：

  • 类型：字符串
  • 描述：分块上传的标识

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     eventType: 'onComplete',    //字符串类型；事件类型
  3.                              //取值范围：
  4.                              //onComplete（成功）
  5.                              //onError（失败）
  6. }

示例代码

  1. var bos = api.require('baiduYunBos');
  2. bos.abortMultipartUpload({
  3.     bucket: "module-test",
  4.     objectKey: "test/test.zip",
  5.     uploadID: "4bc0a2d64693f8c4ee3521953048e756"
  6. }, function(ret, err){      
  7. if( ret ){
  8.         alert( JSON.stringify( ret ) );
  9.     }else{
  10.         alert( JSON.stringify( err ) );
  11.     }
  12. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

listPartsRequest

获取已上传分块。默认情况下，如果Bucket中的分块上传事件的数目大于1000，则只会返回1000个Object

listPartsRequest({params}, callback(ret, err))

params

bucket：

  • 类型：字符串
  • 描述：文件存储桶的名称，如：module-test

objectKey：

  • 类型：字符串
  • 描述：文件存储在云上的命名，如：test/test.jpg，云会自动创建test文件夹，以便存储文件

uploadID：

  • 类型：字符串
  • 描述：分块上传的标识

maxParts：

  • 类型：数字
  • 描述：（可选项）每次获取最大分块上传事件的数目
  • 默认值： 1000

partNumberMarker：

  • 类型：数字
  • 描述：（可选项）分次读取，此次读取的开始位置；如：partNumberMarker为3，则读取位置从4开始
  • 默认值： 0

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     eventType: 'onComplete',    //字符串类型；事件类型
  3.                              //取值范围：
  4.                              //onComplete（成功）
  5.                              //onError（失败）
  6.     nextPartNumberMarker: '',             //数字类型；下次读取的起点，仅onComplete有值
  7.     isTruncated: '',             //BOOL类型；为true时，说明还有分块未获取，仅onComplete有值
  9.     partList: [             //数组类型；获取到的分块信息，仅onComplete有值
  10.         partNumber: '',
  11.         eTag: '',
  12.         lastModified: '',
  13.         size: '',
  14.         storageClass: '',   //仅ios有值
  15.     ]
  16. }

示例代码

  1. var bos = api.require('baiduYunBos');
  2. bos.listPartsRequest({
  3.     bucket: 'module-test',
  4.     objectKey: 'test/test.zip',
  5.     uploadID: '4bc0a2d64693f8c4ee3521953048e756'
  6. }, function(ret, err){      
  7. if( ret ){
  8.         alert( JSON.stringify( ret ) );
  9.     }else{
  10.         alert( JSON.stringify( err ) );
  11.     }
  12. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本