Blame view

src/utils/http/axios/Axios.ts 6.55 KB
陈文彬 authored
1
import type { AxiosRequestConfig, AxiosInstance, AxiosResponse } from 'axios';
2
import type { RequestOptions, Result, UploadFileParams } from '../../../../types/axios';
Vben authored
3
import type { CreateAxiosOptions } from './axiosTransform';
陈文彬 authored
4
import axios from 'axios';
Vben authored
5
import qs from 'qs';
陈文彬 authored
6
7
8
import { AxiosCanceler } from './axiosCancel';
import { isFunction } from '/@/utils/is';
import { cloneDeep } from 'lodash-es';
jq authored
9
import { ContentTypeEnum } from '/@/enums/httpEnum';
10
import { RequestEnum } from '/@/enums/httpEnum';
陈文彬 authored
11
12
13
14

export * from './axiosTransform';

/**
15
 * @description:  axios module
陈文彬 authored
16
17
18
 */
export class VAxios {
  private axiosInstance: AxiosInstance;
vben authored
19
  private readonly options: CreateAxiosOptions;
陈文彬 authored
20
21
22
23
24
25
26
27

  constructor(options: CreateAxiosOptions) {
    this.options = options;
    this.axiosInstance = axios.create(options);
    this.setupInterceptors();
  }

  /**
28
   * @description:  Create axios instance
陈文彬 authored
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;
  }

  /**
44
   * @description: Reconfigure axios
陈文彬 authored
45
46
47
48
49
50
51
52
53
   */
  configAxios(config: CreateAxiosOptions) {
    if (!this.axiosInstance) {
      return;
    }
    this.createAxios(config);
  }

  /**
54
   * @description: Set general header
陈文彬 authored
55
56
57
58
59
60
61
62
63
   */
  setHeader(headers: any): void {
    if (!this.axiosInstance) {
      return;
    }
    Object.assign(this.axiosInstance.defaults.headers, headers);
  }

  /**
64
   * @description: Interceptor configuration
陈文彬 authored
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();
80
    // Request interceptor configuration processing
陈文彬 authored
81
    this.axiosInstance.interceptors.request.use((config: AxiosRequestConfig) => {
82
      // If cancel repeat request is turned on, then cancel repeat request is prohibited
83
      const {
Vben authored
84
        headers: { ignoreCancelToken },
85
      } = config;
Vben authored
86
87
88
89
90
91
92

      const ignoreCancel =
        ignoreCancelToken !== undefined
          ? ignoreCancelToken
          : this.options.requestOptions?.ignoreCancelToken;

      !ignoreCancel && axiosCanceler.addPending(config);
陈文彬 authored
93
      if (requestInterceptors && isFunction(requestInterceptors)) {
94
        config = requestInterceptors(config, this.options);
陈文彬 authored
95
96
97
98
      }
      return config;
    }, undefined);
99
    // Request interceptor error capture
陈文彬 authored
100
101
102
103
    requestInterceptorsCatch &&
      isFunction(requestInterceptorsCatch) &&
      this.axiosInstance.interceptors.request.use(undefined, requestInterceptorsCatch);
104
    // Response result interceptor processing
陈文彬 authored
105
106
107
108
109
110
111
112
    this.axiosInstance.interceptors.response.use((res: AxiosResponse<any>) => {
      res && axiosCanceler.removePending(res.config);
      if (responseInterceptors && isFunction(responseInterceptors)) {
        res = responseInterceptors(res);
      }
      return res;
    }, undefined);
113
    // Response result interceptor error capture
陈文彬 authored
114
115
116
117
118
    responseInterceptorsCatch &&
      isFunction(responseInterceptorsCatch) &&
      this.axiosInstance.interceptors.response.use(undefined, responseInterceptorsCatch);
  }
jq authored
119
  /**
120
   * @description:  File Upload
jq authored
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
   */
  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,
      },
    });
  }
陈文彬 authored
152
153
154
  // support form-data
  supportFormData(config: AxiosRequestConfig) {
155
    const headers = config.headers || this.options.headers;
156
157
158
159
160
161
162
163
164
165
166
167
    const contentType = headers?.['Content-Type'] || headers?.['content-type'];

    if (
      contentType !== ContentTypeEnum.FORM_URLENCODED ||
      !Reflect.has(config, 'data') ||
      config.method?.toUpperCase() === RequestEnum.GET
    ) {
      return config;
    }

    return {
      ...config,
最后 authored
168
      data: qs.stringify(config.data, { arrayFormat: 'brackets' }),
169
170
171
    };
  }
Vben authored
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
  get<T = any>(config: AxiosRequestConfig, options?: RequestOptions): Promise<T> {
    return this.request({ ...config, method: 'GET' }, options);
  }

  post<T = any>(config: AxiosRequestConfig, options?: RequestOptions): Promise<T> {
    return this.request({ ...config, method: 'POST' }, options);
  }

  put<T = any>(config: AxiosRequestConfig, options?: RequestOptions): Promise<T> {
    return this.request({ ...config, method: 'PUT' }, options);
  }

  delete<T = any>(config: AxiosRequestConfig, options?: RequestOptions): Promise<T> {
    return this.request({ ...config, method: 'DELETE' }, options);
  }
陈文彬 authored
188
  request<T = any>(config: AxiosRequestConfig, options?: RequestOptions): Promise<T> {
189
    let conf: CreateAxiosOptions = cloneDeep(config);
陈文彬 authored
190
191
192
193
194
195
    const transform = this.getTransform();

    const { requestOptions } = this.options;

    const opt: RequestOptions = Object.assign({}, requestOptions, options);
Vben authored
196
    const { beforeRequestHook, requestCatchHook, transformRequestHook } = transform || {};
陈文彬 authored
197
198
199
    if (beforeRequestHook && isFunction(beforeRequestHook)) {
      conf = beforeRequestHook(conf, opt);
    }
200
    conf.requestOptions = opt;
201
202

    conf = this.supportFormData(conf);
203
陈文彬 authored
204
205
206
207
    return new Promise((resolve, reject) => {
      this.axiosInstance
        .request<any, AxiosResponse<Result>>(conf)
        .then((res: AxiosResponse<Result>) => {
Vben authored
208
          if (transformRequestHook && isFunction(transformRequestHook)) {
209
210
211
212
213
214
            try {
              const ret = transformRequestHook(res, opt);
              resolve(ret);
            } catch (err) {
              reject(err || new Error('request error!'));
            }
陈文彬 authored
215
216
            return;
          }
217
          resolve(res as unknown as Promise<T>);
陈文彬 authored
218
219
        })
        .catch((e: Error) => {
Vben authored
220
          if (requestCatchHook && isFunction(requestCatchHook)) {
221
            reject(requestCatchHook(e, opt));
陈文彬 authored
222
223
224
225
226
227
228
            return;
          }
          reject(e);
        });
    });
  }
}