Blame view

src/utils/http/axios/Axios.ts 6.49 KB
陈文彬 authored
1
import type { AxiosRequestConfig, AxiosInstance, AxiosResponse } from 'axios';
Vben authored
2
3
import type { RequestOptions, Result, UploadFileParams } from './types';
import type { CreateAxiosOptions } from './axiosTransform';
陈文彬 authored
4
5

import axios from 'axios';
Vben authored
6
import qs from 'qs';
陈文彬 authored
7
8
9
10
import { AxiosCanceler } from './axiosCancel';
import { isFunction } from '/@/utils/is';
import { cloneDeep } from 'lodash-es';
jq authored
11
import { ContentTypeEnum } from '/@/enums/httpEnum';
12
import { RequestEnum } from '../../../enums/httpEnum';
陈文彬 authored
13
14
15
16

export * from './axiosTransform';

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

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

  /**
30
   * @description:  Create axios instance
陈文彬 authored
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
   */
  private createAxios(config: CreateAxiosOptions): void {
    this.axiosInstance = axios.create(config);
  }

  private getTransform() {
    const { transform } = this.options;
    return transform;
  }

  getAxios(): AxiosInstance {
    return this.axiosInstance;
  }

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

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

  /**
66
   * @description: Interceptor configuration
陈文彬 authored
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
   */
  private setupInterceptors() {
    const transform = this.getTransform();
    if (!transform) {
      return;
    }
    const {
      requestInterceptors,
      requestInterceptorsCatch,
      responseInterceptors,
      responseInterceptorsCatch,
    } = transform;

    const axiosCanceler = new AxiosCanceler();
82
    // Request interceptor configuration processing
陈文彬 authored
83
    this.axiosInstance.interceptors.request.use((config: AxiosRequestConfig) => {
84
      // If cancel repeat request is turned on, then cancel repeat request is prohibited
85
      const {
Vben authored
86
        headers: { ignoreCancelToken },
87
      } = config;
Vben authored
88
89
90
91
92
93
94

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

      !ignoreCancel && axiosCanceler.addPending(config);
陈文彬 authored
95
96
97
98
99
100
      if (requestInterceptors && isFunction(requestInterceptors)) {
        config = requestInterceptors(config);
      }
      return config;
    }, undefined);
101
    // Request interceptor error capture
陈文彬 authored
102
103
104
105
    requestInterceptorsCatch &&
      isFunction(requestInterceptorsCatch) &&
      this.axiosInstance.interceptors.request.use(undefined, requestInterceptorsCatch);
106
    // Response result interceptor processing
陈文彬 authored
107
108
109
110
111
112
113
114
    this.axiosInstance.interceptors.response.use((res: AxiosResponse<any>) => {
      res && axiosCanceler.removePending(res.config);
      if (responseInterceptors && isFunction(responseInterceptors)) {
        res = responseInterceptors(res);
      }
      return res;
    }, undefined);
115
    // Response result interceptor error capture
陈文彬 authored
116
117
118
119
120
    responseInterceptorsCatch &&
      isFunction(responseInterceptorsCatch) &&
      this.axiosInstance.interceptors.response.use(undefined, responseInterceptorsCatch);
  }
jq authored
121
  /**
122
   * @description:  File Upload
jq authored
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
   */
  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
154
155
156
  // support form-data
  supportFormData(config: AxiosRequestConfig) {
157
    const headers = config.headers || this.options.headers;
158
159
160
161
162
163
164
165
166
167
168
169
    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
170
      data: qs.stringify(config.data, { arrayFormat: 'brackets' }),
171
172
173
    };
  }
Vben authored
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
  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
190
191
192
193
194
195
196
197
  request<T = any>(config: AxiosRequestConfig, options?: RequestOptions): Promise<T> {
    let conf: AxiosRequestConfig = cloneDeep(config);
    const transform = this.getTransform();

    const { requestOptions } = this.options;

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

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