JS-SDK

文档简介

NOS JS SDK是用于浏览器端上传文件到nos的软件开发工具包,提供简单、便捷的方法,方便用户实现文件上传功能。在使用JS SDK 前必须要开通NOS服务,并需要拥有一个有效的Access Key(包括Access Key和Access Secret)用来生成上传凭证。可以通过如下步骤获得:

  • 登录 https://c.163.com 注册用户。
  • 注册后,网易云会颁发 Access Key 和 Secret Key 给客户,您可以在网易云“用户中心”的“Access Key”查看并管理您的Access Key。

SDK地址

GitHub地址: nos-js-sdk

上传凭证

使用js sdk上传需要提供上传凭证,用来表明用户有权限对桶进行上传。

本地生成

用户可以将生成上传凭证的逻辑集成到本地,在本地存入Access Key(包括Access Key和Access Secret)。该方法风险较大,因为需要将Key存到客户端,因此很容易泄漏,安全性很低,不推荐使用。

业务服务器生成

用户可以将上传凭证的生成逻辑放到业务服务器,客户端在上传前需要去业务服务器获取上传凭证然后进行上传。上传凭证的生成方法参考 上传凭证

支持功能

JS SDK主要实现了以下几种功能:

  • 客户端直传:客户端可以将数据直接上传到NOS,不用经过业务方上传服务器
  • 断点续传:上传中断后,可以断点续传,节省用户流量
  • 全国加速节点:遍布全国加速节点,自动选择最优的加速节点
  • 中断上传:用户可以取消或暂停上传

使用方法

引入依赖

下载最新的SDK源码文件,NOS JS SDK依赖jquery和crypto-js加密库,因此需提前引入js文件:

初始化上传对象

配置参数

新建一个对象,配置所需参数:

var opt = { fileInputID: onError: , onProgress: , }

Attention

若无需求,可不配置该参数。

配置项说明

fileInputID

说明

关联文件选择输入框ID, 默认为fileInput,若另指定,则必须配置该参数。

onError

说明

错误处理函数

参数

名称类型是否必需描述
errObjObject带errCode和errMsg或只带errMsg的Object对象或XHR错误对象

返回值

onProgress

说明

上传进度回调处理函数

参数

名称类型是否必需描述
curFileObject当前正在上传的文件对象

返回值

初始化

将配置参数传入Uploader,通过以下调用进行事件的绑定和相关初始化操作


        var uploader = Uploader(opt);


文件上传

添加文件

选择上传的文件时,需要调用SDK中的addFile方法添加文件,该方法为选择的文件封装一个新的文件对象。

var fileInput = document.getElementById('fileInput');
fileInput.on('change', function(e) {
if (e.target.files) {
uploader.addFile(e.target.files[0]);
}
});

Attention

一次只能添加一个文件。

addFile封装的文件对象说明:

名称类型描述
fileKeyString文件名与文件大小的MD5值
fileFile文件对象
fileNameString文件名
statusNumber文件状态( 0 未上传 1 正在上传 2 已上传)
progressNumber上传进度(保留两位小数的百分比)

调用上传接口

新建一个对象,配置上传文件所需参数:

var param = { bucketName: , objectName: , token: , trunkSize: , }

参数

名称类型是否必需描述
bucketNameString上传文件所需桶名
objectNameString为上传的文件指定的对象名
tokenString上传凭证
trunkSizelong分片大小, 默认128 * 1024,单位:字节

通过Uploader的实例对象调用上传接口upload方法完成上传。

<script type="text/javascript">
uploader.upload(param);
</script>

中断上传

通过Uploader的实例对象调用pauseUpload方法中断上传。

<script type="text/javascript">
uploader.pauseUpload();
</script>

断点续传

当文件上传中断后,用户只需重新选择文件提交即可恢复上传, 但要注意的是objectname,bucketname要与之前相同。

上传文件简单示例

<!DOCTYPE html>
<html>
<head>
<title>NOS SDK for JavaScript - Sample Application</title>
<script type="text/javascript" src="https://code.jquery.com/jquery-1.11.3.js"></script>
<script type="text/javascript" src="js/crypto-js.js"></script>
<script type="text/javascript" src="js/nos-js-sdk.js"></script>
</head>

<body>

<input type="file" id="fileInput" />
<button id="fileUploadBtn">上传</button>

<script type="text/javascript">
var uploader = Uploader();

$('#fileInput').on('change', function(e) {
if (e.target.files) {
uploader.addFile(e.target.files[0]);
}
});

$('#fileUploadBtn').on('click', function(){
var param = {
bucketName: 'your bucket name',
objectName: 'you object name',
token: 'upload token',
trunkSize: 'size of trunk',
}

uploader.upload(param);
});
</script>

</body>
</html>

Attention

有关JS SDK详细接口实现请看SDK代码注释。 JS 直传目前只对外提供 http 协议的 SDK,需要 https SDK 可工单联系我们。