1
2
3
4
5
6
7
import type { AxiosRequestConfig, AxiosInstance, AxiosResponse } from 'axios';
import axios from 'axios';
import { AxiosCanceler } from './axiosCancel';
import { isFunction } from '/@/utils/is';
import { cloneDeep } from 'lodash-es';
8
import type { RequestOptions, CreateAxiosOptions, Result, UploadFileParams } from './types';
nebv
authored
5 years ago
9
import { errorResult } from './const';
10
import { ContentTypeEnum } from '/@/enums/httpEnum';
11
12
13
14
export * from './axiosTransform';
/**
vben
authored
4 years ago
15
* @description: axios module
16
17
18
*/
export class VAxios {
private axiosInstance: AxiosInstance;
vben
authored
5 years ago
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
4 years ago
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
4 years ago
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
4 years ago
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
4 years ago
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
4 years ago
80
// Request interceptor configuration processing
81
this.axiosInstance.interceptors.request.use((config: AxiosRequestConfig) => {
vben
authored
5 years ago
82
// If cancel repeat request is turned on, then cancel repeat request is prohibited
vben
authored
4 years ago
83
84
85
const {
headers: { ignoreCancelToken = false },
} = config;
86
87
88
89
90
91
92
!ignoreCancelToken && axiosCanceler.addPending(config);
if (requestInterceptors && isFunction(requestInterceptors)) {
config = requestInterceptors(config);
}
return config;
}, undefined);
vben
authored
4 years ago
93
// Request interceptor error capture
94
95
96
97
requestInterceptorsCatch &&
isFunction(requestInterceptorsCatch) &&
this.axiosInstance.interceptors.request.use(undefined, requestInterceptorsCatch);
vben
authored
4 years ago
98
// Response result interceptor processing
99
100
101
102
103
104
105
106
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
4 years ago
107
// Response result interceptor error capture
108
109
110
111
112
responseInterceptorsCatch &&
isFunction(responseInterceptorsCatch) &&
this.axiosInstance.interceptors.response.use(undefined, responseInterceptorsCatch);
}
113
/**
vben
authored
4 years ago
114
* @description: File Upload
115
116
117
118
119
120
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
*/
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,
},
});
}
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
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);
const { beforeRequestHook, requestCatch, transformRequestData } = transform || {};
if (beforeRequestHook && isFunction(beforeRequestHook)) {
conf = beforeRequestHook(conf, opt);
}
return new Promise((resolve, reject) => {
this.axiosInstance
.request<any, AxiosResponse<Result>>(conf)
.then((res: AxiosResponse<Result>) => {
if (transformRequestData && isFunction(transformRequestData)) {
const ret = transformRequestData(res, opt);
nebv
authored
5 years ago
165
ret !== errorResult ? resolve(ret) : reject(new Error('request error!'));
166
167
168
169
170
171
172
173
174
175
176
177
178
179
return;
}
resolve((res as unknown) as Promise<T>);
})
.catch((e: Error) => {
if (requestCatch && isFunction(requestCatch)) {
reject(requestCatch(e));
return;
}
reject(e);
});
});
}
}