request.js 8.4 KB

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