// axios配置 可自行根据项目进行更改,只需更改该文件即可,其他文件可以不动 // The axios configuration can be changed according to the project, just change the file, other files can be left unchanged import type { AxiosResponse } from 'axios' import type { RequestOptions, Result } from '/#/axios' import type { AxiosTransform, CreateAxiosOptions } from './axiosTransform' import { VAxios } from './Axios' import { checkStatus } from './checkStatus' import { useGlobSetting } from '/@/hooks/setting' import { useMessage } from '/@/hooks/web/useMessage' import { RequestEnum, ResultEnum, ContentTypeEnum } from '/@/enums/httpEnum' import { isString } from '/@/utils/is' import { getToken } from '/@/utils/auth' import { setObjToUrlParams, deepMerge } from '/@/utils' import { joinTimestamp, formatRequestDate, formatRequestData } from './helper' import { useUserStoreWithOut } from '/@/store/modules/user' const globSetting = useGlobSetting() const urlPrefix = globSetting.urlPrefix const { createMessage, createErrorModal } = useMessage() /** * @description: 数据处理,方便区分多种处理方式 */ const transform: AxiosTransform = { /** * @description: 处理请求数据。如果数据不是预期格式,可直接抛出错误 */ transformRequestHook: (res: AxiosResponse, options: RequestOptions) => { const { isTransformResponse, isReturnNativeResponse } = options // 是否返回原生响应头 比如:需要获取响应头时使用该属性 if (isReturnNativeResponse) { return res } // 不进行任何处理,直接返回 // 用于页面代码可能需要直接获取code,data,message这些信息时开启 if (!isTransformResponse) { return res.data } // 错误的时候返回 const { data }: any = res if (!data) { // return '[HTTP] Request has no return value'; throw new Error('请求出错,请稍后再试') } // 这里 code,message为 后台统一的字段,需要在 types.ts内修改为项目自己的接口返回格式 const { code, msg } = data // 返回内部的data值 const hasSuccess = data && Reflect.has(data, 'code') && Number(code) === ResultEnum.SUCCESS if (hasSuccess) { return data.data } // 在此处根据自己项目的实际情况对不同的code执行不同的操作 // 如果不希望中断当前请求,请return数据,否则直接抛出异常即可 let timeoutMsg = '' const userStore = useUserStoreWithOut() switch (Number(code)) { case ResultEnum.TIMEOUT: timeoutMsg = '请求超时,请重新登录' userStore.setToken(null) userStore.logout(true) break case 500: timeoutMsg = msg break default: if (msg) { timeoutMsg = msg } } // errorMessageMode=‘modal’的时候会显示modal错误弹窗,而不是消息提示,用于一些比较重要的错误 // errorMessageMode='none' 一般是调用时明确表示不希望自动弹出错误提示 if (options.errorMessageMode === 'modal') { createErrorModal({ title: '错误提示', content: timeoutMsg }) } else if (options.errorMessageMode === 'message') { createMessage.error(timeoutMsg) } throw new Error(timeoutMsg || '请求出错,请稍后再试') }, // 请求之前处理config beforeRequestHook: (config, options) => { const { apiUrl, joinPrefix, joinParamsToUrl, formatDate, joinTime = true, urlPrefix } = options if (joinPrefix) { config.url = `${urlPrefix}${config.url}` } if (apiUrl && isString(apiUrl)) { config.url = `${apiUrl}${config.url}` } const params = config.params || {} const data = formatRequestData(config.data) || config.data // 去掉请求体中的空值 formatDate && data && !isString(data) && formatRequestDate(data) if (config.method?.toUpperCase() === RequestEnum.GET) { if (!isString(params)) { // 给 get 请求加上时间戳参数,避免从缓存中拿数据。 config.params = Object.assign(params || {}, joinTimestamp(joinTime, false)) } else { // 兼容restful风格 config.url = config.url + params + `${joinTimestamp(joinTime, true)}` config.params = undefined } } else { if (!isString(params)) { formatDate && formatRequestDate(params) if (Reflect.has(config, 'data') && config.data && Object.keys(config.data).length > 0) { config.data = data config.params = params } else if (Reflect.has(config, 'data') && config.data && config.data instanceof FormData) { // 如果是 FormData 对象,则不处理 config.data = data config.params = undefined } else { // 非GET请求如果没有提供data,则将params视为data config.data = params config.params = undefined } if (joinParamsToUrl) { config.url = setObjToUrlParams( config.url as string, Object.assign({}, config.params, config.data), ) } } else { // 兼容restful风格 config.url = config.url + params config.params = undefined } } return config }, /** * @description: 请求拦截器处理 */ requestInterceptors: (config, options) => { // 请求之前处理config const token = getToken() if (token && (config as Recordable)?.requestOptions?.withToken !== false) { // jwt token ;(config as Recordable).headers.Authorization = options.authenticationScheme ? `${options.authenticationScheme} ${token}` : token // STO ;(config as Recordable).headers.STO = token } // clientType ;(config as Recordable).headers.clientType = 'pj/web' return config }, /** * @description: 响应拦截器处理 */ responseInterceptors: (res: AxiosResponse) => { return res }, /** * @description: 响应错误处理 */ responseInterceptorsCatch: (error: any) => { const { response, code, message, config } = error || {} const errorMessageMode = config?.requestOptions?.errorMessageMode || 'none' const msg: string = response?.data?.error?.message ?? '' const err: string = error?.toString?.() ?? '' let errMessage = '' try { if (code === 'ECONNABORTED' && message.indexOf('timeout') !== -1) { errMessage = '请求接口超时,请刷新页面再试' } if (err?.includes('Network Error')) { errMessage = '网络异常,请检查你的网络连接' } if (errMessage) { if (errorMessageMode === 'modal') { createErrorModal({ title: '错误提示', content: errMessage }) } else if (errorMessageMode === 'message') { createMessage.error(errMessage) } return Promise.reject(error) } } catch (error) { throw new Error(error as unknown as string) } checkStatus(Number(error?.response?.status), msg, errorMessageMode) return Promise.reject(error) }, } function createAxios(opt?: Partial) { return new VAxios( deepMerge( { // See https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#authentication_schemes // authentication schemes,e.g: Bearer authenticationScheme: 'Bearer', // authenticationScheme: 'STO', timeout: 10 * 1000, // 基础接口地址 // baseURL: globSetting.apiUrl, headers: { 'Content-Type': ContentTypeEnum.JSON }, // 如果是form-data格式 // headers: { 'Content-Type': ContentTypeEnum.FORM_URLENCODED }, // 数据处理方式 transform, // 配置项,下面的选项都可以在独立的接口请求中覆盖 requestOptions: { // 默认将prefix 添加到url joinPrefix: true, // 是否返回原生响应头 比如:需要获取响应头时使用该属性 isReturnNativeResponse: false, // 默认返回{code,data,mesage}中的data,如果需要全部返回,加上该配置 isTransformResponse: true, // post请求的时候添加参数到url joinParamsToUrl: false, // 格式化提交参数时间 formatDate: true, // 消息提示类型 errorMessageMode: 'message', // 接口地址 apiUrl: globSetting.apiUrl, // 接口拼接地址 urlPrefix: urlPrefix, // 是否加入时间戳 joinTime: true, // 忽略重复请求 ignoreCancelToken: true, // 是否携带token withToken: true, }, }, opt || {}, ), ) } export const defHttp = createAxios() // other api url // export const otherHttp = createAxios({ // requestOptions: { // apiUrl: 'xxx', // urlPrefix: 'xxx', // }, // });