|
1
|
import type { AxiosRequestConfig, AxiosInstance, AxiosResponse } from 'axios';
|
Vben
authored
|
2
3
|
import type { RequestOptions, Result, UploadFileParams } from './types';
import type { CreateAxiosOptions } from './axiosTransform';
|
|
4
5
|
import axios from 'axios';
|
Vben
authored
|
6
|
import qs from 'qs';
|
|
7
8
9
10
|
import { AxiosCanceler } from './axiosCancel';
import { isFunction } from '/@/utils/is';
import { cloneDeep } from 'lodash-es';
|
nebv
authored
|
11
|
import { errorResult } from './const';
|
|
12
|
import { ContentTypeEnum } from '/@/enums/httpEnum';
|
Vben
authored
|
13
|
import { RequestEnum } from '../../../enums/httpEnum';
|
|
14
15
16
17
|
export * from './axiosTransform';
/**
|
vben
authored
|
18
|
* @description: axios module
|
|
19
20
21
|
*/
export class VAxios {
private axiosInstance: AxiosInstance;
|
vben
authored
|
22
|
private readonly options: CreateAxiosOptions;
|
|
23
24
25
26
27
28
29
30
|
constructor(options: CreateAxiosOptions) {
this.options = options;
this.axiosInstance = axios.create(options);
this.setupInterceptors();
}
/**
|
vben
authored
|
31
|
* @description: Create axios instance
|
|
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
|
*/
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
|
47
|
* @description: Reconfigure axios
|
|
48
49
50
51
52
53
54
55
56
|
*/
configAxios(config: CreateAxiosOptions) {
if (!this.axiosInstance) {
return;
}
this.createAxios(config);
}
/**
|
vben
authored
|
57
|
* @description: Set general header
|
|
58
59
60
61
62
63
64
65
66
|
*/
setHeader(headers: any): void {
if (!this.axiosInstance) {
return;
}
Object.assign(this.axiosInstance.defaults.headers, headers);
}
/**
|
vben
authored
|
67
|
* @description: Interceptor configuration
|
|
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
*/
private setupInterceptors() {
const transform = this.getTransform();
if (!transform) {
return;
}
const {
requestInterceptors,
requestInterceptorsCatch,
responseInterceptors,
responseInterceptorsCatch,
} = transform;
const axiosCanceler = new AxiosCanceler();
|
vben
authored
|
83
|
// Request interceptor configuration processing
|
|
84
|
this.axiosInstance.interceptors.request.use((config: AxiosRequestConfig) => {
|
vben
authored
|
85
|
// If cancel repeat request is turned on, then cancel repeat request is prohibited
|
vben
authored
|
86
|
const {
|
Vben
authored
|
87
|
headers: { ignoreCancelToken },
|
vben
authored
|
88
|
} = config;
|
Vben
authored
|
89
90
91
92
93
94
95
|
const ignoreCancel =
ignoreCancelToken !== undefined
? ignoreCancelToken
: this.options.requestOptions?.ignoreCancelToken;
!ignoreCancel && axiosCanceler.addPending(config);
|
|
96
97
98
99
100
101
|
if (requestInterceptors && isFunction(requestInterceptors)) {
config = requestInterceptors(config);
}
return config;
}, undefined);
|
vben
authored
|
102
|
// Request interceptor error capture
|
|
103
104
105
106
|
requestInterceptorsCatch &&
isFunction(requestInterceptorsCatch) &&
this.axiosInstance.interceptors.request.use(undefined, requestInterceptorsCatch);
|
vben
authored
|
107
|
// Response result interceptor processing
|
|
108
109
110
111
112
113
114
115
|
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
|
116
|
// Response result interceptor error capture
|
|
117
118
119
120
121
|
responseInterceptorsCatch &&
isFunction(responseInterceptorsCatch) &&
this.axiosInstance.interceptors.response.use(undefined, responseInterceptorsCatch);
}
|
|
122
|
/**
|
vben
authored
|
123
|
* @description: File Upload
|
|
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
152
153
154
|
*/
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,
},
});
}
|
|
155
|
|
Vben
authored
|
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
// support form-data
supportFormData(config: AxiosRequestConfig) {
const headers = this.options?.headers;
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,
data: qs.stringify(config.data),
};
}
|
Vben
authored
|
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
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);
}
|
|
191
192
193
194
195
196
197
198
|
request<T = any>(config: AxiosRequestConfig, options?: RequestOptions): Promise<T> {
let conf: AxiosRequestConfig = cloneDeep(config);
const transform = this.getTransform();
const { requestOptions } = this.options;
const opt: RequestOptions = Object.assign({}, requestOptions, options);
|
Vben
authored
|
199
|
const { beforeRequestHook, requestCatchHook, transformRequestHook } = transform || {};
|
|
200
201
202
|
if (beforeRequestHook && isFunction(beforeRequestHook)) {
conf = beforeRequestHook(conf, opt);
}
|
Vben
authored
|
203
204
|
conf = this.supportFormData(conf);
|
Vben
authored
|
205
|
|
|
206
207
208
209
|
return new Promise((resolve, reject) => {
this.axiosInstance
.request<any, AxiosResponse<Result>>(conf)
.then((res: AxiosResponse<Result>) => {
|
Vben
authored
|
210
211
|
if (transformRequestHook && isFunction(transformRequestHook)) {
const ret = transformRequestHook(res, opt);
|
nebv
authored
|
212
|
ret !== errorResult ? resolve(ret) : reject(new Error('request error!'));
|
|
213
214
215
216
217
|
return;
}
resolve((res as unknown) as Promise<T>);
})
.catch((e: Error) => {
|
Vben
authored
|
218
219
|
if (requestCatchHook && isFunction(requestCatchHook)) {
reject(requestCatchHook(e));
|
|
220
221
222
223
224
225
226
|
return;
}
reject(e);
});
});
}
}
|