request-shop.js 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442
  1. /**
  2. * Request 1.0.6
  3. * @Class Request
  4. * @description luch-request 1.0.6 http请求插件
  5. * @Author lu-ch
  6. * @Date 2020-03-17
  7. * @Email webwork.s@qq.com
  8. * http://ext.dcloud.net.cn/plugin?id=392
  9. */
  10. export default class Request {
  11. config = {
  12. baseUrl: '',
  13. header: {
  14. 'content-type': 'application/json'
  15. },
  16. method: 'GET',
  17. dataType: 'json',
  18. // #ifndef MP-ALIPAY || APP-PLUS
  19. responseType: 'text',
  20. // #endif
  21. custom: {},
  22. // #ifdef MP-ALIPAY
  23. timeout: 30000,
  24. // #endif
  25. // #ifdef APP-PLUS
  26. sslVerify: true
  27. // #endif
  28. };
  29. static posUrl(url) {
  30. /* 判断url是否为绝对路径 */
  31. return /(http|https):\/\/([\w.]+\/?)\S*/.test(url);
  32. }
  33. static mergeUrl(url, baseUrl, params) {
  34. let mergeUrl = Request.posUrl(url) ? url : `${baseUrl}${url}`;
  35. if (Object.keys(params).length !== 0) {
  36. const paramsH = Request.addQueryString(params);
  37. mergeUrl += mergeUrl.includes('?') ? `&${paramsH}` : `?${paramsH}`;
  38. }
  39. return mergeUrl;
  40. }
  41. static addQueryString(params) {
  42. let paramsData = '';
  43. Object.keys(params).forEach(function(key) {
  44. paramsData += key + '=' + encodeURIComponent(params[key]) + '&';
  45. });
  46. return paramsData.substring(0, paramsData.length - 1);
  47. }
  48. /**
  49. * @property {Function} request 请求拦截器
  50. * @property {Function} response 响应拦截器
  51. * @type {{request: Request.interceptor.request, response: Request.interceptor.response}}
  52. */
  53. interceptor = {
  54. /**
  55. * @param {Request~requestCallback} cb - 请求之前拦截,接收一个函数(config, cancel)=> {return config}。第一个参数为全局config,第二个参数为函数,调用则取消本次请求。
  56. */
  57. request: cb => {
  58. if (cb) {
  59. this.requestBeforeFun = cb;
  60. }
  61. },
  62. /**
  63. * @param {Request~responseCallback} cb 响应拦截器,对响应数据做点什么
  64. * @param {Request~responseErrCallback} ecb 响应拦截器,对响应错误做点什么
  65. */
  66. response: (cb, ecb) => {
  67. if (cb) {
  68. this.requestComFun = cb;
  69. }
  70. if (ecb) {
  71. this.requestComFail = ecb;
  72. }
  73. }
  74. };
  75. requestBeforeFun(config) {
  76. return config;
  77. }
  78. requestComFun(response) {
  79. return response;
  80. }
  81. requestComFail(response) {
  82. return response;
  83. }
  84. /**
  85. * 自定义验证器,如果返回true 则进入响应拦截器的响应成功函数(resolve),否则进入响应拦截器的响应错误函数(reject)
  86. * @param { Number } statusCode - 请求响应体statusCode(只读)
  87. * @return { Boolean } 如果为true,则 resolve, 否则 reject
  88. */
  89. validateStatus(statusCode) {
  90. return statusCode === 200;
  91. }
  92. /**
  93. * @Function
  94. * @param {Request~setConfigCallback} f - 设置全局默认配置
  95. */
  96. setConfig(f) {
  97. this.config = f(this.config);
  98. }
  99. /**
  100. * @Function
  101. * @param {Object} options - 请求配置项
  102. * @prop {String} options.url - 请求路径
  103. * @prop {Object} options.data - 请求参数
  104. * @prop {Object} [options.responseType = config.responseType] [text|arraybuffer] - 响应的数据类型
  105. * @prop {Object} [options.dataType = config.dataType] - 如果设为 json,会尝试对返回的数据做一次 JSON.parse
  106. * @prop {Object} [options.header = config.header] - 请求header
  107. * @prop {Object} [options.method = config.method] - 请求方法
  108. * @returns {Promise<unknown>}
  109. */
  110. async request(options = {}) {
  111. options.baseUrl = this.config.baseUrl;
  112. options.dataType = options.dataType || this.config.dataType;
  113. // #ifndef MP-ALIPAY || APP-PLUS
  114. options.responseType = options.responseType || this.config.responseType;
  115. // #endif
  116. // #ifdef MP-ALIPAY
  117. options.timeout = options.timeout || this.config.timeout;
  118. // #endif
  119. options.url = options.url || '';
  120. options.data = options.data || {};
  121. options.params = options.params || {};
  122. options.header = options.header || this.config.header;
  123. options.method = options.method || this.config.method;
  124. options.custom = { ...this.config.custom, ...(options.custom || {}) };
  125. // #ifdef APP-PLUS
  126. options.sslVerify =
  127. options.sslVerify === undefined
  128. ? this.config.sslVerify
  129. : options.sslVerify;
  130. // #endif
  131. options.getTask = options.getTask || this.config.getTask;
  132. return new Promise((resolve, reject) => {
  133. let next = true;
  134. const cancel = (t = 'handle cancel', config = options) => {
  135. const err = {
  136. errMsg: t,
  137. config: config
  138. };
  139. reject(err);
  140. next = false;
  141. };
  142. const handleRe = { ...this.requestBeforeFun(options, cancel) };
  143. const _config = { ...handleRe };
  144. if (!next) return;
  145. const requestTask = uni.request({
  146. url: Request.mergeUrl(_config.url, _config.baseUrl, _config.params),
  147. data: _config.data,
  148. header: _config.header,
  149. method: _config.method,
  150. // #ifdef MP-ALIPAY
  151. timeout: _config.timeout,
  152. // #endif
  153. dataType: _config.dataType,
  154. // #ifndef MP-ALIPAY || APP-PLUS
  155. responseType: _config.responseType,
  156. // #endif
  157. // #ifdef APP-PLUS
  158. sslVerify: _config.sslVerify,
  159. // #endif
  160. complete: response => {
  161. response.config = handleRe;
  162. if (this.validateStatus(response.statusCode)) {
  163. // 成功
  164. response = this.requestComFun(response);
  165. resolve(response);
  166. } else {
  167. response = this.requestComFail(response);
  168. reject(response);
  169. }
  170. }
  171. });
  172. if (handleRe.getTask) {
  173. handleRe.getTask(requestTask, handleRe);
  174. }
  175. });
  176. }
  177. get(url, params = {},isToken) {
  178. return this.request({
  179. url,
  180. method: 'GET',
  181. params,
  182. isToken
  183. });
  184. }
  185. post(url, data, options = {},isToken) {
  186. return this.request({
  187. url,
  188. data,
  189. method: 'POST',
  190. ...options,
  191. isToken
  192. });
  193. }
  194. // #ifndef MP-ALIPAY
  195. put(url, data, options = {},isToken) {
  196. return this.request({
  197. url,
  198. data,
  199. method: 'PUT',
  200. ...options,
  201. isToken
  202. });
  203. }
  204. // #endif
  205. // #ifdef APP-PLUS || H5 || MP-WEIXIN || MP-BAIDU
  206. delete(url, data, options = {},isToken) {
  207. return this.request({
  208. url,
  209. data,
  210. method: 'DELETE',
  211. ...options,
  212. isToken
  213. });
  214. }
  215. // #endif
  216. // #ifdef APP-PLUS || H5 || MP-WEIXIN
  217. connect(url, data, options = {}) {
  218. return this.request({
  219. url,
  220. data,
  221. method: 'CONNECT',
  222. ...options
  223. });
  224. }
  225. // #endif
  226. // #ifdef APP-PLUS || H5 || MP-WEIXIN || MP-BAIDU
  227. head(url, data, options = {}) {
  228. return this.request({
  229. url,
  230. data,
  231. method: 'HEAD',
  232. ...options
  233. });
  234. }
  235. // #endif
  236. // #ifdef APP-PLUS || H5 || MP-WEIXIN || MP-BAIDU
  237. options(url, data, options = {}) {
  238. return this.request({
  239. url,
  240. data,
  241. method: 'OPTIONS',
  242. ...options
  243. });
  244. }
  245. // #endif
  246. // #ifdef APP-PLUS || H5 || MP-WEIXIN
  247. trace(url, data, options = {}) {
  248. return this.request({
  249. url,
  250. data,
  251. method: 'TRACE',
  252. ...options
  253. });
  254. }
  255. // #endif
  256. upload(
  257. url,
  258. {
  259. // #ifdef APP-PLUS
  260. files,
  261. // #endif
  262. // #ifdef MP-ALIPAY
  263. fileType,
  264. // #endif
  265. filePath,
  266. name,
  267. header,
  268. formData = {},
  269. custom = {},
  270. params = {},
  271. getTask
  272. }
  273. ) {
  274. return new Promise((resolve, reject) => {
  275. let next = true;
  276. const globalHeader = { ...this.config.header };
  277. delete globalHeader['content-type'];
  278. delete globalHeader['Content-Type'];
  279. const pubConfig = {
  280. baseUrl: this.config.baseUrl,
  281. url,
  282. // #ifdef MP-ALIPAY
  283. fileType,
  284. // #endif
  285. filePath,
  286. method: 'UPLOAD',
  287. name,
  288. header: header || globalHeader,
  289. formData,
  290. params,
  291. custom: { ...this.config.custom, ...custom },
  292. getTask: getTask || this.config.getTask
  293. };
  294. // #ifdef APP-PLUS
  295. if (files) {
  296. pubConfig.files = files;
  297. }
  298. // #endif
  299. const cancel = (t = 'handle cancel', config = pubConfig) => {
  300. const err = {
  301. errMsg: t,
  302. config: config
  303. };
  304. reject(err);
  305. next = false;
  306. };
  307. const handleRe = { ...this.requestBeforeFun(pubConfig, cancel) };
  308. const _config = {
  309. url: Request.mergeUrl(handleRe.url, handleRe.baseUrl, handleRe.params),
  310. // #ifdef MP-ALIPAY
  311. fileType: handleRe.fileType,
  312. // #endif
  313. filePath: handleRe.filePath,
  314. name: handleRe.name,
  315. header: handleRe.header,
  316. formData: handleRe.formData,
  317. complete: response => {
  318. response.config = handleRe;
  319. if (typeof response.data === 'string') {
  320. response.data = JSON.parse(response.data);
  321. }
  322. if (this.validateStatus(response.statusCode)) {
  323. // 成功
  324. response = this.requestComFun(response);
  325. resolve(response);
  326. } else {
  327. response = this.requestComFail(response);
  328. reject(response);
  329. }
  330. }
  331. };
  332. // #ifdef APP-PLUS
  333. if (handleRe.files) {
  334. _config.files = handleRe.files;
  335. }
  336. // #endif
  337. if (!next) return;
  338. const requestTask = uni.uploadFile(_config);
  339. if (handleRe.getTask) {
  340. handleRe.getTask(requestTask, handleRe);
  341. }
  342. });
  343. }
  344. download(url, options = {}) {
  345. return new Promise((resolve, reject) => {
  346. let next = true;
  347. const pubConfig = {
  348. baseUrl: this.config.baseUrl,
  349. url,
  350. method: 'DOWNLOAD',
  351. header: options.header || this.config.header,
  352. params: options.params || {},
  353. custom: { ...this.config.custom, ...(options.custom || {}) },
  354. getTask: options.getTask || this.config.getTask
  355. };
  356. const cancel = (t = 'handle cancel', config = pubConfig) => {
  357. const err = {
  358. errMsg: t,
  359. config: config
  360. };
  361. reject(err);
  362. next = false;
  363. };
  364. const handleRe = { ...this.requestBeforeFun(pubConfig, cancel) };
  365. if (!next) return;
  366. const requestTask = uni.downloadFile({
  367. url: Request.mergeUrl(handleRe.url, handleRe.baseUrl, handleRe.params),
  368. header: handleRe.header,
  369. complete: response => {
  370. response.config = handleRe;
  371. if (this.validateStatus(response.statusCode)) {
  372. // 成功
  373. response = this.requestComFun(response);
  374. resolve(response);
  375. } else {
  376. response = this.requestComFail(response);
  377. reject(response);
  378. }
  379. }
  380. });
  381. if (handleRe.getTask) {
  382. handleRe.getTask(requestTask, handleRe);
  383. }
  384. });
  385. }
  386. }
  387. /**
  388. * setConfig回调
  389. * @return {Object} - 返回操作后的config
  390. * @callback Request~setConfigCallback
  391. * @param {Object} config - 全局默认config
  392. */
  393. /**
  394. * 请求拦截器回调
  395. * @return {Object} - 返回操作后的config
  396. * @callback Request~requestCallback
  397. * @param {Object} config - 全局config
  398. * @param {Function} [cancel] - 取消请求钩子,调用会取消本次请求
  399. */
  400. /**
  401. * 响应拦截器回调
  402. * @return {Object} - 返回操作后的response
  403. * @callback Request~responseCallback
  404. * @param {Object} response - 请求结果 response
  405. */
  406. /**
  407. * 响应错误拦截器回调
  408. * @return {Object} - 返回操作后的response
  409. * @callback Request~responseErrCallback
  410. * @param {Object} response - 请求结果 response
  411. */