request.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400
  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. import { baseUrl, tenantId, apiPath } from './config'
  9. import { showAuthModal } from '@/hooks/useModal'
  10. import { rewardEventTrackClick } from '@/api/integral'
  11. import { getSuffixAfterPrefix } from '@/utils/prefixUrl'
  12. import { encryptionFun } from '@/utils/openEncryption'
  13. import qs from 'qs'
  14. // 规则配置跟踪列表
  15. const RETURNED_API = '/admin-api/menduner/reward/event-track/click'
  16. let requestCompletionTrigger = []
  17. let clickTrigger = []
  18. const getEventList = () => {
  19. const eventRules = uni.getStorageSync('eventList')?.length ? JSON.parse(uni.getStorageSync('eventList')) : []
  20. requestCompletionTrigger = eventRules ? eventRules.filter(_e => _e.triggerType === '0') : []
  21. clickTrigger = eventRules ? eventRules.filter(_e => _e.triggerType === '1') : []
  22. }
  23. getEventList()
  24. const options = {
  25. // 显示操作成功消息 默认不显示
  26. showSuccess: false,
  27. // 成功提醒 默认使用后端返回值
  28. successMsg: '',
  29. // 显示失败消息 默认显示
  30. showError: true,
  31. // 失败提醒 默认使用后端返回信息
  32. errorMsg: '',
  33. // 显示请求时loading模态框 默认显示
  34. showLoading: true,
  35. // loading提醒文字
  36. loadingMsg: '加载中',
  37. // 需要授权才能请求 默认放开
  38. auth: false,
  39. // ...
  40. };
  41. // Loading全局实例
  42. let LoadingInstance = {
  43. target: null,
  44. count: 0,
  45. };
  46. /**
  47. * 关闭loading
  48. */
  49. function closeLoading() {
  50. if (LoadingInstance.count > 0) LoadingInstance.count--;
  51. if (LoadingInstance.count === 0) uni.hideLoading();
  52. }
  53. /**
  54. * @description 请求基础配置 可直接使用访问自定义请求
  55. */
  56. const http = new Request({
  57. // baseURL: baseUrl + apiPath,
  58. baseURL: baseUrl,
  59. timeout: 8000,
  60. method: 'GET',
  61. header: {
  62. Accept: 'text/json',
  63. 'Content-Type': 'application/json;charset=UTF-8',
  64. platform: 'WechatMiniProgram',
  65. },
  66. // #ifdef APP-PLUS
  67. sslVerify: false,
  68. // #endif
  69. // #ifdef H5
  70. // 跨域请求时是否携带凭证(cookies)仅H5支持(HBuilderX 2.6.15+)
  71. withCredentials: false,
  72. // #endif
  73. custom: options,
  74. });
  75. /**
  76. * @description 请求拦截器
  77. */
  78. http.interceptors.request.use(
  79. (config) => {
  80. const useUserStore = userStore()
  81. // 自定义处理【auth 授权】:必须登录的接口,则跳出 AuthModal 登录弹窗
  82. if (config.custom.auth && !useUserStore.isLogin) {
  83. uni.showToast({
  84. title:'请先登录',
  85. icon: 'none'
  86. })
  87. showAuthModal()
  88. return Promise.reject();
  89. }
  90. // 自定义处理【loading 加载中】:如果需要显示 loading,则显示 loading
  91. if (config.custom.showLoading) {
  92. LoadingInstance.count++;
  93. LoadingInstance.count === 1 &&
  94. uni.showLoading({
  95. title: config.custom.loadingMsg,
  96. mask: true,
  97. fail: () => {
  98. uni.hideLoading();
  99. },
  100. });
  101. }
  102. // 增加 token 令牌、terminal 终端、tenant 租户的请求头
  103. const token = getAccessToken();
  104. if (token) {
  105. config.header['Authorization'] = 'Bearer ' + token;
  106. }
  107. config.header['terminal'] = 'mp-weixin'
  108. config.header['Accept-Language'] = 'zh_CN'
  109. config.header['Accept'] = '*/*';
  110. config.header['tenant-id'] = tenantId;
  111. // get参数编码
  112. const params = config.params || {}
  113. if (config.method === 'GET' && params) {
  114. config.params = {}
  115. const paramsStr = qs.stringify(params, { allowDots: true })
  116. if (paramsStr) {
  117. config.url = config.url + '?' + paramsStr
  118. }
  119. }
  120. // 开启参数加密
  121. if (config.custom?.openEncryption) {
  122. const raw = config.url.split('?')[1]
  123. const body = {
  124. ...config.data,
  125. ...config.params
  126. }
  127. const header = encryptionFun({raw, body, appId: 'web_client', AppSecret: 'fa0fc0b5098b974b'})
  128. Object.assign(config.header, header)
  129. }
  130. if (uni.getStorageSync('token')) {
  131. // 截取request url
  132. const url = getSuffixAfterPrefix(config.url)
  133. if (url) getEventList()
  134. if (!url || !clickTrigger.length) return config
  135. const _obj = clickTrigger.find(e => e.url === url)
  136. if (_obj) {
  137. getIntegral(_obj.url)
  138. }
  139. }
  140. return config;
  141. },
  142. (error) => {
  143. return Promise.reject(error);
  144. },
  145. );
  146. /**
  147. * @description 响应拦截器
  148. */
  149. http.interceptors.response.use(
  150. (response) => {
  151. // 约定:如果是 /auth/ 下的 URL 地址,并且返回了 accessToken 说明是登录相关的接口,则自动设置登陆令牌
  152. if (response.config.url.indexOf('/system/auth/') >= 0 && response.data?.data?.accessToken) {
  153. const useUserStore = userStore()
  154. useUserStore.setToken(response.data.data.accessToken, response.data.data.refreshToken);
  155. }
  156. if (response.config.url.includes(RETURNED_API)) {
  157. if (!response.data.data || !response.data.data.length) return
  158. // 目前先默认展示返回的第一个,后续需改为展示多个内容
  159. const item = response.data.data && response.data.data.length ? response.data.data[0] : {}
  160. if (item.match) {
  161. uni.showModal({
  162. title: '系统提示',
  163. content: `恭喜您 【${item.title}】获得${item.point}积分`,
  164. showCancel: false,
  165. confirmText: '关闭',
  166. confirmColor: '#00B760'
  167. })
  168. }
  169. return
  170. }
  171. // 自定处理【loading 加载中】:如果需要显示 loading,则关闭 loading
  172. response.config.custom.showLoading && closeLoading();
  173. // 自定义处理【error 错误提示】:如果需要显示错误提示,则显示错误提示
  174. if (response.data.code !== 0) {
  175. // 特殊:如果 401 错误码,则跳转到登录页 or 刷新令牌
  176. if (response.data.code === 401) {
  177. return handleRefreshToken(response.config);
  178. }
  179. // 错误提示
  180. if (response.config.custom.showError) {
  181. if (response.data?.msg === '重复请求,请稍后重试') console.error('前台打印: 重复请求,请稍后重试')
  182. else {
  183. uni.showToast({
  184. title: response.data.msg || '服务器开小差啦,请稍后再试~',
  185. icon: 'none',
  186. mask: true,
  187. });
  188. }
  189. }
  190. return Promise.reject(response.data);
  191. }
  192. // 自定义处理【showSuccess 成功提示】:如果需要显示成功提示,则显示成功提示
  193. if (response.config.custom.showSuccess && response.config.custom.successMsg !== '' && response.data.code === 0) {
  194. uni.showToast({
  195. title: response.config.custom.successMsg,
  196. icon: 'none',
  197. });
  198. }
  199. // 请求成功后触发获取积分
  200. if (uni.getStorageSync('token')) {
  201. const url = getSuffixAfterPrefix(response.config.url)
  202. if (url) getEventList()
  203. if (!url || !requestCompletionTrigger.length) return response.data
  204. const _obj = requestCompletionTrigger.find(e => e.url === url)
  205. if (_obj) {
  206. getIntegral(_obj.url)
  207. }
  208. }
  209. // 返回结果:包括 code + data + msg
  210. return Promise.resolve(response.data);
  211. },
  212. (error) => {
  213. const useUserStore = userStore()
  214. const isLogin = useUserStore.isLogin;
  215. let errorMessage = '网络请求出错';
  216. if (error !== undefined) {
  217. switch (error.statusCode) {
  218. case 400:
  219. errorMessage = '请求错误';
  220. break;
  221. case 401:
  222. errorMessage = isLogin ? '您的登陆已过期' : '请先登录';
  223. // 正常情况下,后端不会返回 401 错误,所以这里不处理 handleAuthorized
  224. break;
  225. case 403:
  226. errorMessage = '拒绝访问';
  227. break;
  228. case 404:
  229. errorMessage = '请求出错';
  230. break;
  231. case 408:
  232. errorMessage = '请求超时';
  233. break;
  234. case 429:
  235. errorMessage = '请求频繁, 请稍后再访问';
  236. break;
  237. case 500:
  238. errorMessage = '服务器开小差啦,请稍后再试~';
  239. break;
  240. case 501:
  241. errorMessage = '服务未实现';
  242. break;
  243. case 502:
  244. errorMessage = '网络错误';
  245. break;
  246. case 503:
  247. errorMessage = '服务不可用';
  248. break;
  249. case 504:
  250. errorMessage = '网络超时';
  251. break;
  252. case 505:
  253. errorMessage = 'HTTP 版本不受支持';
  254. break;
  255. }
  256. if (error?.errMsg?.includes('timeout')) errorMessage = '请求超时';
  257. // #ifdef H5
  258. if (error?.errMsg?.includes('Network'))
  259. errorMessage = window.navigator.onLine ? '服务器异常' : '请检查您的网络连接';
  260. // #endif
  261. }
  262. if (error && error.config) {
  263. if (error.config.custom.showError === false) {
  264. uni.showToast({
  265. title: error.data?.msg || errorMessage,
  266. icon: 'none',
  267. mask: true,
  268. });
  269. }
  270. error.config.custom.showLoading && closeLoading();
  271. }
  272. return false;
  273. },
  274. );
  275. // Axios 无感知刷新令牌,参考 https://www.dashingdog.cn/article/11 与 https://segmentfault.com/a/1190000020210980 实现
  276. let requestList = [] // 请求队列
  277. let isRefreshToken = false // 是否正在刷新中
  278. const handleRefreshToken = async (config) => {
  279. // 如果当前已经是 refresh-token 的 URL 地址,并且还是 401 错误,说明是刷新令牌失败了,直接返回 Promise.reject(error)
  280. if (config.url.indexOf('/menduner/system/auth/refresh-token') >= 0) {
  281. return Promise.reject('error')
  282. }
  283. // 如果未认证,并且未进行刷新令牌,说明可能是访问令牌过期了
  284. if (!isRefreshToken) {
  285. isRefreshToken = true
  286. // 1. 如果获取不到刷新令牌,则只能执行登出操作
  287. const refresh_token = getRefreshToken()
  288. if (!refresh_token) {
  289. return handleAuthorized()
  290. }
  291. // 2. 进行刷新访问令牌
  292. try {
  293. const refreshTokenResult = await refreshToken(refresh_token);
  294. if (refreshTokenResult.code !== 0) {
  295. // 如果刷新不成功,直接抛出 e 触发 2.2 的逻辑
  296. // noinspection ExceptionCaughtLocallyJS
  297. throw new Error('刷新令牌失败');
  298. }
  299. // 2.1 刷新成功,则回放队列的请求 + 当前请求
  300. config.header.Authorization = 'Bearer ' + getAccessToken()
  301. requestList.forEach((cb) => {
  302. cb()
  303. })
  304. requestList = []
  305. return request(config)
  306. } catch (e) {
  307. // 为什么需要 catch 异常呢?刷新失败时,请求因为 Promise.reject 触发异常。
  308. // 2.2 刷新失败,只回放队列的请求
  309. requestList.forEach((cb) => {
  310. cb()
  311. })
  312. // 提示是否要登出。即不回放当前请求!不然会形成递归
  313. return handleAuthorized()
  314. } finally {
  315. requestList = []
  316. isRefreshToken = false
  317. }
  318. } else {
  319. // 添加到队列,等待刷新获取到新的令牌
  320. return new Promise((resolve) => {
  321. requestList.push(() => {
  322. config.header.Authorization = 'Bearer ' + getAccessToken() // 让每个请求携带自定义token 请根据实际情况自行修改
  323. resolve(request(config))
  324. })
  325. })
  326. }
  327. }
  328. /**
  329. * 处理 401 未登录的错误
  330. */
  331. const handleAuthorized = () => {
  332. const useUserStore = userStore()
  333. useUserStore.handleLogout(true);
  334. uni.showToast({
  335. title:'请先登录',
  336. icon: 'none'
  337. })
  338. const msg = useUserStore.isLogin ? '您的登陆已过期' : '请先登录'
  339. useUserStore.setLogin(false)
  340. showAuthModal()
  341. // 登录超时
  342. return Promise.reject({
  343. code: 401,
  344. msg
  345. })
  346. }
  347. // 触发获取积分
  348. const getIntegral = (url) => {
  349. rewardEventTrackClick(url).then(() => {})
  350. }
  351. /** 获得必填人才信息情况 */
  352. export const showNecessaryInfoPopup = () => {
  353. return uni.getStorageSync('necessaryInfoReady') === 'fddeaddc47868b';
  354. }
  355. /** 获得访问令牌 */
  356. export const getAccessToken = () => {
  357. return uni.getStorageSync('token');
  358. }
  359. /** 获得刷新令牌 */
  360. const getRefreshToken = () => {
  361. return uni.getStorageSync('refresh-token');
  362. }
  363. const request = (config) => {
  364. return http.middleware(config);
  365. };
  366. export default request;