1
2
3
4
5
6
7
8
9
10
11
// axios配置 可自行根据项目进行更改,只需更改该文件即可,其他文件可以不动
// The axios configuration can be changed according to the project, just change the file, other files can be left unchanged
import type { AxiosResponse } from 'axios';
import type { CreateAxiosOptions, RequestOptions, Result } from './types';
import { VAxios } from './Axios';
import { getToken } from '/@/utils/auth';
import { AxiosTransform } from './axiosTransform';
import { checkStatus } from './checkStatus';
vben
authored
5 years ago
12
import { useGlobSetting } from '/@/hooks/setting';
13
14
15
16
17
18
import { useMessage } from '/@/hooks/web/useMessage';
import { RequestEnum, ResultEnum, ContentTypeEnum } from '/@/enums/httpEnum';
import { isString } from '/@/utils/is';
import { setObjToUrlParams, deepMerge } from '/@/utils';
vben
authored
5 years ago
19
import { errorStore } from '/@/store/modules/error';
nebv
authored
5 years ago
20
import { errorResult } from './const';
vben
authored
5 years ago
21
import { useI18n } from '/@/hooks/web/useI18n';
vben
authored
5 years ago
22
import { createNow, formatRequestDate } from './helper';
23
vben
authored
5 years ago
24
const globSetting = useGlobSetting();
25
26
27
28
29
30
31
32
33
34
35
const prefix = globSetting.urlPrefix;
const { createMessage, createErrorModal } = useMessage();
/**
* @description: 数据处理,方便区分多种处理方式
*/
const transform: AxiosTransform = {
/**
* @description: 处理请求数据
*/
transformRequestData: (res: AxiosResponse<Result>, options: RequestOptions) => {
vben
authored
5 years ago
36
const { t } = useI18n();
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
const { isTransformRequestResult } = options;
// 不进行任何处理,直接返回
// 用于页面代码可能需要直接获取code,data,message这些信息时开启
if (!isTransformRequestResult) {
return res.data;
}
// 错误的时候返回
const { data } = res;
if (!data) {
// return '[HTTP] Request has no return value';
return errorResult;
}
// 这里 code,result,message为 后台统一的字段,需要在 types.ts内修改为项目自己的接口返回格式
const { code, result, message } = data;
// 这里逻辑可以根据项目进行修改
const hasSuccess = data && Reflect.has(data, 'code') && code === ResultEnum.SUCCESS;
if (!hasSuccess) {
if (message) {
// errorMessageMode=‘modal’的时候会显示modal错误弹窗,而不是消息提示,用于一些比较重要的错误
if (options.errorMessageMode === 'modal') {
vben
authored
5 years ago
59
createErrorModal({ title: t('sys.api.errorTip'), content: message });
vben
authored
5 years ago
60
} else if (options.errorMessageMode === 'message') {
61
62
63
64
65
66
67
68
69
createMessage.error(message);
}
}
Promise.reject(new Error(message));
return errorResult;
}
// 接口请求成功,直接返回结果
if (code === ResultEnum.SUCCESS) {
nebv
authored
5 years ago
70
return result;
71
72
73
74
75
76
77
}
// 接口请求错误,统一提示错误信息
if (code === ResultEnum.ERROR) {
if (message) {
createMessage.error(data.message);
Promise.reject(new Error(message));
} else {
vben
authored
5 years ago
78
const msg = t('sys.api.errorMessage');
79
80
81
82
83
84
85
createMessage.error(msg);
Promise.reject(new Error(msg));
}
return errorResult;
}
// 登录超时
if (code === ResultEnum.TIMEOUT) {
vben
authored
5 years ago
86
const timeoutMsg = t('sys.api.timeoutMessage');
87
createErrorModal({
vben
authored
5 years ago
88
title: t('sys.api.operationFailed'),
89
90
91
92
93
94
95
96
97
98
content: timeoutMsg,
});
Promise.reject(new Error(timeoutMsg));
return errorResult;
}
return errorResult;
},
// 请求之前处理config
beforeRequestHook: (config, options) => {
vben
authored
5 years ago
99
const { apiUrl, joinPrefix, joinParamsToUrl, formatDate, joinTime = true } = options;
100
101
102
103
104
105
106
107
if (joinPrefix) {
config.url = `${prefix}${config.url}`;
}
if (apiUrl && isString(apiUrl)) {
config.url = `${apiUrl}${config.url}`;
}
vben
authored
5 years ago
108
if (config.method?.toUpperCase() === RequestEnum.GET) {
109
110
111
if (!isString(config.params)) {
config.data = {
// 给 get 请求加上时间戳参数,避免从缓存中拿数据。
vben
authored
5 years ago
112
params: Object.assign(config.params || {}, createNow(joinTime, false)),
113
114
115
};
} else {
// 兼容restful风格
vben
authored
5 years ago
116
config.url = config.url + config.params + `${createNow(joinTime, true)}`;
vben
authored
5 years ago
117
config.params = undefined;
118
119
120
121
122
}
} else {
if (!isString(config.params)) {
formatDate && formatRequestDate(config.params);
config.data = config.params;
vben
authored
5 years ago
123
config.params = undefined;
124
125
126
127
128
129
if (joinParamsToUrl) {
config.url = setObjToUrlParams(config.url as string, config.data);
}
} else {
// 兼容restful风格
config.url = config.url + config.params;
vben
authored
5 years ago
130
config.params = undefined;
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
}
}
return config;
},
/**
* @description: 请求拦截器处理
*/
requestInterceptors: (config) => {
// 请求之前处理config
const token = getToken();
if (token) {
// jwt token
config.headers.Authorization = token;
}
return config;
},
/**
* @description: 响应错误处理
*/
responseInterceptorsCatch: (error: any) => {
vben
authored
5 years ago
153
const { t } = useI18n();
vben
authored
5 years ago
154
errorStore.setupErrorHandle(error);
155
const { response, code, message } = error || {};
vben
authored
5 years ago
156
157
const msg: string = response?.data?.error ? response.data.error.message : '';
const err: string = error?.toString();
158
159
try {
if (code === 'ECONNABORTED' && message.indexOf('timeout') !== -1) {
vben
authored
5 years ago
160
createMessage.error(t('sys.api.apiTimeoutMessage'));
161
}
vben
authored
5 years ago
162
if (err?.includes('Network Error')) {
163
createErrorModal({
vben
authored
5 years ago
164
165
title: t('sys.api.networkException'),
content: t('sys.api.networkExceptionMsg'),
166
167
168
169
170
});
}
} catch (error) {
throw new Error(error);
}
vben
authored
5 years ago
171
checkStatus(error?.response?.status, msg);
vben
authored
5 years ago
172
return Promise.reject(error);
173
174
175
176
177
178
179
180
181
182
183
184
185
},
};
function createAxios(opt?: Partial<CreateAxiosOptions>) {
return new VAxios(
deepMerge(
{
timeout: 10 * 1000,
// 基础接口地址
// baseURL: globSetting.apiUrl,
// 接口可能会有通用的地址部分,可以统一抽取出来
prefixUrl: prefix,
headers: { 'Content-Type': ContentTypeEnum.JSON },
vben
authored
5 years ago
186
187
// 如果是form-data格式
// headers: { 'Content-Type': ContentTypeEnum.FORM_URLENCODED },
188
189
190
191
192
193
194
195
196
197
198
199
200
// 数据处理方式
transform,
// 配置项,下面的选项都可以在独立的接口请求中覆盖
requestOptions: {
// 默认将prefix 添加到url
joinPrefix: true,
// 需要对返回数据进行处理
isTransformRequestResult: true,
// post请求的时候添加参数到url
joinParamsToUrl: false,
// 格式化提交参数时间
formatDate: true,
// 消息提示类型
vben
authored
5 years ago
201
errorMessageMode: 'message',
202
203
// 接口地址
apiUrl: globSetting.apiUrl,
vben
authored
5 years ago
204
205
// 是否加入时间戳
joinTime: true,
206
207
208
209
210
211
212
213
214
215
216
217
218
219
},
},
opt || {}
)
);
}
export const defHttp = createAxios();
// other api url
// export const otherHttp = createAxios({
// requestOptions: {
// apiUrl: 'xxx',
// },
// });