UCloud US3 JavaScript SDK

JavaScript SDK for UCloud US3 (原名UFile 对象存储服务)

目录

§ 说明

§ 安装

§ 示例

§ API列表

» 获取文件列表（getFileList）

» 查询文件信息（getFileDetail）

» 下载文件（downloadFile）

» 删除文件（deleteFile）

» 批量删除（batchDelete）

» 普通上传（uploadFile）

» 表单上传（formUpload）

» 分片上传（sliceUpload）

» 批量上传（batchUpload）

§ 说明

 US3 JsSDK 主要用来从页面上传、下载、列表、删除文件。
 SDK需要配合服务端 token_server.php 结合使用。先配置好环境，安装web服务器和解析php的服务。  
 部署SDK到服务器，配置好[安装](#install)中指定的4个参数，访问服务器地址，即可操作[示例](#examples)中的功能。
 V2的示例支持SDK内部签名计算、服务端签名计算和上传回调。V1不再维护，以V2为准。

 上传文件大致使用流程：
 1、参考V2/demo
 2、需要一个后端服务器，提供 token 生成的功能，类似 token_server.php; 在上传文件时，需要调用这个 php，实现 签名的生成；参考：https://github.com/ufilesdk-dev/ufile-sdk-auth-server
 3、调用方法，具体参考 v2/demo 的代码。
 4、具体流程： 
      a、js 初始化一个 UCloudUfile 对象，传入bucket 的参数，和 token server .php 的地址
      b、token_server.php ， 部署在用户自己的服务器上，主要是用来生成签名。
         里面需要用户填入公私钥信息， 需要修改代码，按自己业务需求，对请求做自己业务的鉴权校验；
         放在服务器的目的，主要是防止公私钥泄露，又能提供上传的签名服务。
      c、js 调用 uploadFile 接口完成上传文件（uploadFile  里面，会去请求 token_server.php, 然后把数据传到 ucloud 的服务器）

注：在较高版本 chrome 中，chrome 会默认阻止非 https 内网请求，现象为请求发送不出去，控制台出现 `net::ERR_FAILED` 错误，这种情况下需要修改浏览器参数 block-insecure-private-network-requests 为 Disabled，允许浏览器发送非 https 内网请求。

§ 安装

SDK需要浏览器支持HTML5。
将src目录中的spark-md5-3.0.0.min.js和ufile.js引入到您的项目中，如下所示。

<script type="text/javascript" src="sdk/spark-md5-3.0.0.min.js"></script>
<script type="text/javascript" src="sdk/ufile.js"></script>

配置bucketName和bucketUrl。
既可以在实例化时传参设置，也可以在src目录的ufile.js中全局设置。

配置UCLOUD_PUBLIC_KEY和UCLOUD_PRIVATE_KEY。
在token_server.php中设置。
在UCloud控制台中可以查看您的API密钥的public_key和private_key。

如果浏览器控制台出现类似下面所示的错误提示：

XMLHttpRequest cannot load https://example-name.cn-bj.ufileos.com/?list&prefix=&marker=&limit=20. 
Response to preflight request doesn't pass access control check: 
The 'Access-Control-Allow-Origin' header contains the invalid value 'null'.
Origin 'http://localhost:8081' is therefore not allowed access.

则说明你的bucket地址（https://example-name.cn-bj.ufileos.com/）没有跨域设置，需要提交工单。

§ 示例

• 获取文件列表
• 查询文件信息
• 下载文件
• 删除文件
• 批量删除
• 普通上传
• 表单上传
• 分片上传
• 批量上传

参见SDK中examples目录中的示例。
目录中的jQuery和Bootstrap不是必须引入，只是为了方便演示。

§ API

» 获取文件列表（getFileList）

接口功能

获取Bucket的文件列表

请求参数

返回参数

DataSet

调用示例

ufile.getFileList(successCallBack, errorCallBack);

» 查看文件信息（getFileDetail）

接口功能

查询文件基本信息

请求参数

返回参数

调用示例

ufile.getFileDetail(fileName, successCallBack, errorCallBack);

» 下载文件（downloadFile）

接口功能

下载文件

请求参数

success返回

response

progress返回

调用示例

ufile.downloadFile(fileName, successCallBack, errorCallBack, progressCallBack);

» 删除文件（deleteFile）

接口功能

删除文件

请求参数

调用示例

ufile.deleteFile(fileName, successCallBack, errorCallBack);

» 批量删除（batchDelete）

接口功能

批量删除

请求参数

调用示例

ufile.batchDelete(fileList, successCallBack, errorCallBack);

» 普通上传（uploadFile）

接口功能

普通上传文件

请求参数

data

progress返回

调用示例

ufile.uploadFile(data, successCallBack, errorCallBack, progressCallBack);

» 表单上传（formUpload）

接口功能

说明：适合使用浏览器的场景并且上传文件内容可以在一次HTTP请求完成，并且所有PUT上传支持的参数都可以在表单上传中指定。

请求参数

data

调用示例

ufile.formUpload(data, successCallBack, errorCallBack);

» 分片上传（sliceUpload）

接口功能

说明：适合大文件上传

请求参数

data

success返回

progress返回

调用示例

ufile.sliceUpload(data, successCallBack, errorCallBack, progressCallBack);

» 批量上传（batchUpload）

接口功能

批量上传文件

请求参数

progress返回

调用示例

ufile.batchUpload(fileList, successCallBack, errorCallBack, progressCallBack);

许可证

Apache License 2.0