2023-03-28 21:32:54 +08:00
|
|
|
import { buildURL } from '../helpers/buildURL';
|
2023-03-23 20:09:00 +08:00
|
|
|
import { mergeConfig } from './mergeConfig';
|
|
|
|
import {
|
|
|
|
AxiosAdapter,
|
2023-03-28 20:35:40 +08:00
|
|
|
AxiosAdapterRequestMethod,
|
2023-03-23 20:09:00 +08:00
|
|
|
AxiosAdapterTask,
|
2023-03-28 20:35:40 +08:00
|
|
|
AxiosAdapterResponse,
|
|
|
|
AxiosAdapterResponseError,
|
|
|
|
AxiosAdapterRequestConfig,
|
2023-03-24 20:15:51 +08:00
|
|
|
} from '../adapter';
|
2023-03-23 20:09:00 +08:00
|
|
|
import { CancelToken } from './cancel';
|
|
|
|
import dispatchRequest from './dispatchRequest';
|
|
|
|
import InterceptorManager from './InterceptorManager';
|
|
|
|
import { AxiosTransformer } from './transformData';
|
|
|
|
|
2023-03-28 20:35:40 +08:00
|
|
|
export type AxiosRequestMethod =
|
|
|
|
| AxiosAdapterRequestMethod
|
2023-03-23 20:09:00 +08:00
|
|
|
| 'options'
|
|
|
|
| 'get'
|
|
|
|
| 'head'
|
|
|
|
| 'post'
|
|
|
|
| 'put'
|
|
|
|
| 'delete'
|
|
|
|
| 'trace'
|
|
|
|
| 'connect';
|
|
|
|
|
2023-03-28 20:35:40 +08:00
|
|
|
export interface AxiosRequestHeaders extends AnyObject {
|
|
|
|
options?: AnyObject;
|
|
|
|
get?: AnyObject;
|
|
|
|
head?: AnyObject;
|
|
|
|
post?: AnyObject;
|
|
|
|
put?: AnyObject;
|
|
|
|
delete?: AnyObject;
|
|
|
|
trace?: AnyObject;
|
|
|
|
connect?: AnyObject;
|
|
|
|
}
|
2023-03-23 20:09:00 +08:00
|
|
|
|
2023-03-28 20:35:40 +08:00
|
|
|
export interface AxiosRequestFormData extends AnyObject {
|
2023-03-23 20:09:00 +08:00
|
|
|
fileName: string;
|
|
|
|
filePath: string;
|
|
|
|
fileType?: 'image' | 'video' | 'audio';
|
|
|
|
}
|
|
|
|
|
|
|
|
export interface AxiosProgressEvent {
|
|
|
|
progress: number;
|
|
|
|
totalBytesSent: number;
|
|
|
|
totalBytesExpectedToSend: number;
|
|
|
|
}
|
|
|
|
|
|
|
|
export interface AxiosProgressCallback {
|
|
|
|
(event: AxiosProgressEvent): void;
|
|
|
|
}
|
|
|
|
|
2023-03-28 20:35:40 +08:00
|
|
|
export interface AxiosRequestConfig
|
|
|
|
extends Omit<
|
|
|
|
Partial<AxiosAdapterRequestConfig>,
|
|
|
|
'type' | 'method' | 'success' | 'fail'
|
|
|
|
> {
|
|
|
|
/**
|
|
|
|
* 请求适配器
|
|
|
|
*/
|
2023-03-23 20:09:00 +08:00
|
|
|
adapter?: AxiosAdapter;
|
2023-03-28 20:35:40 +08:00
|
|
|
/**
|
|
|
|
* 基础路径
|
|
|
|
*/
|
2023-03-23 20:09:00 +08:00
|
|
|
baseURL?: string;
|
2023-03-28 20:35:40 +08:00
|
|
|
/**
|
|
|
|
* 请求参数
|
|
|
|
*/
|
|
|
|
params?: AnyObject;
|
|
|
|
/**
|
|
|
|
* 请求数据
|
|
|
|
*/
|
|
|
|
data?: AnyObject | AxiosRequestFormData;
|
|
|
|
/**
|
|
|
|
* 请求头
|
|
|
|
*/
|
|
|
|
headers?: AxiosRequestHeaders;
|
|
|
|
/**
|
|
|
|
* 请求方法
|
|
|
|
*/
|
|
|
|
method?: AxiosRequestMethod;
|
|
|
|
/**
|
|
|
|
* 取消令牌
|
|
|
|
*/
|
2023-03-23 20:09:00 +08:00
|
|
|
cancelToken?: CancelToken;
|
2023-03-28 20:35:40 +08:00
|
|
|
/**
|
|
|
|
* 上传
|
|
|
|
*/
|
|
|
|
upload?: boolean;
|
|
|
|
/**
|
|
|
|
* 下载
|
|
|
|
*/
|
2023-03-23 20:09:00 +08:00
|
|
|
download?: boolean;
|
2023-03-28 20:35:40 +08:00
|
|
|
/**
|
|
|
|
* 转换请求数据
|
|
|
|
*/
|
|
|
|
transformRequest?: AxiosTransformer | AxiosTransformer[];
|
|
|
|
/**
|
|
|
|
* 转换响应数据
|
|
|
|
*/
|
|
|
|
transformResponse?: AxiosTransformer | AxiosTransformer[];
|
|
|
|
/**
|
|
|
|
* 异常梳处理
|
|
|
|
*/
|
2023-03-23 20:09:00 +08:00
|
|
|
errorHandler?: (error: unknown) => Promise<unknown>;
|
2023-03-28 20:35:40 +08:00
|
|
|
/**
|
|
|
|
* 监听上传进度
|
|
|
|
*/
|
2023-03-23 20:09:00 +08:00
|
|
|
onUploadProgress?: AxiosProgressCallback;
|
2023-03-28 20:35:40 +08:00
|
|
|
/**
|
|
|
|
* 监听下载进度
|
|
|
|
*/
|
2023-03-23 20:09:00 +08:00
|
|
|
onDownloadProgress?: AxiosProgressCallback;
|
2023-03-28 20:35:40 +08:00
|
|
|
/**
|
|
|
|
* 请求参数系列化函数
|
|
|
|
*/
|
|
|
|
paramsSerializer?: (params?: AnyObject) => string;
|
|
|
|
/**
|
|
|
|
* 校验状态码
|
|
|
|
*/
|
2023-03-23 20:09:00 +08:00
|
|
|
validateStatus?: (status: number) => boolean;
|
|
|
|
}
|
|
|
|
|
2023-03-28 20:35:40 +08:00
|
|
|
export interface AxiosResponse<TData = unknown>
|
|
|
|
extends AxiosAdapterResponse<TData> {
|
2023-03-23 20:09:00 +08:00
|
|
|
config?: AxiosRequestConfig;
|
|
|
|
request?: AxiosAdapterTask;
|
|
|
|
}
|
|
|
|
|
2023-03-28 20:35:40 +08:00
|
|
|
export interface AxiosResponseError extends AxiosAdapterResponseError {
|
2023-03-23 20:09:00 +08:00
|
|
|
config?: AxiosRequestConfig;
|
|
|
|
request?: AxiosAdapterTask;
|
|
|
|
}
|
|
|
|
|
|
|
|
export interface AxiosConstructor {
|
|
|
|
new (config: AxiosRequestConfig): Axios;
|
|
|
|
}
|
|
|
|
|
|
|
|
export default class Axios {
|
|
|
|
public defaults: AxiosRequestConfig;
|
|
|
|
|
|
|
|
public interceptors = {
|
|
|
|
request: new InterceptorManager<AxiosRequestConfig>(),
|
|
|
|
response: new InterceptorManager<AxiosResponse>(),
|
|
|
|
};
|
|
|
|
|
|
|
|
public constructor(defaults: AxiosRequestConfig = {}) {
|
|
|
|
this.defaults = defaults;
|
|
|
|
}
|
|
|
|
|
|
|
|
public getUri(config: AxiosRequestConfig): string {
|
|
|
|
const { url, params, paramsSerializer } = mergeConfig(
|
|
|
|
this.defaults,
|
|
|
|
config,
|
|
|
|
);
|
|
|
|
|
|
|
|
return buildURL(url, params, paramsSerializer).replace(/^\?/, '');
|
|
|
|
}
|
|
|
|
|
|
|
|
public request<TData = unknown>(
|
|
|
|
config: AxiosRequestConfig,
|
|
|
|
): Promise<AxiosResponse<TData>> {
|
|
|
|
const requestConfig = mergeConfig(this.defaults, config);
|
|
|
|
|
|
|
|
let promiseRequest = Promise.resolve(requestConfig);
|
|
|
|
|
|
|
|
this.interceptors.request.forEach(({ resolved, rejected }) => {
|
|
|
|
promiseRequest = promiseRequest.then(
|
|
|
|
resolved,
|
|
|
|
rejected,
|
|
|
|
) as Promise<AxiosRequestConfig>;
|
|
|
|
}, 'reverse');
|
|
|
|
|
|
|
|
let promiseResponse = promiseRequest.then(dispatchRequest);
|
|
|
|
|
|
|
|
this.interceptors.response.forEach(({ resolved, rejected }) => {
|
|
|
|
promiseResponse = promiseResponse.then(resolved, rejected) as Promise<
|
|
|
|
AxiosResponse<unknown>
|
|
|
|
>;
|
|
|
|
});
|
|
|
|
|
|
|
|
return promiseResponse as Promise<AxiosResponse<TData>>;
|
|
|
|
}
|
|
|
|
|
|
|
|
public options<TData = unknown>(
|
|
|
|
url: string,
|
|
|
|
config?: AxiosRequestConfig,
|
|
|
|
): Promise<AxiosResponse<TData>> {
|
2023-03-28 20:35:40 +08:00
|
|
|
return this._req<TData>('options', url, undefined, config);
|
2023-03-23 20:09:00 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
public get<TData = unknown>(
|
|
|
|
url: string,
|
2023-03-28 20:35:40 +08:00
|
|
|
params?: AnyObject,
|
2023-03-23 20:09:00 +08:00
|
|
|
config?: AxiosRequestConfig,
|
|
|
|
): Promise<AxiosResponse<TData>> {
|
2023-03-28 20:35:40 +08:00
|
|
|
return this._req<TData>('get', url, params, config);
|
2023-03-23 20:09:00 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
public head<TData = unknown>(
|
|
|
|
url: string,
|
2023-03-28 20:35:40 +08:00
|
|
|
params?: AnyObject,
|
2023-03-23 20:09:00 +08:00
|
|
|
config?: AxiosRequestConfig,
|
|
|
|
): Promise<AxiosResponse<TData>> {
|
2023-03-28 20:35:40 +08:00
|
|
|
return this._req<TData>('head', url, params, config);
|
2023-03-23 20:09:00 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
public post<TData = unknown>(
|
|
|
|
url: string,
|
2023-03-28 20:35:40 +08:00
|
|
|
data?: AnyObject | AxiosRequestFormData,
|
2023-03-23 20:09:00 +08:00
|
|
|
config?: AxiosRequestConfig,
|
|
|
|
): Promise<AxiosResponse<TData>> {
|
2023-03-28 20:35:40 +08:00
|
|
|
return this._reqWithData<TData>('post', url, data, config);
|
2023-03-23 20:09:00 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
public put<TData = unknown>(
|
|
|
|
url: string,
|
2023-03-28 20:35:40 +08:00
|
|
|
data?: AnyObject | AxiosRequestFormData,
|
2023-03-23 20:09:00 +08:00
|
|
|
config?: AxiosRequestConfig,
|
|
|
|
): Promise<AxiosResponse<TData>> {
|
2023-03-28 20:35:40 +08:00
|
|
|
return this._reqWithData<TData>('put', url, data, config);
|
2023-03-23 20:09:00 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
public delete<TData = unknown>(
|
|
|
|
url: string,
|
2023-03-28 20:35:40 +08:00
|
|
|
params?: AnyObject,
|
2023-03-23 20:09:00 +08:00
|
|
|
config?: AxiosRequestConfig,
|
|
|
|
): Promise<AxiosResponse<TData>> {
|
2023-03-28 20:35:40 +08:00
|
|
|
return this._req<TData>('delete', url, params, config);
|
2023-03-23 20:09:00 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
public trace<TData = unknown>(
|
|
|
|
url: string,
|
|
|
|
config?: AxiosRequestConfig,
|
|
|
|
): Promise<AxiosResponse<TData>> {
|
2023-03-28 20:35:40 +08:00
|
|
|
return this._req<TData>('trace', url, undefined, config);
|
2023-03-23 20:09:00 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
public connect<TData = unknown>(
|
|
|
|
url: string,
|
|
|
|
config?: AxiosRequestConfig,
|
|
|
|
): Promise<AxiosResponse<TData>> {
|
2023-03-28 20:35:40 +08:00
|
|
|
return this._req<TData>('connect', url, undefined, config);
|
2023-03-23 20:09:00 +08:00
|
|
|
}
|
|
|
|
|
2023-03-28 20:35:40 +08:00
|
|
|
private _req<TData = unknown>(
|
2023-03-23 20:09:00 +08:00
|
|
|
method: AxiosRequestMethod,
|
|
|
|
url: string,
|
2023-03-28 20:35:40 +08:00
|
|
|
params?: AnyObject,
|
2023-03-23 20:09:00 +08:00
|
|
|
config?: AxiosRequestConfig,
|
|
|
|
): Promise<AxiosResponse<TData>> {
|
|
|
|
return this.request<TData>({
|
|
|
|
...(config ?? {}),
|
|
|
|
method,
|
|
|
|
url,
|
|
|
|
params,
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
2023-03-28 20:35:40 +08:00
|
|
|
private _reqWithData<TData = unknown>(
|
2023-03-23 20:09:00 +08:00
|
|
|
method: AxiosRequestMethod,
|
|
|
|
url: string,
|
2023-03-28 20:35:40 +08:00
|
|
|
data?: AnyObject | AxiosRequestFormData,
|
2023-03-23 20:09:00 +08:00
|
|
|
config?: AxiosRequestConfig,
|
|
|
|
): Promise<AxiosResponse<TData>> {
|
|
|
|
return this.request<TData>({
|
|
|
|
...(config ?? {}),
|
|
|
|
method,
|
|
|
|
url,
|
|
|
|
data,
|
|
|
|
});
|
|
|
|
}
|
|
|
|
}
|