-
Notifications
You must be signed in to change notification settings - Fork 59
/
index.js
313 lines (286 loc) · 10.6 KB
/
index.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
import axios from 'axios';
import merge from 'lodash/merge';
import validator from './validator';
import { ERROR_MESSAGE_MAPS, REQUEST_TYPE } from './const';
import { isFunction, inBrowser } from './util';
export const originalAxios = axios;
export default class VeryAxios {
constructor(options = {}, axiosConfig = {}) {
if (validator(options)) return;
const {
// whether or not show tips when error ocurrs
tip = true,
// how to show tips
tipFn,
errorHandlers = {
// support 400/401/403/404/405/413/414/500/502/504/any other cutom errorno
},
// error msg language: 'zh-cn'/'en'
lang = 'zh-cn',
// some operation before request send
beforeHook,
// some operation after response is recieved
afterHook,
// function to get errno in response
getResStatus,
// function to get err message in response
getResErrMsg,
// function to get data in response
getResData,
// function to validate res status, true is success
validateStatus,
// whether to cancel a duplicated request
cancelDuplicated = false,
// how to generate the duplicated key
duplicatedKeyFn,
} = options;
// stores the identity and cancellation function for each request
this.pendingAjax = new Map();
this.tip = tip && isFunction(tipFn);
this.tipFn = tipFn;
this.errorHandlers = errorHandlers;
this.lang = lang;
this.cancelDuplicated = cancelDuplicated;
// these follow options cannot valid by JSON schema
// if option is not a function, set as the default value
this.beforeHook = isFunction(beforeHook) ? beforeHook : () => {};
this.afterHook = isFunction(afterHook) ? afterHook : () => {};
this.getResStatus = isFunction(getResStatus) ? getResStatus : (res) => res.errno;
this.getResErrMsg = isFunction(getResErrMsg) ? getResErrMsg : (res) => res.errmsg;
this.getResData = isFunction(getResData) ? getResData : (res) => res.data;
this.duplicatedKeyFn = isFunction(duplicatedKeyFn) ? duplicatedKeyFn : (config) => `${config.method}${config.url}`;
const defaultValidateStatus = (status) => status === 0 || (status >= 200 && status < 300);
this.validateStatus = isFunction(validateStatus) ? validateStatus : defaultValidateStatus;
// default axios config
this.defaultAxiosConfig = {
timeout: 20000,
responseType: 'json',
headers: {
'content-type': 'application/json',
},
};
this.config = merge(this.defaultAxiosConfig, axiosConfig);
this.createAxios();
this.interceptors();
}
createAxios() {
this.axios = axios.create(this.config);
}
interceptors() {
// intercept response
this.axios.interceptors.request.use((config) => {
// check the previous request for cancellation before the request starts
this.removePendingAjax(config);
// add the current request to pendingAjax
this.addPendingAjax(config);
const { veryConfig: { disableHooks, disableTip } = {} } = config;
const disableBefore = disableHooks === true || (disableHooks && disableHooks.before);
if (!disableBefore) {
try {
this.beforeHook(config);
} catch (e) {
const message = `beforeHook内部错误:${e.message}`;
if (this.tip && !disableTip) this.tipFn(message);
// 和response不一样,无需返回一个promise
}
}
return config;
});
// intercept response
this.axios.interceptors.response.use(
// success handler
// Any status code that lie within the range of 2xx cause this function to trigger
(res) => {
this.removePendingAjax(res.config);
const { config: { veryConfig: { disableHooks, disableTip } = {} } } = res;
const disableAfter = disableHooks === true || (disableHooks && disableHooks.after);
if (!disableAfter) {
try {
this.afterHook(res);
} catch (e) {
const message = `afterHook内部错误:${e.message}`;
if (this.tip && !disableTip) this.tipFn(message);
return Promise.reject(message);
}
}
return new Promise((resolve, reject) => {
if (!res || !res.data) resolve();
const resData = res.data;
const status = +this.getResStatus(resData);
if (!this.validateStatus(status)) {
const errmsgMaps = ERROR_MESSAGE_MAPS[this.lang];
const message = this.getResErrMsg(resData) || errmsgMaps[status] || errmsgMaps.DEFAULT;
if (this.tip && !disableTip) this.tipFn(message);
const errorHandler = this.errorHandlers[status];
if (isFunction(errorHandler)) errorHandler();
reject(message);
}
const data = this.getResData(resData);
return resolve(data);
});
},
// error handler
// Any status codes that falls outside the range of 2xx cause this function to trigger
(error) => {
const config = error.config || {};
// when erroe is requested, remove the request
this.removePendingAjax(config);
const { veryConfig: { disableHooks, disableTip } = {} } = config;
const disableAfter = disableHooks === true || (disableHooks && disableHooks.after);
if (!disableAfter) {
try {
this.afterHook(error, true);
} catch (e) {
const message = `afterHook内部错误:${e.message}`;
if (this.tip && !disableTip) this.tipFn(message);
return Promise.reject(message);
}
}
const errmsgMaps = ERROR_MESSAGE_MAPS[this.lang];
let errmsg = errmsgMaps.DEFAULT;
if (error.response) {
// The request was made and the server responded with a status code
// that falls out of the range of 2xx
const { status } = error.response;
// TODO:临时去除window
// if (inBrowser && !window.navigator.onLine) errmsg = errmsgMaps.OFFLINE;
// else
errmsg = errmsgMaps[status] || error.message;
// run relative error handler
const errorHandler = this.errorHandlers[status];
if (isFunction(errorHandler)) errorHandler();
} else if (error.request) {
// The request was made but no response was received
// `error.request` is an instance of XMLHttpRequest in the browser and an instance of
// http.ClientRequest in node.js
// return value is a error instance
errmsg = error.message;
} else {
// Something happened in setting up the request that triggered an Error
errmsg = error.message;
}
// whether is the type of duplicated request
let isDuplicatedType;
try {
const errorType = (JSON.parse(error.message) || {}).type;
isDuplicatedType = errorType === REQUEST_TYPE.DUPLICATED_REQUEST;
} catch (e) {
isDuplicatedType = false;
}
if (isDuplicatedType) return Promise.reject(errmsgMaps.DUPLICATED_CANCELED);
if (this.tip && !disableTip) this.tipFn(errmsg);
return Promise.reject(errmsg);
},
);
}
/**
* add request to pendingAjax
* @param {Object} config
*/
addPendingAjax(config) {
// if need cancel duplicated request
if (!this.cancelDuplicated) return;
const veryConfig = config.veryConfig || {};
const duplicatedKey = JSON.stringify({
duplicatedKey: veryConfig.duplicatedKey || this.duplicatedKeyFn(config),
type: REQUEST_TYPE.DUPLICATED_REQUEST,
});
config.cancelToken = config.cancelToken || new axios.CancelToken((cancel) => {
// if the current request does not exist in pendingAjax, add it
if (duplicatedKey && !this.pendingAjax.has(duplicatedKey)) {
this.pendingAjax.set(duplicatedKey, cancel);
}
});
}
/**
* remove the request in pendingAjax
* @param {Object} config
*/
removePendingAjax(config) {
// if need cancel duplicated request
if (!this.cancelDuplicated) return;
const veryConfig = config.veryConfig || {};
const duplicatedKey = JSON.stringify({
duplicatedKey: veryConfig.duplicatedKey || this.duplicatedKeyFn(config),
type: REQUEST_TYPE.DUPLICATED_REQUEST,
});
// if the current request exists in pendingAjax, cancel the current request and remove it
if (duplicatedKey && this.pendingAjax.has(duplicatedKey)) {
const cancel = this.pendingAjax.get(duplicatedKey);
cancel(duplicatedKey);
this.pendingAjax.delete(duplicatedKey);
}
}
/**
*
* @param {String} type [request type]
* @param {String} path [request url path]
* @param {Object} param [request params]
*/
fetch(type, path, param = {}, config = {}) {
return new Promise((resolve, reject) => {
this.axios[type](path, param, config)
.then((response) => resolve(response))
.catch((err) => reject(err));
});
}
/**
*
* @param {String} path [request url path]
* @param {Object} param [request params]
* @param {Object} config [axios and very-axios config]
*/
GET(path, param = {}, config = {}) {
return this.fetch('get', path, { params: param, ...config });
}
/**
*
* @param {String} path [request url path]
* @param {Object} param [request params]
* @param {Object} config [axios and very-axios config]
*/
POST(path, param = {}, config = {}) {
return this.fetch('post', path, param, config);
}
/**
*
* @param {String} path [request url path]
* @param {Object} param [request params]
* @param {Object} config [axios and very-axios config]
*/
PUT(path, param = {}, config = {}) {
return this.fetch('put', path, param, config);
}
/**
*
* @param {String} path [request url path]
* @param {Object} param [request params]
* @param {Object} config [axios and very-axios config]
*/
DELETE(path, param = {}, config = {}) {
return this.fetch('delete', path, param, config);
}
/**
* 上传表单方法
* @param {*} path
* @param {*} params
* @param {Object} config [axios and very-axios config]
*/
FORMDATA(path, params, config = {}) {
const formdata = new FormData();
Object.keys(params).forEach((key) => {
formdata.append(key, params[key]);
});
const defaultFormDataConfig = {
method: 'post',
data: formdata,
headers: {
'content-type': 'multipart/form-data;charset=UTF-8',
},
};
return new Promise((resolve, reject) => {
this.axios(path, merge(defaultFormDataConfig, config)).then((response) => resolve(response))
.catch((err) => reject(err));
});
}
}