qiniuUploader.js 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185
  1. (function () {
  2. // 请参考demo的index.js中的initQiniu()方法,若在使用处对options进行了赋值,则此处config不需要赋默认值。init(options) 即updateConfigWithOptions(options),会对config进行赋值
  3. var config = {
  4. // bucket 所在区域。ECN, SCN, NCN, NA, ASG,分别对应七牛云的:华东,华南,华北,北美,新加坡 5 个区域
  5. qiniuRegion: '',
  6. // 七牛云bucket 外链前缀,外链在下载资源时用到
  7. qiniuBucketURLPrefix: '',
  8. // 获取uptoken方法三选一即可,执行优先级为:uptoken > uptokenURL > uptokenFunc。三选一,剩下两个置空。推荐使用uptokenURL,详情请见 README.md
  9. // 由其他程序生成七牛云uptoken,然后直接写入uptoken
  10. qiniuUploadToken: '',
  11. // 从指定 url 通过 HTTP GET 获取 uptoken,返回的格式必须是 json 且包含 uptoken 字段,例如: {"uptoken": "0MLvWPnyy..."}
  12. qiniuUploadTokenURL: '',
  13. // uptokenFunc 这个属性的值可以是一个用来生成uptoken的函数,详情请见 README.md
  14. qiniuUploadTokenFunction: function () { },
  15. // qiniuShouldUseQiniuFileName 如果是 true,则文件的 key 由 qiniu 服务器分配(全局去重)。如果是 false,则文件的 key 使用微信自动生成的 filename。出于初代sdk用户升级后兼容问题的考虑,默认是 false。
  16. // 微信自动生成的 filename较长,导致fileURL较长。推荐使用{qiniuShouldUseQiniuFileName: true} + "通过fileURL下载文件时,自定义下载名" 的组合方式。
  17. // 自定义上传key 需要两个条件:1. 此处shouldUseQiniuFileName值为false。 2. 通过修改qiniuUploader.upload方法传入的options参数,可以进行自定义key。(请不要直接在sdk中修改options参数,修改方法请见demo的index.js)
  18. // 通过fileURL下载文件时,自定义下载名,请参考:七牛云“对象存储 > 产品手册 > 下载资源 > 下载设置 > 自定义资源下载名”(https://developer.qiniu.com/kodo/manual/1659/download-setting)。本sdk在README.md的"常见问题"板块中,有"通过fileURL下载文件时,自定义下载名"使用样例。
  19. qiniuShouldUseQiniuFileName: false
  20. }
  21. // init(options) 将七牛云相关配置初始化进本sdk
  22. // 在整个程序生命周期中,只需要 init(options); 一次即可
  23. // 如果需要变更七牛云配置,再次调用 init(options); 即可
  24. function init(options) {
  25. updateConfigWithOptions(options);
  26. }
  27. // 更新七牛云配置
  28. function updateConfigWithOptions(options) {
  29. if (options.region) {
  30. config.qiniuRegion = options.region;
  31. } else {
  32. console.error('qiniu uploader need your bucket region');
  33. }
  34. if (options.uptoken) {
  35. config.qiniuUploadToken = options.uptoken;
  36. } else if (options.uptokenURL) {
  37. config.qiniuUploadTokenURL = options.uptokenURL;
  38. } else if (options.uptokenFunc) {
  39. config.qiniuUploadTokenFunction = options.uptokenFunc;
  40. }
  41. if (options.domain) {
  42. config.qiniuBucketURLPrefix = options.domain;
  43. }
  44. config.qiniuShouldUseQiniuFileName = options.shouldUseQiniuFileName
  45. }
  46. // 正式上传的前置方法,做预处理,应用七牛云配置
  47. function upload(filePath, success, fail, options, progress, cancelTask) {
  48. if (null == filePath) {
  49. console.error('qiniu uploader need filePath to upload');
  50. return;
  51. }
  52. if (options) {
  53. updateConfigWithOptions(options);
  54. }
  55. if (config.qiniuUploadToken) {
  56. doUpload(filePath, success, fail, options, progress, cancelTask);
  57. } else if (config.qiniuUploadTokenURL) {
  58. getQiniuToken(function () {
  59. doUpload(filePath, success, fail, options, progress, cancelTask);
  60. });
  61. } else if (config.qiniuUploadTokenFunction) {
  62. config.qiniuUploadToken = config.qiniuUploadTokenFunction();
  63. if (null == config.qiniuUploadToken && config.qiniuUploadToken.length > 0) {
  64. console.error('qiniu UploadTokenFunction result is null, please check the return value');
  65. return
  66. }
  67. doUpload(filePath, success, fail, options, progress, cancelTask);
  68. } else {
  69. console.error('qiniu uploader need one of [uptoken, uptokenURL, uptokenFunc]');
  70. return;
  71. }
  72. }
  73. // 正式上传
  74. function doUpload(filePath, success, fail, options, progress, cancelTask) {
  75. if (null == config.qiniuUploadToken && config.qiniuUploadToken.length > 0) {
  76. console.error('qiniu UploadToken is null, please check the init config or networking');
  77. return
  78. }
  79. var url = uploadURLFromRegionCode(config.qiniuRegion);
  80. var fileName = filePath.split('//')[1];
  81. // 自定义上传key(即自定义上传文件名)。通过修改qiniuUploader.upload方法传入的options参数,可以进行自定义文件名称。如果options非空,则使用options中的key作为fileName
  82. if (options && options.key) {
  83. fileName = options.key;
  84. }
  85. var formData = {
  86. 'token': config.qiniuUploadToken
  87. };
  88. // qiniuShouldUseQiniuFileName 如果是 true,则文件的 key 由 qiniu 服务器分配(全局去重)。如果是 false,则文件的 key 使用微信自动生成的 filename。出于初代sdk用户升级后兼容问题的考虑,默认是 false。
  89. if (!config.qiniuShouldUseQiniuFileName) {
  90. formData['key'] = fileName
  91. }
  92. var uploadTask = wx.uploadFile({
  93. url: url,
  94. filePath: filePath,
  95. name: 'file',
  96. formData: formData,
  97. success: function (res) {
  98. var dataString = res.data
  99. // // this if case is a compatibility with wechat server returned a charcode, but was fixed
  100. // if(res.data.hasOwnProperty('type') && res.data.type === 'Buffer'){
  101. // dataString = String.fromCharCode.apply(null, res.data.data)
  102. // }
  103. try {
  104. var dataObject = JSON.parse(dataString);
  105. // 拼接fileURL
  106. var fileURL = config.qiniuBucketURLPrefix + '/' + dataObject.key;
  107. dataObject.fileURL = fileURL;
  108. // imageURL字段和fileURL字段重复,但本sdk不做删除,因为在最初版本使用的是imageURL。直接删除可能导致原有用户升级至新版sdk后出现异常。
  109. dataObject.imageURL = fileURL;
  110. console.log(dataObject);
  111. if (success) {
  112. success(dataObject);
  113. }
  114. } catch (e) {
  115. console.log('parse JSON failed, origin String is: ' + dataString)
  116. if (fail) {
  117. fail(e);
  118. }
  119. }
  120. },
  121. fail: function (error) {
  122. console.error(error);
  123. if (fail) {
  124. fail(error);
  125. }
  126. }
  127. })
  128. // 文件上传进度
  129. uploadTask.onProgressUpdate((res) => {
  130. progress && progress(res)
  131. })
  132. // 中断文件上传
  133. cancelTask && cancelTask(() => {
  134. uploadTask.abort()
  135. })
  136. }
  137. // 获取七牛云uptoken, url为后端服务器获取七牛云uptoken接口
  138. function getQiniuToken(callback) {
  139. wx.request({
  140. url: config.qiniuUploadTokenURL,
  141. success: function (res) {
  142. var token = res.data.uptoken;
  143. if (token && token.length > 0) {
  144. config.qiniuUploadToken = token;
  145. if (callback) {
  146. callback();
  147. }
  148. } else {
  149. console.error('qiniuUploader cannot get your token, please check the uptokenURL or server')
  150. }
  151. },
  152. fail: function (error) {
  153. console.error('qiniu UploadToken is null, please check the init config or networking: ' + error);
  154. }
  155. })
  156. }
  157. // 选择七牛云文件上传接口,文件向匹配的接口中传输。ECN, SCN, NCN, NA, ASG,分别对应七牛云的:华东,华南,华北,北美,新加坡 5 个区域
  158. function uploadURLFromRegionCode(code) {
  159. var uploadURL = null;
  160. switch (code) {
  161. case 'ECN': uploadURL = 'https://up.qiniup.com'; break;
  162. case 'NCN': uploadURL = 'https://up-z1.qiniup.com'; break;
  163. case 'SCN': uploadURL = 'https://up-z2.qiniup.com'; break;
  164. case 'NA': uploadURL = 'https://up-na0.qiniup.com'; break;
  165. case 'ASG': uploadURL = 'https://up-as0.qiniup.com'; break;
  166. default: console.error('please make the region is with one of [ECN, SCN, NCN, NA, ASG]');
  167. }
  168. return uploadURL;
  169. }
  170. module.exports = {
  171. init: init,
  172. upload: upload,
  173. }
  174. })();