index.ts 7.7 KB

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