Blame view

src/utils/http/axios/index.ts 7.87 KB
陈文彬 authored
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';
5
import type { RequestOptions, Result } from '/#/axios';
6
7
import type { AxiosTransform, CreateAxiosOptions } from './axiosTransform';
import { VAxios } from './Axios';
陈文彬 authored
8
import { checkStatus } from './checkStatus';
vben authored
9
import { useGlobSetting } from '/@/hooks/setting';
陈文彬 authored
10
11
12
import { useMessage } from '/@/hooks/web/useMessage';
import { RequestEnum, ResultEnum, ContentTypeEnum } from '/@/enums/httpEnum';
import { isString } from '/@/utils/is';
13
import { getToken } from '/@/utils/auth';
陈文彬 authored
14
import { setObjToUrlParams, deepMerge } from '/@/utils';
Vben authored
15
import { useErrorLogStoreWithOut } from '/@/store/modules/errorLog';
vben authored
16
import { useI18n } from '/@/hooks/web/useI18n';
17
import { joinTimestamp, formatRequestDate } from './helper';
陈文彬 authored
18
vben authored
19
const globSetting = useGlobSetting();
20
const urlPrefix = globSetting.urlPrefix;
陈文彬 authored
21
22
23
24
25
26
27
const { createMessage, createErrorModal } = useMessage();

/**
 * @description: 数据处理,方便区分多种处理方式
 */
const transform: AxiosTransform = {
  /**
28
   * @description: 处理请求数据。如果数据不是预期格式,可直接抛出错误
陈文彬 authored
29
   */
Vben authored
30
  transformRequestHook: (res: AxiosResponse<Result>, options: RequestOptions) => {
31
    const { t } = useI18n();
32
    const { isTransformResponse, isReturnNativeResponse } = options;
33
34
35
36
    // 是否返回原生响应头 比如:需要获取响应头时使用该属性
    if (isReturnNativeResponse) {
      return res;
    }
陈文彬 authored
37
38
    // 不进行任何处理,直接返回
    // 用于页面代码可能需要直接获取code,data,message这些信息时开启
39
    if (!isTransformResponse) {
陈文彬 authored
40
41
42
43
44
45
46
      return res.data;
    }
    // 错误的时候返回

    const { data } = res;
    if (!data) {
      // return '[HTTP] Request has no return value';
47
      throw new Error(t('sys.api.apiRequestFailed'));
陈文彬 authored
48
49
50
51
52
53
    }
    //  这里 code,result,message为 后台统一的字段,需要在 types.ts内修改为项目自己的接口返回格式
    const { code, result, message } = data;

    // 这里逻辑可以根据项目进行修改
    const hasSuccess = data && Reflect.has(data, 'code') && code === ResultEnum.SUCCESS;
54
    if (hasSuccess) {
55
      return result;
陈文彬 authored
56
    }
57
58
59

    // 在此处根据自己项目的实际情况对不同的code执行不同的操作
    // 如果不希望中断当前请求,请return数据,否则直接抛出异常即可
60
    let timeoutMsg = '';
61
62
    switch (code) {
      case ResultEnum.TIMEOUT:
63
        timeoutMsg = t('sys.api.timeoutMessage');
64
65
      default:
        if (message) {
66
          timeoutMsg = message;
67
        }
陈文彬 authored
68
    }
69
70
71
72
73
74
75
76
77
78

    // errorMessageMode=‘modal’的时候会显示modal错误弹窗,而不是消息提示,用于一些比较重要的错误
    // errorMessageMode='none' 一般是调用时明确表示不希望自动弹出错误提示
    if (options.errorMessageMode === 'modal') {
      createErrorModal({ title: t('sys.api.errorTip'), content: timeoutMsg });
    } else if (options.errorMessageMode === 'message') {
      createMessage.error(timeoutMsg);
    }

    throw new Error(timeoutMsg || t('sys.api.apiRequestFailed'));
陈文彬 authored
79
80
81
82
  },

  // 请求之前处理config
  beforeRequestHook: (config, options) => {
vben authored
83
    const { apiUrl, joinPrefix, joinParamsToUrl, formatDate, joinTime = true } = options;
陈文彬 authored
84
85

    if (joinPrefix) {
86
      config.url = `${urlPrefix}${config.url}`;
陈文彬 authored
87
88
89
90
91
    }

    if (apiUrl && isString(apiUrl)) {
      config.url = `${apiUrl}${config.url}`;
    }
92
    const params = config.params || {};
93
    if (config.method?.toUpperCase() === RequestEnum.GET) {
94
      if (!isString(params)) {
95
        // 给 get 请求加上时间戳参数,避免从缓存中拿数据。
96
        config.params = Object.assign(params || {}, joinTimestamp(joinTime, false));
陈文彬 authored
97
98
      } else {
        // 兼容restful风格
99
        config.url = config.url + params + `${joinTimestamp(joinTime, true)}`;
100
        config.params = undefined;
陈文彬 authored
101
102
      }
    } else {
103
104
105
      if (!isString(params)) {
        formatDate && formatRequestDate(params);
        config.data = params;
106
        config.params = undefined;
陈文彬 authored
107
108
109
110
111
        if (joinParamsToUrl) {
          config.url = setObjToUrlParams(config.url as string, config.data);
        }
      } else {
        // 兼容restful风格
112
        config.url = config.url + params;
113
        config.params = undefined;
陈文彬 authored
114
115
116
117
118
119
120
121
      }
    }
    return config;
  },

  /**
   * @description: 请求拦截器处理
   */
122
  requestInterceptors: (config, options) => {
陈文彬 authored
123
    // 请求之前处理config
124
    const token = getToken();
陈文彬 authored
125
126
    if (token) {
      // jwt token
127
128
129
      config.headers.Authorization = options.authenticationScheme
        ? `${options.authenticationScheme} ${token}`
        : token;
陈文彬 authored
130
131
132
133
134
    }
    return config;
  },

  /**
135
136
137
138
139
140
141
   * @description: 响应拦截器处理
   */
  responseInterceptors: (res: AxiosResponse<any>) => {
    return res;
  },

  /**
陈文彬 authored
142
143
144
   * @description: 响应错误处理
   */
  responseInterceptorsCatch: (error: any) => {
145
    const { t } = useI18n();
Vben authored
146
147
    const errorLogStore = useErrorLogStoreWithOut();
    errorLogStore.addAjaxErrorInfo(error);
148
149
    const { response, code, message, config } = error || {};
    const errorMessageMode = config?.requestOptions?.errorMessageMode || 'none';
150
151
    const msg: string = response?.data?.error?.message ?? '';
    const err: string = error?.toString?.() ?? '';
152
153
    let errMessage = '';
陈文彬 authored
154
155
    try {
      if (code === 'ECONNABORTED' && message.indexOf('timeout') !== -1) {
156
        errMessage = t('sys.api.apiTimeoutMessage');
陈文彬 authored
157
      }
158
      if (err?.includes('Network Error')) {
159
160
161
162
163
164
165
166
167
168
        errMessage = t('sys.api.networkExceptionMsg');
      }

      if (errMessage) {
        if (errorMessageMode === 'modal') {
          createErrorModal({ title: t('sys.api.errorTip'), content: errMessage });
        } else if (errorMessageMode === 'message') {
          createMessage.error(errMessage);
        }
        return Promise.reject(error);
陈文彬 authored
169
170
171
172
      }
    } catch (error) {
      throw new Error(error);
    }
173
174

    checkStatus(error?.response?.status, msg, errorMessageMode);
175
    return Promise.reject(error);
陈文彬 authored
176
177
178
179
180
181
182
  },
};

function createAxios(opt?: Partial<CreateAxiosOptions>) {
  return new VAxios(
    deepMerge(
      {
183
184
185
186
        // See https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#authentication_schemes
        // authentication schemes,e.g: Bearer
        // authenticationScheme: 'Bearer',
        authenticationScheme: '',
陈文彬 authored
187
188
        timeout: 10 * 1000,
        // 基础接口地址
189
        // baseURL: globSetting.apiUrl,
陈文彬 authored
190
        // 接口可能会有通用的地址部分,可以统一抽取出来
191
        urlPrefix: urlPrefix,
陈文彬 authored
192
        headers: { 'Content-Type': ContentTypeEnum.JSON },
vben authored
193
194
        // 如果是form-data格式
        // headers: { 'Content-Type': ContentTypeEnum.FORM_URLENCODED },
陈文彬 authored
195
196
197
198
199
200
        // 数据处理方式
        transform,
        // 配置项,下面的选项都可以在独立的接口请求中覆盖
        requestOptions: {
          // 默认将prefix 添加到url
          joinPrefix: true,
201
202
          // 是否返回原生响应头 比如:需要获取响应头时使用该属性
          isReturnNativeResponse: false,
陈文彬 authored
203
          // 需要对返回数据进行处理
204
          isTransformResponse: true,
陈文彬 authored
205
206
207
208
209
          // post请求的时候添加参数到url
          joinParamsToUrl: false,
          // 格式化提交参数时间
          formatDate: true,
          // 消息提示类型
210
          errorMessageMode: 'message',
陈文彬 authored
211
212
          // 接口地址
          apiUrl: globSetting.apiUrl,
vben authored
213
214
          //  是否加入时间戳
          joinTime: true,
Vben authored
215
216
          // 忽略重复请求
          ignoreCancelToken: true,
陈文彬 authored
217
218
219
220
221
222
223
224
225
226
227
228
229
230
        },
      },
      opt || {}
    )
  );
}
export const defHttp = createAxios();

// other api url
// export const otherHttp = createAxios({
//   requestOptions: {
//     apiUrl: 'xxx',
//   },
// });