request.js 12 KB

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