request.js 12 KB

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