|
1
|
import type { AxiosRequestConfig, AxiosInstance, AxiosResponse } from 'axios';
|
Vben
authored
|
2
|
import type { RequestOptions, Result, UploadFileParams } from '../../../../types/axios';
|
Vben
authored
|
3
|
import type { CreateAxiosOptions } from './axiosTransform';
|
|
4
|
import axios from 'axios';
|
Vben
authored
|
5
|
import qs from 'qs';
|
|
6
7
8
|
import { AxiosCanceler } from './axiosCancel';
import { isFunction } from '/@/utils/is';
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
|
headers: { ignoreCancelToken },
|
vben
authored
|
85
|
} = config;
|
Vben
authored
|
86
87
88
89
90
91
92
|
const ignoreCancel =
ignoreCancelToken !== undefined
? ignoreCancelToken
: this.options.requestOptions?.ignoreCancelToken;
!ignoreCancel && axiosCanceler.addPending(config);
|
|
93
|
if (requestInterceptors && isFunction(requestInterceptors)) {
|
Vben
authored
|
94
|
config = requestInterceptors(config, this.options);
|
|
95
96
97
98
|
}
return config;
}, undefined);
|
vben
authored
|
99
|
// Request interceptor error capture
|
|
100
101
102
103
|
requestInterceptorsCatch &&
isFunction(requestInterceptorsCatch) &&
this.axiosInstance.interceptors.request.use(undefined, requestInterceptorsCatch);
|
vben
authored
|
104
|
// Response result interceptor processing
|
|
105
106
107
108
109
110
111
112
|
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
|
113
|
// Response result interceptor error capture
|
|
114
115
116
117
118
|
responseInterceptorsCatch &&
isFunction(responseInterceptorsCatch) &&
this.axiosInstance.interceptors.response.use(undefined, responseInterceptorsCatch);
}
|
|
119
|
/**
|
vben
authored
|
120
|
* @description: File Upload
|
|
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
*/
uploadFile<T = any>(config: AxiosRequestConfig, params: UploadFileParams) {
const formData = new window.FormData();
if (params.data) {
Object.keys(params.data).forEach((key) => {
if (!params.data) return;
const value = params.data[key];
if (Array.isArray(value)) {
value.forEach((item) => {
formData.append(`${key}[]`, item);
});
return;
}
formData.append(key, params.data[key]);
});
}
formData.append(params.name || 'file', params.file, params.filename);
return this.axiosInstance.request<T>({
...config,
method: 'POST',
data: formData,
headers: {
'Content-type': ContentTypeEnum.FORM_DATA,
ignoreCancelToken: true,
},
});
}
|
|
152
|
|
Vben
authored
|
153
154
|
// support form-data
supportFormData(config: AxiosRequestConfig) {
|
|
155
|
const headers = config.headers || this.options.headers;
|
Vben
authored
|
156
157
158
159
160
161
162
163
164
165
166
167
|
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,
|
|
168
|
data: qs.stringify(config.data, { arrayFormat: 'brackets' }),
|
Vben
authored
|
169
170
171
|
};
}
|
Vben
authored
|
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
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);
}
|
|
188
|
request<T = any>(config: AxiosRequestConfig, options?: RequestOptions): Promise<T> {
|
|
189
|
let conf: CreateAxiosOptions = cloneDeep(config);
|
|
190
191
192
193
194
195
|
const transform = this.getTransform();
const { requestOptions } = this.options;
const opt: RequestOptions = Object.assign({}, requestOptions, options);
|
Vben
authored
|
196
|
const { beforeRequestHook, requestCatchHook, transformRequestHook } = transform || {};
|
|
197
198
199
|
if (beforeRequestHook && isFunction(beforeRequestHook)) {
conf = beforeRequestHook(conf, opt);
}
|
|
200
|
conf.requestOptions = opt;
|
Vben
authored
|
201
202
|
conf = this.supportFormData(conf);
|
Vben
authored
|
203
|
|
|
204
205
206
207
|
return new Promise((resolve, reject) => {
this.axiosInstance
.request<any, AxiosResponse<Result>>(conf)
.then((res: AxiosResponse<Result>) => {
|
Vben
authored
|
208
|
if (transformRequestHook && isFunction(transformRequestHook)) {
|
|
209
210
211
212
213
214
|
try {
const ret = transformRequestHook(res, opt);
resolve(ret);
} catch (err) {
reject(err || new Error('request error!'));
}
|
|
215
216
|
return;
}
|
|
217
|
resolve(res as unknown as Promise<T>);
|
|
218
219
|
})
.catch((e: Error) => {
|
Vben
authored
|
220
|
if (requestCatchHook && isFunction(requestCatchHook)) {
|
|
221
|
reject(requestCatchHook(e, opt));
|
|
222
223
224
225
226
227
228
|
return;
}
reject(e);
});
});
}
}
|