index.ts 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169
  1. import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse, AxiosError } from 'axios'
  2. import { ElMessage, ElNotification } from 'element-plus'
  3. import qs from 'qs'
  4. import { config } from '@/config/axios/config'
  5. import { getAccessToken, getTenantId, removeToken } from '@/utils/auth'
  6. import errorCode from './errorCode'
  7. import { useI18n } from '@/hooks/web/useI18n'
  8. const tenantEnable = import.meta.env.VITE_APP_TENANT_ENABLE
  9. const BASE_URL = import.meta.env.VITE_BASE_URL
  10. const BASE_API = import.meta.env.VITE_API_URL
  11. const { result_code, base_url } = config
  12. // 需要忽略的提示。忽略后,自动 Promise.reject('error')
  13. const ignoreMsgs = [
  14. '无效的刷新令牌', // 刷新令牌被删除时,不用提示
  15. '刷新令牌已过期' // 使用刷新令牌,刷新获取新的访问令牌时,结果因为过期失败,此时需要忽略。否则,会导致继续 401,无法跳转到登出界面
  16. ]
  17. // 是否显示重新登录
  18. export const isRelogin = { show: false }
  19. // Axios 无感知刷新令牌,参考 https://www.dashingdog.cn/article/11 与 https://segmentfault.com/a/1190000020210980 实现
  20. // 请求队列
  21. // const requestList = []
  22. // 是否正在刷新中
  23. // const isRefreshToken = false
  24. export const PATH_URL = base_url[import.meta.env.VITE_API_BASEPATH]
  25. // 创建axios实例
  26. const service: AxiosInstance = axios.create({
  27. baseURL: BASE_URL + BASE_API, // api 的 base_url
  28. timeout: config.request_timeout, // 请求超时时间
  29. withCredentials: false // 禁用 Cookie 等信息
  30. })
  31. // request拦截器
  32. service.interceptors.request.use(
  33. (config: AxiosRequestConfig) => {
  34. // 是否需要设置 token
  35. const isToken = (config!.headers || {}).isToken === false
  36. if (getAccessToken() && !isToken) {
  37. ;(config as Recordable).headers.Authorization = 'Bearer ' + getAccessToken() // 让每个请求携带自定义token
  38. }
  39. // 设置租户
  40. if (tenantEnable) {
  41. const tenantId = getTenantId()
  42. if (tenantId) (config as Recordable).headers.common['tenant-id'] = tenantId
  43. }
  44. const params = config.params || {}
  45. const data = config.data || false
  46. if (
  47. config.method?.toUpperCase() === 'POST' &&
  48. config!.headers!['Content-Type'] === 'application/x-www-form-urlencoded'
  49. ) {
  50. config.data = qs.stringify(data)
  51. }
  52. // get参数编码
  53. if (config.method?.toUpperCase() === 'GET' && config.params) {
  54. let url = config.url as string
  55. // 给 get 请求加上时间戳参数,避免从缓存中拿数据
  56. // const now = new Date().getTime()
  57. // params = params.substring(0, url.length - 1) + `?_t=${now}`
  58. url += '?'
  59. for (const key of Object.keys(params)) {
  60. if (params[key] !== void 0 && params[key] !== null) {
  61. url += `${key}=${encodeURIComponent(params[key])}&`
  62. }
  63. }
  64. config.params = {}
  65. config.url = url
  66. }
  67. return config
  68. },
  69. (error: AxiosError) => {
  70. // Do something with request error
  71. console.log(error) // for debug
  72. Promise.reject(error)
  73. }
  74. )
  75. // response 拦截器
  76. service.interceptors.response.use(
  77. async (response: AxiosResponse<Recordable>) => {
  78. console.info(response)
  79. const { data } = response
  80. if (!data) {
  81. // 返回“[HTTP]请求没有返回值”;
  82. throw new Error()
  83. }
  84. const { t } = useI18n()
  85. // 未设置状态码则默认成功状态
  86. const code = data.code || result_code
  87. // 二进制数据则直接返回
  88. if (
  89. response.request.responseType === 'blob' ||
  90. response.request.responseType === 'arraybuffer'
  91. ) {
  92. return response.data
  93. }
  94. // 获取错误信息
  95. const msg = data.msg || errorCode[code] || errorCode['default']
  96. if (ignoreMsgs.indexOf(msg) !== -1) {
  97. // 如果是忽略的错误码,直接返回 msg 异常
  98. return Promise.reject(msg)
  99. } else if (code === 401) {
  100. // 如果未认证,并且未进行刷新令牌,说明可能是访问令牌过期了
  101. return handleAuthorized()
  102. // if (!isRefreshToken) {
  103. // isRefreshToken = true
  104. // // 1. 如果获取不到刷新令牌,则只能执行登出操作
  105. // if (!getRefreshToken()) {
  106. // return handleAuthorized()
  107. // }
  108. // // 2. 进行刷新访问令牌
  109. // // TODO: 引入refreshToken会循环依赖报错
  110. // }
  111. } else if (code === 500) {
  112. ElMessage.error(t('sys.api.errMsg500'))
  113. return Promise.reject(new Error(msg))
  114. } else if (code === 901) {
  115. ElMessage.error(
  116. '<div>' +
  117. t('sys.api.errMsg901') +
  118. '</div>' +
  119. '<div> &nbsp; </div>' +
  120. '<div>参考 https://doc.iocoder.cn/ 教程</div>' +
  121. '<div> &nbsp; </div>' +
  122. '<div>5 分钟搭建本地环境</div>'
  123. )
  124. return Promise.reject(new Error(msg))
  125. } else if (code !== 200) {
  126. if (msg === '无效的刷新令牌') {
  127. // hard coding:忽略这个提示,直接登出
  128. console.log(msg)
  129. } else {
  130. ElNotification.error({
  131. title: msg
  132. })
  133. }
  134. return Promise.reject('error')
  135. } else {
  136. return data
  137. }
  138. },
  139. (error: AxiosError) => {
  140. console.log('err' + error) // for debug
  141. let { message } = error
  142. const { t } = useI18n()
  143. if (message === 'Network Error') {
  144. message = t('sys.api.errorMessage')
  145. } else if (message.includes('timeout')) {
  146. message = t('sys.api.apiTimeoutMessage')
  147. } else if (message.includes('Request failed with status code')) {
  148. message = t('sys.api.apiRequestFailed') + message.substr(message.length - 3)
  149. }
  150. ElMessage.error(message)
  151. return Promise.reject(error)
  152. }
  153. )
  154. const handleAuthorized = () => {
  155. const { t } = useI18n()
  156. if (!isRelogin.show) {
  157. removeToken()
  158. isRelogin.show = true
  159. ElNotification.error(t('sys.api.timeoutMessage'))
  160. }
  161. return Promise.reject(t('sys.api.timeoutMessage'))
  162. }
  163. export { service }