uni-events-helper-wx
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

313 lines
13 KiB

3 years ago
  1. # request请求、配置简单、批量上传图片、视频、超强适应性(支持多域名请求)
  2. 1. 配置简单、源码清晰注释多、适用于一项目多域名请求、第三方请求、七牛云图片上传、本地服务器图片上传等等
  3. 2. 支持请求`get`、`post`、`put`、`delete`
  4. 3. 自动显示请求加载动画(可单个接口关闭)
  5. 4. 全局`api`数据处理函数,只回调请求正确的数据(可单个接口关闭)
  6. 5. 未登录或登录失效自动拦截并调用登录方法(可单个接口关闭)
  7. 6. 全局自动提示接口抛出的错误信息(可单个接口关闭)
  8. 7. 支持 Promise
  9. 8. 支持拦截器
  10. 9. 支持七牛云文件(图片、视频)批量上传
  11. 10. 支持本地服务器文件(图片、视频)批量上传
  12. 11. 支持上传文件拦截过滤
  13. 12. 支持上传文件进度监听
  14. 13. 支持上传文件单张成功回调
  15. ### 常见问题
  16. 1.接口请求成功了,没有返回数据或者数据是走的catch回调
  17. 答:`requestConfig.js` 请求配置文件里面,有一个`$http.dataFactory`方法,里面写的只是参考示例,`此方法需要开发者根据各自的接口返回类型修改`
  18. 2.官方的方法有数据,本插件方法请求报错跨域问题
  19. 答:`requestConfig.js` 请求配置文件里面,`header`请求头设置的`content-type`请求类型需求和后台保持一致
  20. 3.登录后用户`token`怎么设置?
  21. 答:`requestConfig.js` 请求配置文件里面,`$http.requestStart`请求开始拦截器里面设置
  22. 4.怎么判断上传的文件(图片)太大?怎么过滤掉太大的文件(图片)?
  23. 答:`requestConfig.js` 请求配置文件里面,`$http.requestStart`请求开始拦截器里面设置
  24. ### 本次更新注意事项
  25. 1. 所有的headers都改成了header(和官方统一)
  26. 2. 七牛云的获取token等信息提取到了`requestConfig.js`文件,参考如下
  27. ```
  28. // 添加获取七牛云token的方法
  29. $http.getQnToken = function(callback){
  30. //该地址需要开发者自行配置(每个后台的接口风格都不一样)
  31. $http.get("api/kemean/aid/qn_upload").then(data => {
  32. /*
  33. *接口返回参数:
  34. *visitPrefix:访问文件的域名
  35. *token:七牛云上传token
  36. *folderPath:上传的文件夹
  37. *region: 地区 默认为:SCN
  38. */
  39. callback({
  40. visitPrefix: data.visitPrefix,
  41. token: data.token,
  42. folderPath: data.folderPath,
  43. region: "SCN"
  44. });
  45. });
  46. }
  47. ```
  48. ### 文件说明
  49. 1. `request => core` 请求方法的目录
  50. 2. `request => core => request.js` 请求方法的class文件
  51. 3. `request => core => utils.js` 请求方法的源码文件
  52. 4. `request => upload` 上传方法的目录
  53. 5. `request => upload => upload.js` 上传方法的class文件
  54. 6. `request => upload => utils.js` 上传方法源码文件
  55. 7. `request => upload => qiniuUploader.js` 七牛云官方上传文件
  56. 8. `request => index.js` 输出方法的文件
  57. 9. `requestConfig.js` 请求配置文件(具体看代码)
  58. ### 在main.js引入并挂在Vue上
  59. ```
  60. import $http from '@/zhouWei-request/requestConfig';
  61. Vue.prototype.$http = $http;
  62. ```
  63. ### 通用请求方法
  64. ```
  65. this.$http.request({
  66. url: 'aid/region',
  67. method: "GET", // POST、GET、PUT、DELETE、JSONP,具体说明查看官方文档
  68. data: {pid:0},
  69. timeout: 30000, // 默认 30000 说明:超时时间,单位 ms,具体说明查看官方文档
  70. dataType: "json", // 默认 json 说明:如果设为 json,会尝试对返回的数据做一次 JSON.parse,具体说明查看官方文档
  71. responseType: "text", // 默认 text 说明:设置响应的数据类型。合法值:text、arraybuffer,具体说明查看官方文档
  72. withCredentials: false, // 默认 false 说明:跨域请求时是否携带凭证(cookies),具体说明查看官方文档
  73. isPrompt: true,//(默认 true 说明:本接口抛出的错误是否提示)
  74. load: true,//(默认 true 说明:本接口是否提示加载动画)
  75. header: { //默认 无 说明:请求头
  76. 'Content-Type': 'application/json'
  77. },
  78. isFactory: true, //(默认 true 说明:本接口是否调用公共的数据处理方法,设置false后isPrompt参数将失去作用)
  79. }).then(function (response) {
  80. //这里只会在接口是成功状态返回
  81. }).catch(function (error) {
  82. //这里只会在接口是失败状态返回,不需要去处理错误提示
  83. console.log(error);
  84. });
  85. ```
  86. ### get请求 正常写法
  87. ```
  88. this.$http.get('aid/region',{pid:0}).
  89. then(function (response) {
  90. //这里只会在接口是成功状态返回
  91. }).catch(function (error) {
  92. //这里只会在接口是失败状态返回,不需要去处理错误提示
  93. console.log(error);
  94. });
  95. ```
  96. ### post请求 async写法
  97. ```
  98. async request(){
  99. let data = await this.$http.post('aid/region',{pid:0});
  100. console.log(data);
  101. }
  102. ```
  103. ### 其他功能配置项
  104. ```
  105. let data = await this.$http.post(
  106. 'http://www.aaa.com/aid/region', //可以直接放链接(将不启用全局定义域名)
  107. {
  108. pid:0
  109. },
  110. {
  111. isPrompt: true,//(默认 true 说明:本接口抛出的错误是否提示)
  112. load: true,//(默认 true 说明:本接口是否提示加载动画)
  113. header: { //默认 无 说明:请求头
  114. 'Content-Type': 'application/json'
  115. },
  116. isFactory: true //(默认 true 说明:本接口是否调用公共的数据处理方法,设置false后isPrompt参数将失去作用)
  117. }
  118. );
  119. ```
  120. ### `requestConfig.js`可以设置服务器上传图片默认url
  121. ```
  122. //可以new多个request来支持多个域名请求
  123. let $http = new request({
  124. //服务器本地上传文件地址
  125. fileUrl: base.baseUrl,
  126. // 服务器上传图片默认url
  127. defaultUploadUrl: "api/common/v1/upload_image",
  128. });
  129. ```
  130. ```
  131. // 上传可以不用传递url(使用全局的上传图片url)
  132. this.$http.urlImgUpload({
  133. name:"后台接受文件key名称", //默认 file
  134. count:"最大选择数",//默认 9
  135. sizeType:"选择压缩图原图,默认两个都选",//默认 ['original', 'compressed']
  136. sourceType:"选择相机拍照或相册上传 默认两个都选",//默认 ['album','camera']
  137. data:"而外参数" //可不填,
  138. });
  139. // 上传可以不用传递url(使用全局的上传图片url)
  140. this.$http.urlVideoUpload({
  141. sourceType:"选择相机拍照或相册上传 默认两个都选",//默认 ['album','camera']
  142. compressed:"是否压缩所选的视频源文件,默认值为 true,需要压缩",//默认 false
  143. maxDuration: "拍摄视频最长拍摄时间,单位秒。最长支持 60 秒", //默认 60
  144. camera: '前置还是后置摄像头', //'front'、'back',默认'back'
  145. name:"后台接受文件key名称", //默认 file
  146. data:"而外参数" //可不填,
  147. });
  148. // 上传可以不用传递url(使用全局的上传图片url)
  149. this.$http.urlFileUpload({
  150. files: [], // 必填 临时文件路径 格式: [{path: "图片地址"}]
  151. data:"向服务器传递的参数", //可不填
  152. name:"后台接受文件key名称", //默认 file
  153. });
  154. ```
  155. ### 本地服务器图片上传(支持多张上传)
  156. ```
  157. this.$http.urlImgUpload('flie/upload',{
  158. name:"后台接受文件key名称", //默认 file
  159. count:"最大选择数",//默认 9
  160. sizeType:"选择压缩图原图,默认两个都选",//默认 ['original', 'compressed']
  161. sourceType:"选择相机拍照或相册上传 默认两个都选",//默认 ['album','camera']
  162. data:"而外参数" //可不填,
  163. isPrompt: true,//(默认 true 说明:本接口抛出的错误是否提示)
  164. load: true,//(默认 true 说明:本接口是否提示加载动画)
  165. header: { //默认 无 说明:请求头
  166. 'Content-Type': 'application/json'
  167. },
  168. isFactory: true, //(默认 true 说明:本接口是否调用公共的数据处理方法,设置false后isPrompt参数奖失去作用)
  169. maxSize: 300000, //(默认 无 说明:上传的文件最大字节数限制,默认不限制)
  170. onSelectComplete: res => {
  171. console.log("选择完成返回:",res);
  172. },
  173. onEachUpdate: res => {
  174. console.log("单张上传成功返回:",res);
  175. },
  176. onProgressUpdate: res => {
  177. console.log("上传进度返回:",res);
  178. }
  179. }).then(res => {
  180. console.log("全部上传完返回结果:",res);
  181. });
  182. ```
  183. ### 本地服务器视频上传
  184. ```
  185. this.$http.urlVideoUpload('flie/upload',{
  186. sourceType:"选择相机拍照或相册上传 默认两个都选",//默认 ['album','camera']
  187. compressed:"是否压缩所选的视频源文件,默认值为 true,需要压缩",//默认 false
  188. maxDuration: "拍摄视频最长拍摄时间,单位秒。最长支持 60 秒", //默认 60
  189. camera: '前置还是后置摄像头', //'front'、'back',默认'back'
  190. name:"后台接受文件key名称", //默认 file
  191. data:"而外参数" //可不填,
  192. isPrompt: true,//(默认 true 说明:本接口抛出的错误是否提示)
  193. load: true,//(默认 true 说明:本接口是否提示加载动画)
  194. header: { //默认 无 说明:请求头
  195. 'Content-Type': 'application/json'
  196. },
  197. isFactory: true, //(默认 true 说明:本接口是否调用公共的数据处理方法,设置false后isPrompt参数奖失去作用)
  198. maxSize: 300000, //(默认 无 说明:上传的文件最大字节数限制,默认不限制)
  199. onProgressUpdate: res => {
  200. console.log("上传进度返回:",res);
  201. },
  202. onSelectComplete: res => {
  203. console.log("选择完成返回:",res);
  204. },
  205. }).then(res => {
  206. console.log("全部上传完返回结果:",res);
  207. });
  208. ```
  209. ### 本地服务器文件上传(支持多张上传)
  210. ```
  211. this.$http.urlFileUpload("flie/upload",{
  212. files: [], // 必填 临时文件路径 格式: [{path: "图片地址"}]
  213. data:"向服务器传递的参数", //可不填
  214. name:"后台接受文件key名称", //默认 file
  215. isPrompt: true,//(默认 true 说明:本接口抛出的错误是否提示)
  216. load: true,//(默认 true 说明:本接口是否提示加载动画)
  217. header: { //默认 无 说明:请求头
  218. 'Content-Type': 'application/json'
  219. },
  220. isFactory: true, //(默认 true 说明:本接口是否调用公共的数据处理方法,设置false后isPrompt参数奖失去作用)
  221. maxSize: 300000, //(默认 无 说明:上传的文件最大字节数限制,默认不限制)
  222. onEachUpdate: res => {
  223. console.log("单张上传成功返回:",res);
  224. },
  225. onProgressUpdate: res => {
  226. console.log("上传进度返回:",res);
  227. }
  228. }).then(res => {
  229. console.log("全部上传完返回结果:",res);
  230. });
  231. ```
  232. ### 七牛云图片上传(支持多张上传)
  233. ```
  234. this.$http.qnImgUpload({
  235. count:"最大选择数", // 默认 9
  236. sizeType:"选择压缩图原图,默认两个都选", // 默认 ['original', 'compressed']
  237. sourceType:"选择相机拍照或相册上传 默认两个都选", // 默认 ['album','camera']
  238. load: true, //(默认 true 说明:本接口是否提示加载动画)
  239. maxSize: 300000, //(默认 无 说明:上传的文件最大字节数限制,默认不限制)
  240. onSelectComplete: res => {
  241. console.log("选择完成返回:",res);
  242. },
  243. onEachUpdate: res => {
  244. console.log("单张上传成功返回:",res);
  245. },
  246. onProgressUpdate: res => {
  247. console.log("上传进度返回:",res);
  248. }
  249. }).then(res => {
  250. console.log("全部上传完返回结果:",res);
  251. });
  252. ```
  253. ### 七牛云视频上传
  254. ```
  255. this.$http.qnVideoUpload({
  256. sourceType:"选择相机拍照或相册上传 默认两个都选",//默认 ['album','camera']
  257. compressed:"是否压缩所选的视频源文件,默认值为 true,需要压缩",//默认 false
  258. maxDuration: "拍摄视频最长拍摄时间,单位秒。最长支持 60 秒", //默认 60
  259. camera: '前置还是后置摄像头', //'front'、'back',默认'back'
  260. load: true,//(默认 true 说明:本接口是否提示加载动画)
  261. maxSize: 300000, //(默认 无 说明:上传的文件最大字节数限制,默认不限制)
  262. onSelectComplete: res => {
  263. console.log("选择完成返回:",res);
  264. },
  265. onProgressUpdate: res => {
  266. console.log("上传进度返回:",res);
  267. }
  268. }).then(res => {
  269. console.log("全部上传完返回结果:",res);
  270. });
  271. ```
  272. ### 七牛云文件上传(支持多张上传)
  273. ```
  274. this.$http.qnFileUpload(
  275. {
  276. files:[], // 必填 临时文件路径 格式: [{path: "图片地址"}]
  277. load: true, //(默认 true 说明:本接口是否提示加载动画)
  278. maxSize: 300000, //(默认 无 说明:上传的文件最大字节数限制,默认不限制)
  279. onEachUpdate: res => {
  280. console.log("单张上传成功返回:",res);
  281. },
  282. onProgressUpdate: res => {
  283. console.log("上传进度返回:",res);
  284. }
  285. }).then(res => {
  286. console.log("全部上传完返回结果:",res);
  287. });
  288. ```
  289. ### jsonp 跨域请求(只支持H5)
  290. ```
  291. let data = await this.$http.jsonp('http://www.aaa.com/aid/region',{pid:0}, {
  292. isFactory: false, //(默认 true 说明:本接口是否调用公共的数据处理方法,设置false后isPrompt参数奖失去作用)
  293. });
  294. ```