request.ts
request.ts
import type { AxiosInstance } from 'axios'
import axios from 'axios'
import Cookie from 'js-cookie'
import { camelizeKeys, decamelizeKeys } from '@/utils/camelCase'
import { useOutsideRouter } from '@/store/hooks/useOutsideRouter'
// redirect error
function errorRedirect (url: string) {
const { router } = useOutsideRouter()
router.push(url)
}
export interface RespData<T> {
success?: boolean
errorCode?: number
error?: number | string | null
msg?: string
data?: T
[key: string]: any
}
// code Message
export const codeMessage: any = {
// 200: '服务器成功返回请求的数据。',
200: 'The server successfully returned the requested data.',
// 201: '新建或修改数据成功。',
201: 'Create or modify data successfully.',
// 202: '一个请求已经进入后台排队(异步任务)。',
202: 'A request has entered the background queue (asynchronous task).',
// 204: '删除数据成功。',
204: 'Data deleted successfully.',
// 206: '进行范围请求成功。',
206: 'Successful range request.',
// 400: '发出的请求有错误,服务器没有进行新建或修改数据的操作。',
400: 'Bad error request, and the server did not create or modify the data.',
// 401: '用户没有权限(令牌、用户名、密码错误)。',
401: 'User does not have permission (invalid username, password, security token).',
// 403: '用户得到授权,但是访问是被禁止的。',
403: 'User is authorized, but access is forbidden.',
// 404: '发出的请求针对的是不存在的记录,服务器没有进行操作。',
404: 'The request sent is for a record that does not exist, and the server does not operate.',
// 405: '请求不允许。',
405: 'Request denied.',
// 406: '请求的格式不可得。',
406: 'Requested format not available.',
// 410: '请求的资源被永久删除,且不会再得到的。',
410: 'The requested resource is permanently deleted and will no longer be available.',
// 422: '当创建一个对象时,发生一个验证错误。',
422: 'When creating an object, a validation error occurrs.',
// 500: '服务器发生错误,请检查服务器。',
500: 'An error occurred in the server, please check the server.',
// 502: '网关错误。',
502: 'Bad Gateway Error.',
// 503: '服务不可用,服务器暂时过载或维护。',
503: 'The server is temporarily unable to service your request due to maintenance downtime or capacity problems.',
// 504: '网关超时。'
504: 'Gateway Timeout.'
}
// Instance for axios
const service: AxiosInstance = axios.create({
// API from the environment variable
baseURL: import.meta.env.VITE_BASE_API,
timeout: 15000
})
// request拦截器
service.interceptors.request.use(
request => {
const token = Cookie.get('token')
// Conversion of hump nomenclature
if (
!(request.data instanceof FormData)
) {
request.data = decamelizeKeys(request.data)
}
request.params = decamelizeKeys(request.params)
/**
* 让每个请求携带自定义 token
* 请根据实际情况自行修改
*/
if (request.url === '/login') {
return request
}
Object.defineProperty(request.headers, 'Authorization', {
enumerable: true,
value: token as string
})
return request
},
error => {
return Promise.reject(error)
}
)
// respone拦截器
service.interceptors.response.use(
response => {
/**
* response data
* {
* data: {},
* msg: "",
* error: 0 0 success | 1 error | 5000 failed | HTTP code
* }
*/
const data = response.data
Promise.resolve().then(() => {
useResHeadersAPI(response.headers, data)
})
if (
response.request.responseType === 'blob' &&
/json$/gi.test(response.headers['content-type'])
) {
return new Promise(resolve => {
const reader = new FileReader()
reader.onload = () => {
response.data = JSON.parse(reader.result as string)
resolve(camelizeKeys(response.data))
}
reader.readAsText(response.data)
})
} else if (data instanceof Blob) {
return {
data,
msg: '',
error: 0
}
}
return camelizeKeys(data)
},
error => {
/**
* 某些特定的接口 404 500 需要跳转
* 在需要重定向的接口中传入 redirect字段 值为要跳转的路由
* redirect之后 调用接口的地方会继续执行
* 因为此时 response error
* 所以需要前端返回一个前端构造好的数据结构 避免前端业务部分逻辑出错
* 不重定向的接口则不需要传
*/
if (error.config.redirect) {
errorRedirect(error.config.redirect)
}
if (error.response) {
return {
data: {},
error: error.response.status,
msg: codeMessage[error.response.status] || error.response.data.message
}
} else {
// 某些特定的接口 failed 需要跳转
return {
data: {},
error: 5000,
msg: '服务请求不可用,请重试或检查您的网络。'
}
}
}
)
export function sleep (time = 0) {
return new Promise((resolve) => {
setTimeout(() => {
resolve({})
}, time)
})
}
function extractFileNameFromContentDispositionHeader (value: string) {
const patterns = [
/filename\*=[^']+'\w*'"([^"]+)";?/i,
/filename\*=[^']+'\w*'([^;]+);?/i,
/filename="([^;]*);?"/i,
/filename=([^;]*);?/i
]
let responseFilename: any
patterns.some(regex => {
responseFilename = regex.exec(value)
return responseFilename !== null
})
if (responseFilename !== null && responseFilename.length > 1) {
try {
return decodeURIComponent(responseFilename[1])
} catch (e) {
console.error(e)
}
}
return null
}
export function downloadFile (boldData: any, filename = 'test-filename', type: string) {
// TODO: https://blog.csdn.net/weixin_42142057/article/details/97655591
const blob = boldData instanceof Blob
? boldData
: new Blob([boldData], {
type
})
const url = window.URL.createObjectURL(blob)
const link = document.createElement('a')
link.style.display = 'none'
link.href = url
link.download = filename
document.body.appendChild(link)
link.click()
document.body.removeChild(link)
}
export function useResHeadersAPI (headers: any, resData: any) {
const disposition = headers['content-disposition']
if (disposition) {
let filename: any = ''
/**
* TODO: See
* https://stackoverflow.com/a/40940790/13202554
*
* https://github.com/swagger-api/swagger-ui/blob/master/src/core/components/response-body.jsx#L80
*/
filename = extractFileNameFromContentDispositionHeader(disposition)
if (filename) {
downloadFile(resData, filename, headers['content-type'])
}
}
}
export default service