@ibiz-template/core 0.0.1-alpha.33 → 0.0.1-alpha.37

package/src/utils/net/net.ts

@@ -2,10 +2,15 @@ import axios, {
   AxiosError,
   RawAxiosRequestHeaders,
   AxiosResponse,
+  AxiosRequestConfig,
+  AxiosInstance,
+  CreateAxiosDefaults,
 } from 'axios';
+import { merge } from 'lodash-es';
 import { stringify } from 'qs';
 import { notNilEmpty } from 'qx-util';
 import { HttpError } from '../../error';
+import { Interceptor } from '../interceptor/interceptor';
 import { IHttpResponse } from './http-response';
 
 /**
@@ -18,30 +23,96 @@ import { IHttpResponse } from './http-response';
  */
 export class Net {
   /**
-   * 标准请求前缀
+   * axios实例
    *
-   * @author chitanda
-   * @date 2022-07-21 10:07:48
+   * @author lxm
+   * @date 2022-10-27 17:10:18
    * @protected
-   * @type {string}
+   * @type {AxiosInstance}
    */
-  protected _prefix: string = '';
+  protected instance: AxiosInstance;
 
-  get prefix(): string {
-    return this._prefix || ibiz.env.baseUrl;
+  /**
+   * Creates an instance of Net.
+   * @author lxm
+   * @date 2022-10-27 16:10:05
+   * @param {CreateAxiosDefaults} [config] 创建实例用的默认配置
+   */
+  constructor(config?: CreateAxiosDefaults) {
+    this.instance = axios.create(config);
   }
 
   /**
-   * Creates an instance of Net.
+   * 注册的拦截器
    *
-   * @author chitanda
-   * @date 2022-07-21 10:07:27
-   * @param {string} [prefix] 请求前缀
+   * @author lxm
+   * @date 2022-10-27 17:10:18
+   * @type {Map<string, Interceptor>}
+   */
+  interceptors: Map<string, Interceptor> = new Map();
+
+  /**
+   * 添加拦截器
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:42
+   * @param {string} name 唯一标识
+   * @param {Interceptor} interceptor 拦截器
+   */
+  addInterceptor(name: string, interceptor: Interceptor) {
+    interceptor.use(this.instance);
+    this.interceptors.set(name, interceptor);
+  }
+
+  /**
+   * 删除拦截器
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:27
+   * @param {string} name 唯一标识
+   */
+  removeInterceptor(name: string) {
+    const interceptor = this.interceptors.get(name);
+    if (interceptor) {
+      interceptor.eject(this.instance);
+      this.interceptors.delete(name);
+    }
+  }
+
+  /**
+   * 预置config,绑定动态的配置
+   *
+   * @author lxm
+   * @date 2022-10-27 16:10:48
+   * @readonly
+   * @protected
+   * @type {AxiosRequestConfig}
+   */
+  protected get presetConfig(): AxiosRequestConfig {
+    return {
+      // 请求前缀路径
+      baseURL: this.instance.defaults.baseURL || ibiz.env.baseUrl,
+      headers: {
+        'Content-Type': 'application/json;charset=UTF-8',
+        Accept: 'application/json',
+      },
+    };
+  }
+
+  /**
+   * 从左到右递归合并配置参数（内置第一个合并的预置参数）
+   *
+   * @author lxm
+   * @date 2022-10-27 16:10:09
+   * @protected
+   * @param {...AxiosRequestConfig[]} configs
+   * @returns {*}
    */
-  constructor(prefix?: string) {
-    if (prefix) {
-      this._prefix = prefix;
+  protected mergeConfig(...configs: AxiosRequestConfig[]) {
+    if (configs.length === 0) {
+      return this.presetConfig;
     }
+    return merge(this.presetConfig, ...configs);
   }
 
   /**
@@ -63,15 +134,10 @@ export class Net {
   ): Promise<IHttpResponse> {
     url = this.handleAppPresetParam(url, params);
     try {
-      const response = await axios({
+      const response = await this.request(url, {
         method: 'post',
-        url,
         data,
-        headers: {
-          'Content-Type': 'application/json;charset=UTF-8',
-          Accept: 'application/json',
-          ...headers,
-        },
+        headers,
       });
       return this.doResponseResult(response);
     } catch (error) {
@@ -94,7 +160,7 @@ export class Net {
     url: string,
     params: IParams = {},
     headers: RawAxiosRequestHeaders = {},
-    option: IParams = {},
+    option: AxiosRequestConfig = {},
   ): Promise<IHttpResponse> {
     // if (params.srfparentdata) {
     //   Object.assign(params, params.srfparentdata);
@@ -102,7 +168,10 @@ export class Net {
     // }
     url = this.attachUrlParam(url, params);
     try {
-      const response = await axios.get(url, { headers, ...option });
+      const response = await this.request(
+        url,
+        merge({ method: 'get', headers }, option),
+      );
       return this.doResponseResult(response);
     } catch (error) {
       throw new HttpError(error as AxiosError);
@@ -126,7 +195,7 @@ export class Net {
   ): Promise<IHttpResponse> {
     url = this.handleAppPresetParam(url, params);
     try {
-      const response = await axios.delete(url, { headers });
+      const response = await this.request(url, { method: 'delete', headers });
       return this.doResponseResult(response);
     } catch (error) {
       throw new HttpError(error as AxiosError);
@@ -152,7 +221,11 @@ export class Net {
   ): Promise<IHttpResponse> {
     url = this.handleAppPresetParam(url, params);
     try {
-      const response = await axios.put(url, data, { headers });
+      const response = await this.request(url, {
+        method: 'put',
+        data,
+        headers,
+      });
       return this.doResponseResult(response);
     } catch (error) {
       throw new HttpError(error as AxiosError);
@@ -173,7 +246,7 @@ export class Net {
     headers: RawAxiosRequestHeaders = {},
   ): Promise<IHttpResponse> {
     try {
-      const response = await axios.get(url, {
+      const response = await this.instance.get(url, {
         headers,
       });
       return this.doResponseResult(response);
@@ -182,6 +255,29 @@ export class Net {
     }
   }
 
+  /**
+   * 基础请求方法，会合并预置配置
+   *
+   * @author lxm
+   * @date 2022-10-27 14:10:06
+   * @param {string} url
+   * @param {AxiosRequestConfig} [config={}]
+   * @returns {*}  {Promise<IHttpResponse>}
+   */
+  async request(
+    url: string,
+    config: AxiosRequestConfig = {},
+  ): Promise<IHttpResponse> {
+    try {
+      const response = await this.instance.request(
+        this.mergeConfig({ url }, config),
+      );
+      return this.doResponseResult(response);
+    } catch (error) {
+      throw new HttpError(error as AxiosError);
+    }
+  }
+
   /**
    * 统一处理请求返回
    *
@@ -234,7 +330,6 @@ export class Net {
    * @return {*}  {string}
    */
   private attachUrlParam(url: string, params: IParams): string {
-    url = this.attachUrl(url);
     const strParams: string = stringify(params);
     if (notNilEmpty(strParams)) {
       if (url.endsWith('?')) {
@@ -249,17 +344,4 @@ export class Net {
     }
     return url;
   }
-
-  /**
-   * 处理 url 参数
-   *
-   * @author chitanda
-   * @date 2022-07-20 20:07:17
-   * @private
-   * @param {string} url
-   * @return {*}  {string}
-   */
-  private attachUrl(url: string): string {
-    return `${this.prefix}${url}`;
-  }
 }