Files
zyt/admin/src/utils/request/index.ts
T
2026-04-07 18:13:03 +08:00

144 lines
4.8 KiB
TypeScript

import { AxiosError, type AxiosRequestConfig } from 'axios'
import { merge } from 'lodash'
import configs from '@/config'
import { PageEnum } from '@/enums/pageEnum'
import { ContentTypeEnum, RequestCodeEnum, RequestMethodsEnum } from '@/enums/requestEnums'
import router from '@/router'
import { clearAuthInfo, getToken } from '../auth'
import feedback from '../feedback'
import { Axios } from './axios'
import type { AxiosHooks } from './type'
import { isBrowserOnWecomBindOAuthLanding } from '../wecomBindGuard'
const BIND_WORK_WECHAT_PATH = '/bind-work-wechat'
let lastWorkWechatBindRedirectAt = 0
// 处理axios的钩子函数
const axiosHooks: AxiosHooks = {
requestInterceptorsHook(config) {
const { withToken, isParamsToData } = config.requestOptions
const params = config.params || {}
const headers = config.headers || {}
// 添加token
if (withToken) {
const token = getToken()
headers.token = token
}
// POST请求下如果无data,则将params视为data
if (
isParamsToData &&
!Reflect.has(config, 'data') &&
config.method?.toUpperCase() === RequestMethodsEnum.POST
) {
config.data = params
config.params = {}
}
config.headers = headers
return config
},
requestInterceptorsCatchHook(err) {
return err
},
async responseInterceptorsHook(response) {
const { isTransformResponse, isReturnDefaultResponse } = response.config.requestOptions
//返回默认响应,当需要获取响应头及其他数据时可使用
if (isReturnDefaultResponse) {
return response
}
// 是否需要对数据进行处理
if (!isTransformResponse) {
return response.data
}
const { code, data, show, msg } = response.data
switch (code) {
case RequestCodeEnum.SUCCESS:
if (show) {
msg && feedback.msgSuccess(msg)
}
return data
case RequestCodeEnum.FAIL:
if (show) {
msg && feedback.msgError(msg)
}
return Promise.reject(data)
case RequestCodeEnum.LOGIN_FAILURE:
clearAuthInfo()
router.push(PageEnum.LOGIN)
return Promise.reject()
case RequestCodeEnum.NEED_BIND_WORK_WECHAT:
// 回跳瞬间 currentRoute 可能还是 /,误判后 replace 无 query,地址栏 code 被清 → 绑定永远不请求
if (
router.currentRoute.value.path === BIND_WORK_WECHAT_PATH ||
isBrowserOnWecomBindOAuthLanding()
) {
return Promise.reject(data)
}
{
const now = Date.now()
if (now - lastWorkWechatBindRedirectAt > 400) {
lastWorkWechatBindRedirectAt = now
void router.replace(BIND_WORK_WECHAT_PATH).catch(() => {})
}
}
return Promise.reject(data)
case RequestCodeEnum.OPEN_NEW_PAGE:
window.location.href = data.url
return data
case RequestCodeEnum.NOT_INSTALL:
window.location.replace('/install/install.php')
break
default:
return data
}
},
responseInterceptorsCatchHook(error) {
if (error.code !== AxiosError.ERR_CANCELED) {
error.message && feedback.msgError(error.message)
}
return Promise.reject(error)
}
}
const defaultOptions: AxiosRequestConfig = {
//接口超时时间
timeout: configs.timeout,
// 基础接口地址
baseURL: configs.baseUrl,
//请求头
headers: { 'Content-Type': ContentTypeEnum.JSON, version: configs.version },
// 处理 axios的钩子函数
axiosHooks: axiosHooks,
// 每个接口可以单独配置
requestOptions: {
// 是否将params视为data参数,仅限post请求
isParamsToData: true,
//是否返回默认的响应
isReturnDefaultResponse: false,
// 需要对返回数据进行处理
isTransformResponse: true,
// 接口拼接地址
urlPrefix: configs.urlPrefix,
// 忽略重复请求
ignoreCancelToken: false,
// 是否携带token
withToken: true,
// 开启请求超时重新发起请求请求机制
isOpenRetry: true,
// 重新请求次数
retryCount: 2
}
}
function createAxios(opt?: Partial<AxiosRequestConfig>) {
return new Axios(
// 深度合并
merge(defaultOptions, opt || {})
)
}
const request = createAxios()
export default request