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