request.js 12 KB

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