request.js 8.5 KB

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