2024-06-02 20:50:51 +08:00
|
|
|
|
import type {
|
|
|
|
|
AxiosInstance,
|
|
|
|
|
AxiosRequestConfig,
|
|
|
|
|
AxiosResponse,
|
|
|
|
|
CreateAxiosDefaults,
|
|
|
|
|
} from 'axios';
|
|
|
|
|
|
2024-07-23 00:03:59 +08:00
|
|
|
|
import { merge } from '@vben/utils';
|
2024-06-02 20:50:51 +08:00
|
|
|
|
|
|
|
|
|
import axios from 'axios';
|
|
|
|
|
|
|
|
|
|
import { FileDownloader } from './modules/downloader';
|
|
|
|
|
import { InterceptorManager } from './modules/interceptor';
|
|
|
|
|
import { FileUploader } from './modules/uploader';
|
2024-08-19 22:59:42 +08:00
|
|
|
|
import { type RequestClientOptions } from './types';
|
2024-06-02 20:50:51 +08:00
|
|
|
|
|
|
|
|
|
class RequestClient {
|
2024-08-19 22:59:42 +08:00
|
|
|
|
private readonly instance: AxiosInstance;
|
2024-07-11 22:50:21 +08:00
|
|
|
|
|
2024-06-02 20:50:51 +08:00
|
|
|
|
public addRequestInterceptor: InterceptorManager['addRequestInterceptor'];
|
|
|
|
|
public addResponseInterceptor: InterceptorManager['addResponseInterceptor'];
|
2024-08-19 22:59:42 +08:00
|
|
|
|
|
2024-06-02 20:50:51 +08:00
|
|
|
|
public download: FileDownloader['download'];
|
2024-08-19 22:59:42 +08:00
|
|
|
|
// 是否正在刷新token
|
|
|
|
|
public isRefreshing = false;
|
|
|
|
|
// 刷新token队列
|
|
|
|
|
public refreshTokenQueue: ((token: string) => void)[] = [];
|
2024-06-02 20:50:51 +08:00
|
|
|
|
public upload: FileUploader['upload'];
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* 构造函数,用于创建Axios实例
|
2024-06-08 16:33:49 +08:00
|
|
|
|
* @param options - Axios请求配置,可选
|
2024-06-02 20:50:51 +08:00
|
|
|
|
*/
|
|
|
|
|
constructor(options: RequestClientOptions = {}) {
|
|
|
|
|
// 合并默认配置和传入的配置
|
|
|
|
|
const defaultConfig: CreateAxiosDefaults = {
|
|
|
|
|
headers: {
|
|
|
|
|
'Content-Type': 'application/json;charset=utf-8',
|
|
|
|
|
},
|
|
|
|
|
// 默认超时时间
|
|
|
|
|
timeout: 10_000,
|
|
|
|
|
};
|
2024-08-19 22:59:42 +08:00
|
|
|
|
const { ...axiosConfig } = options;
|
2024-06-02 20:50:51 +08:00
|
|
|
|
const requestConfig = merge(axiosConfig, defaultConfig);
|
|
|
|
|
this.instance = axios.create(requestConfig);
|
2024-08-19 22:59:42 +08:00
|
|
|
|
|
|
|
|
|
this.bindMethods();
|
2024-06-02 20:50:51 +08:00
|
|
|
|
|
|
|
|
|
// 实例化拦截器管理器
|
|
|
|
|
const interceptorManager = new InterceptorManager(this.instance);
|
|
|
|
|
this.addRequestInterceptor =
|
|
|
|
|
interceptorManager.addRequestInterceptor.bind(interceptorManager);
|
|
|
|
|
this.addResponseInterceptor =
|
|
|
|
|
interceptorManager.addResponseInterceptor.bind(interceptorManager);
|
|
|
|
|
|
|
|
|
|
// 实例化文件上传器
|
|
|
|
|
const fileUploader = new FileUploader(this);
|
|
|
|
|
this.upload = fileUploader.upload.bind(fileUploader);
|
|
|
|
|
// 实例化文件下载器
|
|
|
|
|
const fileDownloader = new FileDownloader(this);
|
|
|
|
|
this.download = fileDownloader.download.bind(fileDownloader);
|
|
|
|
|
}
|
|
|
|
|
|
2024-06-30 14:09:44 +08:00
|
|
|
|
private bindMethods() {
|
|
|
|
|
const propertyNames = Object.getOwnPropertyNames(
|
|
|
|
|
Object.getPrototypeOf(this),
|
|
|
|
|
);
|
|
|
|
|
propertyNames.forEach((propertyName) => {
|
|
|
|
|
const propertyValue = (this as any)[propertyName];
|
|
|
|
|
if (
|
|
|
|
|
typeof propertyValue === 'function' &&
|
|
|
|
|
propertyName !== 'constructor'
|
|
|
|
|
) {
|
|
|
|
|
(this as any)[propertyName] = propertyValue.bind(this);
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
|
2024-06-02 20:50:51 +08:00
|
|
|
|
/**
|
|
|
|
|
* DELETE请求方法
|
|
|
|
|
*/
|
|
|
|
|
public delete<T = any>(url: string, config?: AxiosRequestConfig): Promise<T> {
|
|
|
|
|
return this.request<T>(url, { ...config, method: 'DELETE' });
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* GET请求方法
|
|
|
|
|
*/
|
|
|
|
|
public get<T = any>(url: string, config?: AxiosRequestConfig): Promise<T> {
|
|
|
|
|
return this.request<T>(url, { ...config, method: 'GET' });
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* POST请求方法
|
|
|
|
|
*/
|
|
|
|
|
public post<T = any>(
|
|
|
|
|
url: string,
|
|
|
|
|
data?: any,
|
|
|
|
|
config?: AxiosRequestConfig,
|
|
|
|
|
): Promise<T> {
|
|
|
|
|
return this.request<T>(url, { ...config, data, method: 'POST' });
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* PUT请求方法
|
|
|
|
|
*/
|
|
|
|
|
public put<T = any>(
|
|
|
|
|
url: string,
|
|
|
|
|
data?: any,
|
|
|
|
|
config?: AxiosRequestConfig,
|
|
|
|
|
): Promise<T> {
|
|
|
|
|
return this.request<T>(url, { ...config, data, method: 'PUT' });
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* 通用的请求方法
|
|
|
|
|
*/
|
|
|
|
|
public async request<T>(url: string, config: AxiosRequestConfig): Promise<T> {
|
|
|
|
|
try {
|
|
|
|
|
const response: AxiosResponse<T> = await this.instance({
|
|
|
|
|
url,
|
|
|
|
|
...config,
|
|
|
|
|
});
|
|
|
|
|
return response as T;
|
|
|
|
|
} catch (error: any) {
|
|
|
|
|
throw error.response ? error.response.data : error;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export { RequestClient };
|