import type { AxiosRequestConfig, AxiosInstance, AxiosResponse } from 'axios'; import axios from 'axios'; import { AxiosCanceler } from './axiosCancel'; import { isFunction } from '@/utils/is'; import { cloneDeep } from 'lodash-es'; import type { RequestOptions, CreateAxiosOptions, Result, UploadFileParams } from './types'; import { ContentTypeEnum } from '@/enums/httpEnum'; export * from './axiosTransform'; /** * @description: axios模块 */ export class VAxios { private axiosInstance: AxiosInstance; private options: CreateAxiosOptions; constructor(options: CreateAxiosOptions) { this.options = options; this.axiosInstance = axios.create(options); this.setupInterceptors(); } getAxios(): AxiosInstance { return this.axiosInstance; } /** * @description: 重新配置axios */ configAxios(config: CreateAxiosOptions) { if (!this.axiosInstance) { return; } this.createAxios(config); } /** * @description: 设置通用header */ setHeader(headers: any): void { if (!this.axiosInstance) { return; } Object.assign(this.axiosInstance.defaults.headers, headers); } /** * @description: 请求方法 */ request(config: AxiosRequestConfig, options?: RequestOptions): Promise { let conf: AxiosRequestConfig = cloneDeep(config); const transform = this.getTransform(); const { requestOptions } = this.options; const opt: RequestOptions = Object.assign({}, requestOptions, options); const { beforeRequestHook, requestCatch, transformRequestData } = transform || {}; if (beforeRequestHook && isFunction(beforeRequestHook)) { conf = beforeRequestHook(conf, opt); } //这里重新 赋值成最新的配置 conf.requestOptions = opt; return new Promise((resolve, reject) => { this.axiosInstance .request>(conf) .then((res: AxiosResponse) => { // 请求是否被取消 const isCancel = axios.isCancel(res); if (transformRequestData && isFunction(transformRequestData) && !isCancel) { try { const ret = transformRequestData(res, opt); resolve(ret); } catch (err) { reject(err || new Error('request error!')); } return; } resolve(res as unknown as Promise); }) .catch((e: Error) => { if (requestCatch && isFunction(requestCatch)) { reject(requestCatch(e)); return; } reject(e); }); }); } /** * @description: 文件上传 */ uploadFile(config: AxiosRequestConfig, params: UploadFileParams) { const formData = new window.FormData(); const customFilename = params.name || 'file'; if (params.filename) { formData.append(customFilename, params.file, params.filename); } else { formData.append(customFilename, params.file); } if (params.data) { Object.keys(params.data).forEach((key) => { const value = params.data![key]; if (Array.isArray(value)) { value.forEach((item) => { formData.append(`${key}[]`, item); }); return; } formData.append(key, params.data![key]); }); } return this.axiosInstance.request({ method: 'POST', data: formData, headers: { 'Content-type': ContentTypeEnum.FORM_DATA, ignoreCancelToken: true, }, ...config, }); } /** * @description: 创建axios实例 */ private createAxios(config: CreateAxiosOptions): void { this.axiosInstance = axios.create(config); } private getTransform() { const { transform } = this.options; return transform; } /** * @description: 拦截器配置 */ private setupInterceptors() { const transform = this.getTransform(); if (!transform) { return; } const { requestInterceptors, requestInterceptorsCatch, responseInterceptors, responseInterceptorsCatch, } = transform; const axiosCanceler = new AxiosCanceler(); // 请求拦截器配置处理 this.axiosInstance.interceptors.request.use((config: AxiosRequestConfig) => { const { headers: { ignoreCancelToken }, } = config; const ignoreCancel = ignoreCancelToken !== undefined ? ignoreCancelToken : this.options.requestOptions?.ignoreCancelToken; !ignoreCancel && axiosCanceler.addPending(config); if (requestInterceptors && isFunction(requestInterceptors)) { config = requestInterceptors(config, this.options); } return config; }, undefined); // 请求拦截器错误捕获 requestInterceptorsCatch && isFunction(requestInterceptorsCatch) && this.axiosInstance.interceptors.request.use(undefined, requestInterceptorsCatch); // 响应结果拦截器处理 this.axiosInstance.interceptors.response.use((res: AxiosResponse) => { res && axiosCanceler.removePending(res.config); if (responseInterceptors && isFunction(responseInterceptors)) { res = responseInterceptors(res); } return res; }, undefined); // 响应结果拦截器错误捕获 responseInterceptorsCatch && isFunction(responseInterceptorsCatch) && this.axiosInstance.interceptors.response.use(undefined, responseInterceptorsCatch); } }