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