request.js 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313
  1. /**
  2. * Shopro-request
  3. * @description api模块管理,loading配置,请求拦截,错误处理
  4. */
  5. import Request from 'luch-request';
  6. import { refreshToken } from '@/api/common';
  7. import { userStore } from '@/store/user'
  8. const baseUrl = 'http://menduner.citupro.com:7878'
  9. // const baseUrl = 'https://menduner.citupro.com:2443'
  10. const options = {
  11. // 显示操作成功消息 默认不显示
  12. showSuccess: false,
  13. // 成功提醒 默认使用后端返回值
  14. successMsg: '',
  15. // 显示失败消息 默认显示
  16. showError: true,
  17. // 失败提醒 默认使用后端返回信息
  18. errorMsg: '',
  19. // 显示请求时loading模态框 默认显示
  20. showLoading: true,
  21. // loading提醒文字
  22. loadingMsg: '加载中',
  23. // 需要授权才能请求 默认放开
  24. auth: false,
  25. // ...
  26. };
  27. // Loading全局实例
  28. let LoadingInstance = {
  29. target: null,
  30. count: 0,
  31. };
  32. /**
  33. * 关闭loading
  34. */
  35. function closeLoading() {
  36. if (LoadingInstance.count > 0) LoadingInstance.count--;
  37. if (LoadingInstance.count === 0) uni.hideLoading();
  38. }
  39. /**
  40. * @description 请求基础配置 可直接使用访问自定义请求
  41. */
  42. const http = new Request({
  43. baseURL: baseUrl + '/app-api',
  44. timeout: 8000,
  45. method: 'GET',
  46. header: {
  47. Accept: 'text/json',
  48. 'Content-Type': 'application/json;charset=UTF-8',
  49. platform: 'WechatMiniProgram',
  50. },
  51. // #ifdef APP-PLUS
  52. sslVerify: false,
  53. // #endif
  54. // #ifdef H5
  55. // 跨域请求时是否携带凭证(cookies)仅H5支持(HBuilderX 2.6.15+)
  56. withCredentials: false,
  57. // #endif
  58. custom: options,
  59. });
  60. /**
  61. * @description 请求拦截器
  62. */
  63. http.interceptors.request.use(
  64. (config) => {
  65. const useUserStore = userStore()
  66. // 自定义处理【auth 授权】:必须登录的接口,则跳出 AuthModal 登录弹窗
  67. if (config.custom.auth && !useUserStore.isLogin) {
  68. uni.showToast({
  69. title:'请先登录',
  70. icon: 'none'
  71. })
  72. uni.navigateTo({
  73. url: '/pages/login/index'
  74. })
  75. return Promise.reject();
  76. }
  77. // 自定义处理【loading 加载中】:如果需要显示 loading,则显示 loading
  78. if (config.custom.showLoading) {
  79. LoadingInstance.count++;
  80. LoadingInstance.count === 1 &&
  81. uni.showLoading({
  82. title: config.custom.loadingMsg,
  83. mask: true,
  84. fail: () => {
  85. uni.hideLoading();
  86. },
  87. });
  88. }
  89. // 增加 token 令牌、terminal 终端、tenant 租户的请求头
  90. const token = getAccessToken();
  91. if (token) {
  92. config.header['Authorization'] = 'Bearer ' + token;
  93. }
  94. config.header['terminal'] = 'mp-weixin'
  95. config.header['Accept-Language'] = 'zh_CN'
  96. config.header['Accept'] = '*/*';
  97. config.header['tenant-id'] = '155';
  98. return config;
  99. },
  100. (error) => {
  101. return Promise.reject(error);
  102. },
  103. );
  104. /**
  105. * @description 响应拦截器
  106. */
  107. http.interceptors.response.use(
  108. (response) => {
  109. // 约定:如果是 /auth/ 下的 URL 地址,并且返回了 accessToken 说明是登录相关的接口,则自动设置登陆令牌
  110. if (response.config.url.indexOf('/system/auth/') >= 0 && response.data?.data?.accessToken) {
  111. const useUserStore = userStore()
  112. useUserStore.setToken(response.data.data.accessToken, response.data.data.refreshToken);
  113. }
  114. // 自定处理【loading 加载中】:如果需要显示 loading,则关闭 loading
  115. response.config.custom.showLoading && closeLoading();
  116. // 自定义处理【error 错误提示】:如果需要显示错误提示,则显示错误提示
  117. if (response.data.code !== 0) {
  118. // 特殊:如果 401 错误码,则跳转到登录页 or 刷新令牌
  119. if (response.data.code === 401) {
  120. return handleRefreshToken(response.config);
  121. }
  122. // 错误提示
  123. if (response.config.custom.showError) {
  124. uni.showToast({
  125. title: response.data.msg || '服务器开小差啦,请稍后再试~',
  126. icon: 'none',
  127. mask: true,
  128. });
  129. }
  130. }
  131. // 自定义处理【showSuccess 成功提示】:如果需要显示成功提示,则显示成功提示
  132. if (response.config.custom.showSuccess
  133. && response.config.custom.successMsg !== ''
  134. && response.data.code === 0) {
  135. uni.showToast({
  136. title: response.config.custom.successMsg,
  137. icon: 'none',
  138. });
  139. }
  140. // 返回结果:包括 code + data + msg
  141. return Promise.resolve(response.data);
  142. },
  143. (error) => {
  144. const useUserStore = userStore()
  145. const isLogin = useUserStore.isLogin;
  146. let errorMessage = '网络请求出错';
  147. if (error !== undefined) {
  148. switch (error.statusCode) {
  149. case 400:
  150. errorMessage = '请求错误';
  151. break;
  152. case 401:
  153. errorMessage = isLogin ? '您的登陆已过期' : '请先登录';
  154. // 正常情况下,后端不会返回 401 错误,所以这里不处理 handleAuthorized
  155. break;
  156. case 403:
  157. errorMessage = '拒绝访问';
  158. break;
  159. case 404:
  160. errorMessage = '请求出错';
  161. break;
  162. case 408:
  163. errorMessage = '请求超时';
  164. break;
  165. case 429:
  166. errorMessage = '请求频繁, 请稍后再访问';
  167. break;
  168. case 500:
  169. errorMessage = '服务器开小差啦,请稍后再试~';
  170. break;
  171. case 501:
  172. errorMessage = '服务未实现';
  173. break;
  174. case 502:
  175. errorMessage = '网络错误';
  176. break;
  177. case 503:
  178. errorMessage = '服务不可用';
  179. break;
  180. case 504:
  181. errorMessage = '网络超时';
  182. break;
  183. case 505:
  184. errorMessage = 'HTTP 版本不受支持';
  185. break;
  186. }
  187. if (error.errMsg.includes('timeout')) errorMessage = '请求超时';
  188. // #ifdef H5
  189. if (error.errMsg.includes('Network'))
  190. errorMessage = window.navigator.onLine ? '服务器异常' : '请检查您的网络连接';
  191. // #endif
  192. }
  193. if (error && error.config) {
  194. if (error.config.custom.showError === false) {
  195. uni.showToast({
  196. title: error.data?.msg || errorMessage,
  197. icon: 'none',
  198. mask: true,
  199. });
  200. }
  201. error.config.custom.showLoading && closeLoading();
  202. }
  203. return false;
  204. },
  205. );
  206. // Axios 无感知刷新令牌,参考 https://www.dashingdog.cn/article/11 与 https://segmentfault.com/a/1190000020210980 实现
  207. let requestList = [] // 请求队列
  208. let isRefreshToken = false // 是否正在刷新中
  209. const handleRefreshToken = async (config) => {
  210. // 如果当前已经是 refresh-token 的 URL 地址,并且还是 401 错误,说明是刷新令牌失败了,直接返回 Promise.reject(error)
  211. if (config.url.indexOf('/menduner/system/auth/refresh-token') >= 0) {
  212. return Promise.reject('error')
  213. }
  214. // 如果未认证,并且未进行刷新令牌,说明可能是访问令牌过期了
  215. if (!isRefreshToken) {
  216. isRefreshToken = true
  217. // 1. 如果获取不到刷新令牌,则只能执行登出操作
  218. const refresh_token = getRefreshToken()
  219. if (!refresh_token) {
  220. return handleAuthorized()
  221. }
  222. // 2. 进行刷新访问令牌
  223. try {
  224. const refreshTokenResult = await refreshToken(refresh_token);
  225. if (refreshTokenResult.code !== 0) {
  226. // 如果刷新不成功,直接抛出 e 触发 2.2 的逻辑
  227. // noinspection ExceptionCaughtLocallyJS
  228. throw new Error('刷新令牌失败');
  229. }
  230. // 2.1 刷新成功,则回放队列的请求 + 当前请求
  231. config.header.Authorization = 'Bearer ' + getAccessToken()
  232. requestList.forEach((cb) => {
  233. cb()
  234. })
  235. requestList = []
  236. return request(config)
  237. } catch (e) {
  238. // 为什么需要 catch 异常呢?刷新失败时,请求因为 Promise.reject 触发异常。
  239. // 2.2 刷新失败,只回放队列的请求
  240. requestList.forEach((cb) => {
  241. cb()
  242. })
  243. // 提示是否要登出。即不回放当前请求!不然会形成递归
  244. return handleAuthorized()
  245. } finally {
  246. requestList = []
  247. isRefreshToken = false
  248. }
  249. } else {
  250. // 添加到队列,等待刷新获取到新的令牌
  251. return new Promise((resolve) => {
  252. requestList.push(() => {
  253. config.header.Authorization = 'Bearer ' + getAccessToken() // 让每个请求携带自定义token 请根据实际情况自行修改
  254. resolve(request(config))
  255. })
  256. })
  257. }
  258. }
  259. /**
  260. * 处理 401 未登录的错误
  261. */
  262. const handleAuthorized = () => {
  263. const useUserStore = userStore()
  264. useUserStore.handleLogout(true);
  265. uni.showToast({
  266. title:'请先登录',
  267. icon: 'none'
  268. })
  269. uni.navigateTo({
  270. url: '/pages/login/index'
  271. })
  272. // 登录超时
  273. return Promise.reject({
  274. code: 401,
  275. msg: useUserStore.isLogin ? '您的登陆已过期' : '请先登录'
  276. })
  277. }
  278. /** 获得访问令牌 */
  279. const getAccessToken = () => {
  280. return uni.getStorageSync('token');
  281. }
  282. /** 获得刷新令牌 */
  283. const getRefreshToken = () => {
  284. return uni.getStorageSync('refresh-token');
  285. }
  286. const request = (config) => {
  287. return http.middleware(config);
  288. };
  289. export default request;