request.js 12 KB

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