|
1
|
import type { AxiosRequestConfig, AxiosInstance, AxiosResponse, AxiosError } from 'axios';
|
|
2
|
import type { RequestOptions, Result, UploadFileParams } from '/#/axios';
|
Vben
authored
|
3
|
import type { CreateAxiosOptions } from './axiosTransform';
|
|
4
|
import axios from 'axios';
|
Vben
authored
|
5
|
import qs from 'qs';
|
|
6
7
|
import { AxiosCanceler } from './axiosCancel';
import { isFunction } from '/@/utils/is';
|
erniu
authored
|
8
|
import { cloneDeep } from 'lodash-es';
|
vben
authored
|
9
|
import { ContentTypeEnum, RequestEnum } from '/@/enums/httpEnum';
|
|
10
11
12
13
|
export * from './axiosTransform';
/**
|
vben
authored
|
14
|
* @description: axios module
|
|
15
16
17
|
*/
export class VAxios {
private axiosInstance: AxiosInstance;
|
vben
authored
|
18
|
private readonly options: CreateAxiosOptions;
|
|
19
20
21
22
23
24
25
26
|
constructor(options: CreateAxiosOptions) {
this.options = options;
this.axiosInstance = axios.create(options);
this.setupInterceptors();
}
/**
|
vben
authored
|
27
|
* @description: Create axios instance
|
|
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
|
*/
private createAxios(config: CreateAxiosOptions): void {
this.axiosInstance = axios.create(config);
}
private getTransform() {
const { transform } = this.options;
return transform;
}
getAxios(): AxiosInstance {
return this.axiosInstance;
}
/**
|
vben
authored
|
43
|
* @description: Reconfigure axios
|
|
44
45
46
47
48
49
50
51
52
|
*/
configAxios(config: CreateAxiosOptions) {
if (!this.axiosInstance) {
return;
}
this.createAxios(config);
}
/**
|
vben
authored
|
53
|
* @description: Set general header
|
|
54
55
56
57
58
59
60
61
62
|
*/
setHeader(headers: any): void {
if (!this.axiosInstance) {
return;
}
Object.assign(this.axiosInstance.defaults.headers, headers);
}
/**
|
|
63
|
* @description: Interceptor configuration 拦截器配置
|
|
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
*/
private setupInterceptors() {
const transform = this.getTransform();
if (!transform) {
return;
}
const {
requestInterceptors,
requestInterceptorsCatch,
responseInterceptors,
responseInterceptorsCatch,
} = transform;
const axiosCanceler = new AxiosCanceler();
|
vben
authored
|
79
|
// Request interceptor configuration processing
|
|
80
|
this.axiosInstance.interceptors.request.use((config: AxiosRequestConfig) => {
|
vben
authored
|
81
|
// If cancel repeat request is turned on, then cancel repeat request is prohibited
|
|
82
83
|
// @ts-ignore
const { ignoreCancelToken } = config.requestOptions;
|
Vben
authored
|
84
85
86
87
88
89
|
const ignoreCancel =
ignoreCancelToken !== undefined
? ignoreCancelToken
: this.options.requestOptions?.ignoreCancelToken;
!ignoreCancel && axiosCanceler.addPending(config);
|
|
90
|
if (requestInterceptors && isFunction(requestInterceptors)) {
|
Vben
authored
|
91
|
config = requestInterceptors(config, this.options);
|
|
92
93
94
95
|
}
return config;
}, undefined);
|
vben
authored
|
96
|
// Request interceptor error capture
|
|
97
98
99
100
|
requestInterceptorsCatch &&
isFunction(requestInterceptorsCatch) &&
this.axiosInstance.interceptors.request.use(undefined, requestInterceptorsCatch);
|
vben
authored
|
101
|
// Response result interceptor processing
|
|
102
103
104
105
106
107
108
109
|
this.axiosInstance.interceptors.response.use((res: AxiosResponse<any>) => {
res && axiosCanceler.removePending(res.config);
if (responseInterceptors && isFunction(responseInterceptors)) {
res = responseInterceptors(res);
}
return res;
}, undefined);
|
vben
authored
|
110
|
// Response result interceptor error capture
|
|
111
112
|
responseInterceptorsCatch &&
isFunction(responseInterceptorsCatch) &&
|
|
113
114
|
this.axiosInstance.interceptors.response.use(undefined, (error) => {
// @ts-ignore
|
|
115
|
return responseInterceptorsCatch(this.axiosInstance, error);
|
|
116
|
});
|
|
117
118
|
}
|
|
119
|
/**
|
vben
authored
|
120
|
* @description: File Upload
|
|
121
122
123
|
*/
uploadFile<T = any>(config: AxiosRequestConfig, params: UploadFileParams) {
const formData = new window.FormData();
|
erniu
authored
|
124
125
126
127
128
129
130
|
const customFilename = params.name || 'file';
if (params.filename) {
formData.append(customFilename, params.file, params.filename);
} else {
formData.append(customFilename, params.file);
}
|
|
131
132
133
|
if (params.data) {
Object.keys(params.data).forEach((key) => {
|
erniu
authored
|
134
|
const value = params.data![key];
|
|
135
136
137
138
139
140
141
|
if (Array.isArray(value)) {
value.forEach((item) => {
formData.append(`${key}[]`, item);
});
return;
}
|
erniu
authored
|
142
|
formData.append(key, params.data![key]);
|
|
143
144
145
146
147
148
149
150
151
|
});
}
return this.axiosInstance.request<T>({
...config,
method: 'POST',
data: formData,
headers: {
'Content-type': ContentTypeEnum.FORM_DATA,
|
vben
authored
|
152
|
// @ts-ignore
|
|
153
154
155
156
|
ignoreCancelToken: true,
},
});
}
|
|
157
|
|
Vben
authored
|
158
159
|
// support form-data
supportFormData(config: AxiosRequestConfig) {
|
|
160
|
const headers = config.headers || this.options.headers;
|
Vben
authored
|
161
162
163
164
165
166
167
168
169
170
171
172
|
const contentType = headers?.['Content-Type'] || headers?.['content-type'];
if (
contentType !== ContentTypeEnum.FORM_URLENCODED ||
!Reflect.has(config, 'data') ||
config.method?.toUpperCase() === RequestEnum.GET
) {
return config;
}
return {
...config,
|
|
173
|
data: qs.stringify(config.data, { arrayFormat: 'brackets' }),
|
Vben
authored
|
174
175
176
|
};
}
|
Vben
authored
|
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
get<T = any>(config: AxiosRequestConfig, options?: RequestOptions): Promise<T> {
return this.request({ ...config, method: 'GET' }, options);
}
post<T = any>(config: AxiosRequestConfig, options?: RequestOptions): Promise<T> {
return this.request({ ...config, method: 'POST' }, options);
}
put<T = any>(config: AxiosRequestConfig, options?: RequestOptions): Promise<T> {
return this.request({ ...config, method: 'PUT' }, options);
}
delete<T = any>(config: AxiosRequestConfig, options?: RequestOptions): Promise<T> {
return this.request({ ...config, method: 'DELETE' }, options);
}
|
|
193
|
request<T = any>(config: AxiosRequestConfig, options?: RequestOptions): Promise<T> {
|
|
194
|
let conf: CreateAxiosOptions = cloneDeep(config);
|
|
195
|
// cancelToken 如果被深拷贝,会导致最外层无法使用cancel方法来取消请求
|
vben
authored
|
196
197
|
if (config.cancelToken) {
conf.cancelToken = config.cancelToken;
|
|
198
|
}
|
vben
authored
|
199
|
|
|
200
201
202
203
204
205
|
const transform = this.getTransform();
const { requestOptions } = this.options;
const opt: RequestOptions = Object.assign({}, requestOptions, options);
|
|
206
|
const { beforeRequestHook, requestCatchHook, transformResponseHook } = transform || {};
|
|
207
208
209
|
if (beforeRequestHook && isFunction(beforeRequestHook)) {
conf = beforeRequestHook(conf, opt);
}
|
|
210
|
conf.requestOptions = opt;
|
Vben
authored
|
211
212
|
conf = this.supportFormData(conf);
|
Vben
authored
|
213
|
|
|
214
215
216
217
|
return new Promise((resolve, reject) => {
this.axiosInstance
.request<any, AxiosResponse<Result>>(conf)
.then((res: AxiosResponse<Result>) => {
|
|
218
|
if (transformResponseHook && isFunction(transformResponseHook)) {
|
|
219
|
try {
|
|
220
|
const ret = transformResponseHook(res, opt);
|
|
221
222
223
224
|
resolve(ret);
} catch (err) {
reject(err || new Error('request error!'));
}
|
|
225
226
|
return;
}
|
|
227
|
resolve(res as unknown as Promise<T>);
|
|
228
|
})
|
|
229
|
.catch((e: Error | AxiosError) => {
|
Vben
authored
|
230
|
if (requestCatchHook && isFunction(requestCatchHook)) {
|
|
231
|
reject(requestCatchHook(e, opt));
|
|
232
233
|
return;
}
|
|
234
235
236
|
if (axios.isAxiosError(e)) {
// rewrite error message from axios in here
}
|
|
237
238
239
240
241
|
reject(e);
});
});
}
}
|