全部产品
云市场

JavaScript上传SDK

更新时间:2019-06-17 17:08:00

安装

在页面上引入下面三个JS脚本,见 视频上传SDK下载

  1. <!-- IE需要es6-promise -->
  2. <script src="../lib/es6-promise.min.js"></script>
  3. <script src="../lib/aliyun-oss-sdk5.2.0.min.js"></script>
  4. <script src="../aliyun-vod-upload-sdk1.4.0.min.js"></script>

整体步骤

  1. 请求上传地址加凭证或STS,相关概念请参见相关文档;
  2. 初始化上传实例,实例化上传有两种方式:上传地址加凭证和STS方式;
  3. 回调设置,所有的上传状态包括进度,上传成功,上传失败,凭证过期都在这里进行处理;
  4. 添加上传文件进入上传列表,目前主要支持视频文件和图片文件的上传;
  5. 启动上传;
  6. 回调处理;

请求上传地址加凭证或STS

请求上传地址加凭证

上传图片和上传视频获取上传地址和凭证所请求的API是不同的。客户端上传视频:需要请求向AppServer发送请求,AppServer通过OpenApi向阿里云点播服务发送CreateUploadVideo请求。请求成功将返回上传地址,上传凭证以及VideoId,AppServer需要将结果返回给客户端。客户端上传图片:需要请求向AppServer发送请求,AppServer通过OpenApi向阿里云点播服务发送CreateUploadImage请求。请求成功将返回上传地址,上传凭证以及ImageURL,AppServer需要将结果返回给客户端。

请求STS

通过STS方式,客户端需要向AppServer发送请求,AppServer向阿里云STS服务请求临时STS凭证。请求成功将返回STS凭证,AppServer需要将结果返回给客户端。

初始化

首先,我们需要声明一个AliyunUpload.Vod初始化回调

  1. var uploader = new AliyunUpload.Vod({
  2. //阿里账号ID,必须有值 ,值的来源https://help.aliyun.com/knowledge_detail/37196.html
  3. userId:"122"
  4. //上传到点播的地域, 默认值为'cn-shanghai',//eu-central-1,ap-southeast-1
  5. region:"",
  6. //分片大小默认1M,不能小于100K
  7. partSize: 1048576,
  8. //并行上传分片个数,默认5
  9. parallel: 5,
  10. //网络原因失败时,重新上传次数,默认为3
  11. retryCount: 3,
  12. //网络原因失败时,重新上传间隔时间,默认为2秒
  13. retryDuration: 2,
  14. // 开始上传
  15. 'onUploadstarted': function (uploadInfo) {
  16. }
  17. // 文件上传成功
  18. 'onUploadSucceed': function (uploadInfo) {
  19. },
  20. // 文件上传失败
  21. 'onUploadFailed': function (uploadInfo, code, message) {
  22. },
  23. // 文件上传进度,单位:字节
  24. 'onUploadProgress': function (uploadInfo, totalSize, loadedPercent) {
  25. },
  26. // 上传凭证超时
  27. 'onUploadTokenExpired': function (uploadInfo) {
  28. },
  29. //全部文件上传结束
  30. 'onUploadEnd':function(uploadInfo){
  31. }
  32. });

上传地址和凭证方式(推荐使用)

第一步请求获取的上传地址和凭证初始化时无需设置,而是在开始上传开始后触发的onUploadStarted回调中调用setUploadAuthAndAddress(uploadFileInfo, uploadAuth, uploadAddress,videoId);方法进行设置。当token超时,会触发onUploadTokenExpired回调,需要调用resumeUploadWithAuth(uploadAuth)方法,设置新的上传凭证继续上传。

示例代码

  1. var uploader = new AliyunUpload.Vod({
  2. //阿里账号ID,必须有值 ,值的来源https://help.aliyun.com/knowledge_detail/37196.html
  3. userId:"122"
  4. //分片大小默认1M,不能小于100K
  5. partSize: 1048576,
  6. //并行上传分片个数,默认5
  7. parallel: 5,
  8. //网络原因失败时,重新上传次数,默认为3
  9. retryCount: 3,
  10. //网络原因失败时,重新上传间隔时间,默认为2秒
  11. retryDuration: 2,
  12. // 开始上传
  13. 'onUploadstarted': function (uploadInfo) {
  14. log("onUploadStarted:" + uploadInfo.file.name + ", endpoint:" + uploadInfo.endpoint + ", bucket:" + uploadInfo.bucket + ", object:" + uploadInfo.object);
  15. //上传方式1, 需要根据uploadInfo.videoId是否有值,调用点播的不同接口获取uploadauth和uploadAddress,如果videoId有值,调用刷新视频上传凭证接口,否则调用创建视频上传凭证接口
  16. if (uploadInfo.videoId) {
  17. // 如果 uploadInfo.videoId 存在, 调用 刷新视频上传凭证接口(https://help.aliyun.com/document_detail/55408.html)
  18. }
  19. else{
  20. // 如果 uploadInfo.videoId 不存在,调用 获取视频上传地址和凭证接口(https://help.aliyun.com/document_detail/55407.html)
  21. }
  22. //从点播服务获取的uploadAuth、uploadAddress和videoId,设置到SDK里
  23. uploader.setUploadAuthAndAddress(uploadInfo, uploadAuth, uploadAddress,videoId);
  24. }
  25. // 文件上传成功
  26. 'onUploadSucceed': function (uploadInfo) {
  27. log("onUploadSucceed: " + uploadInfo.file.name + ", endpoint:" + uploadInfo.endpoint + ", bucket:" + uploadInfo.bucket + ", object:" + uploadInfo.object);
  28. },
  29. // 文件上传失败
  30. 'onUploadFailed': function (uploadInfo, code, message) {
  31. log("onUploadFailed: file:" + uploadInfo.file.name + ",code:" + code + ", message:" + message);
  32. },
  33. // 文件上传进度,单位:字节
  34. 'onUploadProgress': function (uploadInfo, totalSize, loadedPercent) {
  35. log("onUploadProgress:file:" + uploadInfo.file.name + ", fileSize:" + totalSize + ", percent:" + Math.ceil(loadedPercent * 100) + "%");
  36. },
  37. // 上传凭证超时
  38. 'onUploadTokenExpired': function (uploadInfo) {
  39. console.log("onUploadTokenExpired");
  40. //实现时,根据uploadInfo.videoId调用刷新视频上传凭证接口重新获取UploadAuth
  41. //https://help.aliyun.com/document_detail/55408.html
  42. //从点播服务刷新的uploadAuth,设置到SDK里
  43. uploader.resumeUploadWithAuth(uploadAuth);
  44. },
  45. //全部文件上传结束
  46. 'onUploadEnd':function(uploadInfo){
  47. console.log("onUploadEnd: uploaded all the files");
  48. }

STS方式

第一步请求获取的STS初始化时无需设置,而是在开始上传开始后触发的onUploadStarted回调中调用setSTSToken(uploadInfo, accessKeyId, accessKeySecret, secretToken);方法进行设置。当token超时,会触发onUploadTokenExpired回调,需要调用resumeUploadWithSTSToken(accessKeyId, accessKeySecret, secretToken)方法,设置新的Token继续上传。

  1. var uploader = new AliyunUpload.Vod({
  2. //分片大小默认1M,不能小于100K
  3. partSize: 1048576,
  4. //并行上传分片个数,默认5
  5. parallel: 5,
  6. //网络原因失败时,重新上传次数,默认为3
  7. retryCount: 3,
  8. //网络原因失败时,重新上传间隔时间,默认为2秒
  9. retryDuration: 2,
  10. // 开始上传
  11. 'onUploadstarted': function (uploadInfo) {
  12. log("onUploadStarted:" + uploadInfo.file.name + ", endpoint:" + uploadInfo.endpoint + ", bucket:" + uploadInfo.bucket + ", object:" + uploadInfo.object);
  13. //获取STS Token,设置到SDK
  14. uploader.setSTSToken(uploadInfo, accessKeyId, accessKeySecret, secretToken);
  15. }
  16. // 文件上传成功
  17. 'onUploadSucceed': function (uploadInfo) {
  18. log("onUploadSucceed: " + uploadInfo.file.name + ", endpoint:" + uploadInfo.endpoint + ", bucket:" + uploadInfo.bucket + ", object:" + uploadInfo.object);
  19. },
  20. // 文件上传失败
  21. 'onUploadFailed': function (uploadInfo, code, message) {
  22. log("onUploadFailed: file:" + uploadInfo.file.name + ",code:" + code + ", message:" + message);
  23. },
  24. // 文件上传进度,单位:字节
  25. 'onUploadProgress': function (uploadInfo, totalSize, loadedPercent) {
  26. log("onUploadProgress:file:" + uploadInfo.file.name + ", fileSize:" + totalSize + ", percent:" + Math.ceil(loadedPercent * 100) + "%");
  27. },
  28. // 上传凭证超时
  29. 'onUploadTokenExpired': function (uploadInfo) {
  30. console.log("onUploadTokenExpired");
  31. //重新获取STS token,恢复上传
  32. uploader.resumeUploadWithSTSToken(accessKeyId, accessKeySecret, secretToken);
  33. },
  34. //全部文件上传结束
  35. 'onUploadEnd':function(uploadInfo){
  36. console.log("onUploadEnd: uploaded all the files");
  37. }
  38. });

列表管理

添加上传文件

注意:支持的文件大小<=10G。

需要使用标准的input方式让用户选择文件。

  1. ``` javascript
  2. <form action="">
  3. <input type="file" name="file" id="files" multiple/>
  4. </form>
  5. userData = '';
  6. document.getElementById("files")
  7. .addEventListener('change', function (event) {
  8. for(var i=0; i<event.target.files.length; i++) {
  9. // 逻辑代码
  10. }
  11. });
  12. ```

获取到用户选择的文件后,添加到上传列表中。

  1. ``` javascript
  2. uploader.addFile(event.target.files[i], null, null, null, userData);
  3. ```

STS方式上传时,可以选择是否启用水印和优先级,userData是一个json对象字符串。第一级的Vod是必须的,Vod下面添加属性,userData支持的属性参考点播服务的createUploadVideo,接口示例如下:

  1. ``` javascript
  2. var userData = '{"Vod":{"Title":"test","CateId":"234"}"}';
  3. ```

userData只有在STS的上传方式是需要在SDK指定, 如果是上传凭证的方式,则在获取上传凭证createUploadVideo接口的参数里指定,无需在SDK里指定userData参数

删除上传文件

index,对应listFiles接口返回列表中元素的索引。

  1. ```
  2. uploader.deleteFile(index);
  3. ```

取消单个文件上传

  1. ```
  2. uploader.cancelFile(index);
  3. ```

恢复单个文件上传

  1. ```
  2. uploader.resumeFile(index);
  3. ```

获取上传文件列表

  1. ```
  2. uploader.listFiles();
  3. var list = uploader.listFiles();
  4. for (var i=0; i<list.length; i++) {
  5. log("file:" + list[i].file.name + ", status:" + list[i].state + ", endpoint:" + list[i].endpoint + ", bucket:" + list[i].bucket + ", object:" + list[i].object);
  6. }
  7. ```

清理上传文件列表

  1. ```
  2. uploader.cleanList();
  3. ```

上传控制

开始上传

  1. ```
  2. uploader.startUpload();
  3. ```

停止上传

  1. ```
  2. uploader.stopUpload();
  3. ```

上传凭证失效后恢复上传

  1. ```
  2. uploader.resumeUploadWithAuth(uploadAuth);
  3. ```

设置上传地址和上传凭证

  1. 设置上传地址和上传凭证方法在onUploadstarted回调里调用,此回调的参数包含uploadInfo的值。
  2. ```
  3. uploader.setUploadAuthAndAddress(uploadInfo,uploadAuth, uploadAddress, videoId);
  4. ```
  5. 注:获取上传凭证和上传地址,请查看[相关文档](~~52227~~)

设置STS Token

  1. 设置STS Token方法在onUploadstarted回调里调用,此回调的参数包含uploadInfo的值。
  2. ```
  3. uploader.setSTSToken(uploadInfo, accessKeyId, accessKeySecret,secretToken);
  4. ```

上传STS Token失效后恢复上传

  1. ```
  2. uploader.resumeUploadWithSTSToken(accessKeyId, accessKeySecret, secretToken, expireTime);
  3. ```

断点续传

用户在上传过程中,由于某种原因没有上传完成,在下次选择同一个文件上传时, SDK会从上次完成的位置继续上传,并且在onUploadstarted回调中,获取上传凭证, 如果使用的时上传方式1(通过uploadAuth和uploadAddress)上传时,用户需要根据回调返回的videoId的值,调用点播的不同接口, 如下:

  1. [获取上传凭证接口](~~55407~~)
  2. [刷新上传凭证接口](~~55408~~)
  3. [STS SDK参考](~~28788~~)
  4. ```
  5. onUploadstarted': function (uploadInfo) {
  6. if (上传方式1) {
  7. if(!uploadInfo.videoId)//这个文件没有上传异常
  8. {
  9. //实际环境中调用调用点播的获取上传凭证接口
  10. uploader.setUploadAuthAndAddress(uploadInfo, uploadAuth, uploadAddress,videoId);
  11. }
  12. else//如果videoId有值,根据videoId刷新上传凭证
  13. {
  14. //实际环境中调用点播的刷新上传凭证接口,获取凭证
  15. uploader.setUploadAuthAndAddress(uploadInfo, uploadAuth, uploadAddress);
  16. }
  17. }
  18. else(上传方式2)
  19. {
  20. //实际环境中调用获取STS接口,获取STS的值
  21. uploader.setSTSToken(uploadInfo, accessKeyId, accessKeySecret,secretToken);

}

  1. ```

获取断点信息

参数为file对象

  1. ```
  2. uploader.getCheckpoint(file);
  3. ```