index.ts 5.4 KB

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