service.js 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214
  1. import axios from 'axios'
  2. import Snackbar from '@/plugins/snackbar'
  3. import Confirm from '@/plugins/confirm'
  4. import qs from 'qs'
  5. import { config } from '@/config/axios/config'
  6. import { getToken, getRefreshToken, getTenantId, removeToken, setToken } from '@/utils/auth'
  7. // import { getToken, getRefreshToken, getTenantId, removeToken, setToken } from '@/utils/auth'
  8. import errorCode from './errorCode'
  9. import { useI18n } from '@/hooks/web/useI18n'
  10. // import { resetRouter } from '@/router'
  11. // import { deleteUserCache } from '@/hooks/web/useCache'
  12. const tenantEnable = import.meta.env.VITE_APP_TENANT_ENABLE
  13. const { result_code, base_url, request_timeout } = config
  14. // 需要忽略的提示。忽略后,自动 Promise.reject('error')
  15. const ignoreMsgs = [
  16. '无效的刷新令牌', // 刷新令牌被删除时,不用提示
  17. '刷新令牌已过期' // 使用刷新令牌,刷新获取新的访问令牌时,结果因为过期失败,此时需要忽略。否则,会导致继续 401,无法跳转到登出界面
  18. ]
  19. // 是否显示重新登录
  20. export const isReLogin = { show: false }
  21. // Axios 无感知刷新令牌,参考 https://www.dashingdog.cn/article/11 与 https://segmentfault.com/a/1190000020210980 实现
  22. // 请求队列
  23. let requestList = []
  24. // 是否正在刷新中
  25. let isRefreshToken = false
  26. // 请求白名单,无须token的接口
  27. const whiteList = ['/login', '/refresh-token']
  28. // 创建axios实例
  29. const service = axios.create({
  30. baseURL: base_url, // api 的 base_url
  31. timeout: request_timeout, // 请求超时时间
  32. withCredentials: false // 禁用 Cookie 等信息
  33. })
  34. // request拦截器
  35. service.interceptors.request.use(
  36. (config) => {
  37. config.headers['Accept-Language'] = 'zh-CN'
  38. // 是否需要设置 token
  39. let isToken = (config.headers || {}).isToken === false
  40. whiteList.some((v) => {
  41. if (config.url) {
  42. config.url.indexOf(v) > -1
  43. return (isToken = false)
  44. }
  45. })
  46. if (getToken() && !isToken) {
  47. ;(config).headers.Authorization = 'Bearer ' + getToken() // 让每个请求携带自定义token
  48. }
  49. // 设置租户
  50. if (tenantEnable && tenantEnable === 'true') {
  51. const tenantId = import.meta.env.VITE_TENANTCODE
  52. if (tenantId) config.headers['tenant-id'] = tenantId
  53. }
  54. const params = config.params || {}
  55. const data = config.data || false
  56. if (
  57. config.method?.toUpperCase() === 'POST' &&
  58. (config.headers)['Content-Type'] ===
  59. 'application/x-www-form-urlencoded'
  60. ) {
  61. config.data = qs.stringify(data)
  62. }
  63. // get参数编码
  64. if (config.method?.toUpperCase() === 'GET' && params) {
  65. config.params = {}
  66. const paramsStr = qs.stringify(params, { allowDots: true })
  67. if (paramsStr) {
  68. config.url = config.url + '?' + paramsStr
  69. }
  70. }
  71. return config
  72. },
  73. (error) => {
  74. // Do something with request error
  75. console.log(error) // for debug
  76. Promise.reject(error)
  77. }
  78. )
  79. // response 拦截器
  80. service.interceptors.response.use(
  81. async (response) => {
  82. const { t } = useI18n()
  83. let { data } = response
  84. const config = response.config
  85. if (!data) {
  86. // 返回“[HTTP]请求没有返回值”;
  87. throw new Error()
  88. }
  89. // 未设置状态码则默认成功状态
  90. // 二进制数据则直接返回,例如说 Excel 导出
  91. if (
  92. response.request.responseType === 'blob' ||
  93. response.request.responseType === 'arraybuffer'
  94. ) {
  95. // 注意:如果导出的响应为 json,说明可能失败了,不直接返回进行下载
  96. if (response.data.type !== 'application/json') {
  97. return response.data
  98. }
  99. data = await new Response(response.data).json()
  100. }
  101. const code = data.code || result_code
  102. // 获取错误信息
  103. const msg = data.msg || errorCode[code] || errorCode['default']
  104. if (ignoreMsgs.indexOf(msg) !== -1) {
  105. // 如果是忽略的错误码,直接返回 msg 异常
  106. return Promise.reject(msg)
  107. } else if (code === 401) {
  108. // 如果未认证,并且未进行刷新令牌,说明可能是访问令牌过期了
  109. if (!isRefreshToken) {
  110. isRefreshToken = true
  111. // 1. 如果获取不到刷新令牌,则只能执行登出操作
  112. if (!getRefreshToken()) {
  113. return handleAuthorized()
  114. }
  115. // 2. 进行刷新访问令牌
  116. try {
  117. const refreshTokenRes = await refreshToken()
  118. // 2.1 刷新成功,则回放队列的请求 + 当前请求
  119. setToken(refreshTokenRes.data.data)
  120. config.headers.Authorization = 'Bearer ' + getToken()
  121. requestList.forEach((cb) => {
  122. cb()
  123. })
  124. requestList = []
  125. return service(config)
  126. } catch (e) {
  127. // 为什么需要 catch 异常呢?刷新失败时,请求因为 Promise.reject 触发异常。
  128. // 2.2 刷新失败,只回放队列的请求
  129. requestList.forEach((cb) => {
  130. cb()
  131. })
  132. // 提示是否要登出。即不回放当前请求!不然会形成递归
  133. return handleAuthorized()
  134. } finally {
  135. requestList = []
  136. isRefreshToken = false
  137. }
  138. } else {
  139. // 添加到队列,等待刷新获取到新的令牌
  140. return new Promise((resolve) => {
  141. requestList.push(() => {
  142. config.headers.Authorization = 'Bearer ' + getToken() // 让每个请求携带自定义token 请根据实际情况自行修改
  143. resolve(service(config))
  144. })
  145. })
  146. }
  147. } else if (code === 500) {
  148. Snackbar.error(t('sys.api.errMsg500'))
  149. return Promise.reject(new Error(msg))
  150. } else if (code === 901) {
  151. Snackbar.error(t('sys.api.errMsg901'))
  152. return Promise.reject(new Error(msg))
  153. } else if (code !== 200) {
  154. if (msg === '无效的刷新令牌') {
  155. // hard coding:忽略这个提示,直接登出
  156. console.log(msg)
  157. }
  158. else {
  159. Snackbar.error(msg)
  160. }
  161. return Promise.reject(msg)
  162. } else {
  163. return data
  164. }
  165. },
  166. (error) => {
  167. const { t } = useI18n()
  168. // console.log('err' + error) // for debug
  169. let { message } = error
  170. if (message === 'Network Error') {
  171. message = t('sys.api.errorMessage')
  172. } else if (message.includes('timeout')) {
  173. message = t('sys.api.apiTimeoutMessage')
  174. } else if (message.includes('Request failed with status code')) {
  175. message = t('sys.api.apiRequestFailed') + message.substr(message.length - 3)
  176. }
  177. Snackbar.error(message)
  178. return Promise.reject(error)
  179. }
  180. )
  181. const refreshToken = async () => {
  182. axios.defaults.headers.common['tenant-id'] = getTenantId()
  183. return await axios.post(base_url + '/system/auth/refresh-token?refreshToken=' + getRefreshToken())
  184. }
  185. const handleAuthorized = () => {
  186. const { t } = useI18n()
  187. if (!isReLogin.show) {
  188. // 如果已经到重新登录页面则不进行弹窗提示
  189. if (window.location.href.includes('login?redirect=')) {
  190. return
  191. }
  192. isReLogin.show = true
  193. Confirm(t('common.confirmTitle'), t('sys.api.timeoutMessage')).then(() => {
  194. // resetRouter() // 重置静态路由表
  195. // deleteUserCache() // 删除用户缓存
  196. removeToken()
  197. isReLogin.show = false
  198. // 干掉token后再走一次路由让它过router.beforeEach的校验
  199. location.reload()
  200. })
  201. }
  202. return Promise.reject(t('sys.api.timeoutMessage'))
  203. }
  204. export { service }