@ibiz-template/core 0.0.1-alpha.6 → 0.0.1-beta.1

package/src/utils/net/net.ts

@@ -1,7 +1,16 @@
-import axios, { AxiosError, AxiosRequestHeaders, AxiosResponse } from 'axios';
+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';
 
 /**
@@ -14,58 +23,121 @@ 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 唯一标识
    */
-  constructor(prefix?: string) {
-    if (prefix) {
-      this._prefix = prefix;
+  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 {*}
+   */
+  protected mergeConfig(...configs: AxiosRequestConfig[]) {
+    if (configs.length === 0) {
+      return this.presetConfig;
+    }
+    return merge(this.presetConfig, ...configs);
+  }
+
   /**
    * Post 请求
    *
    * @author chitanda
-   * @date 2022-07-14 15:07:01
+   * @date 2022-10-19 11:10:30
    * @param {string} url
+   * @param {IData} data
    * @param {IParams} [params={}]
+   * @param {RawAxiosRequestHeaders} [headers={}]
    * @return {*}  {Promise<IHttpResponse>}
    */
   async post(
     url: string,
     data: IData,
     params: IParams = {},
-    headers: AxiosRequestHeaders = {},
+    headers: RawAxiosRequestHeaders = {},
   ): 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) {
@@ -77,16 +149,18 @@ export class Net {
    * Get 请求
    *
    * @author chitanda
-   * @date 2022-07-14 15:07:08
+   * @date 2022-10-19 11:10:24
    * @param {string} url
    * @param {IParams} [params={}]
+   * @param {RawAxiosRequestHeaders} [headers={}]
+   * @param {IParams} [option={}]
    * @return {*}  {Promise<IHttpResponse>}
    */
   async get(
     url: string,
     params: IParams = {},
-    headers: AxiosRequestHeaders = {},
-    option: IParams = {},
+    headers: RawAxiosRequestHeaders = {},
+    option: AxiosRequestConfig = {},
   ): Promise<IHttpResponse> {
     // if (params.srfparentdata) {
     //   Object.assign(params, params.srfparentdata);
@@ -94,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);
@@ -105,19 +182,20 @@ export class Net {
    * Delete 请求
    *
    * @author chitanda
-   * @date 2022-07-14 15:07:43
+   * @date 2022-10-19 11:10:17
    * @param {string} url
    * @param {IParams} [params]
+   * @param {RawAxiosRequestHeaders} [headers={}]
    * @return {*}  {Promise<IHttpResponse>}
    */
   async delete(
     url: string,
     params?: IParams,
-    headers: AxiosRequestHeaders = {},
+    headers: RawAxiosRequestHeaders = {},
   ): 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);
@@ -128,20 +206,26 @@ export class Net {
    * Put 请求
    *
    * @author chitanda
-   * @date 2022-07-14 15:07:49
+   * @date 2022-10-19 11:10:11
    * @param {string} url
    * @param {IData} data
+   * @param {IParams} [params={}]
+   * @param {RawAxiosRequestHeaders} [headers={}]
    * @return {*}  {Promise<IHttpResponse>}
    */
   async put(
     url: string,
     data: IData,
     params: IParams = {},
-    headers: AxiosRequestHeaders = {},
+    headers: RawAxiosRequestHeaders = {},
   ): 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);
@@ -154,15 +238,15 @@ export class Net {
    * @author chitanda
    * @date 2022-07-14 15:07:15
    * @param {string} url
-   * @param {AxiosRequestHeaders} [headers={}]
+   * @param {RawAxiosRequestHeaders} [headers={}]
    * @return {*}  {Promise<IHttpResponse>}
    */
   async getModel(
     url: string,
-    headers: AxiosRequestHeaders = {},
+    headers: RawAxiosRequestHeaders = {},
   ): Promise<IHttpResponse> {
     try {
-      const response = await axios.get(url, {
+      const response = await this.instance.get(url, {
         headers,
       });
       return this.doResponseResult(response);
@@ -171,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);
+    }
+  }
+
   /**
    * 统一处理请求返回
    *
@@ -223,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('?')) {
@@ -238,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}`;
-  }
 }

package/src/utils/url-helper/url-helper.ts

@@ -0,0 +1,62 @@
+/**
+ * 路径解析助手
+ *
+ * @author lxm
+ * @date 2022-10-11 14:10:12
+ * @export
+ * @class UrlHelper
+ */
+export class UrlHelper {
+  /**
+   * 路由路径前面的基础路径
+   * 如：http://172.16.103.120:30061/portalwebapp/#/index/appportalview?params=123
+   * 返回：http://172.16.103.120:30061/portalwebapp/#
+   *
+   * @author lxm
+   * @date 2022-10-11 20:10:29
+   * @returns {*}
+   */
+  static get routeBase() {
+    return `${this.appBase}/#`;
+  }
+
+  /**
+   * 应用的的基础路径
+   * 如：http://172.16.103.120:30061/portalwebapp/#/index/appportalview?params=123
+   * 返回：http://172.16.103.120:30061/portalwebapp
+   *
+   * @author lxm
+   * @date 2022-10-11 20:10:29
+   * @returns {*}
+   */
+  static get appBase() {
+    const { origin, pathname } = window.location;
+    return `${origin}${pathname}`.replace(/\/$/, '');
+  }
+
+  /**
+   * #开始到末尾，即路由地址
+   * 如：http://172.16.103.120:30061/portalwebapp/#/index/appportalview?params=123
+   * 返回：/index/appportalview?params=123
+   *
+   * @author lxm
+   * @date 2022-10-11 16:10:40
+   * @returns {*}
+   */
+  static get routePath() {
+    return window.location.hash.replace('#', '');
+  }
+
+  /**
+   * 当前地址的全路径，包含域名和参数
+   * 如：http://172.16.103.120:30061/portalwebapp/#/index/appportalview?params=123
+   *
+   * @author lxm
+   * @date 2022-10-11 21:10:39
+   * @readonly
+   * @static
+   */
+  static get fullPath() {
+    return window.location.href;
+  }
+}

package/src/utils/util/util.ts

@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
-import { debounce, DebounceSettings } from 'lodash-es';
+import { debounce } from 'lodash-es';
 import { getCookie } from 'qx-util';
 import { CoreConst } from '../../constant';
 
@@ -27,11 +27,12 @@ export function getToken(): string | null {
  */
 export function isOverlap(arr1: any[], arr2: any[]): boolean {
   const newArr = Array.from(new Set([...arr1, ...arr2]));
-  return newArr.length === arr1.length + arr2.length;
+  return newArr.length !== arr1.length + arr2.length;
 }
 
 /**
- * 防抖并合并每次的参数
+ * 防抖并合并每次的参数，
+ * 最后一次才会执行
  *
  * @author lxm
  * @date 2022-09-20 21:09:53
@@ -43,7 +44,6 @@ export function isOverlap(arr1: any[], arr2: any[]): boolean {
  *     newParams: Parameters<T>,
  *   ) => Parameters<T>} mergeFunc 合并的回调函数
  * @param {number} [wait] 防抖的延迟毫秒数
- * @param {DebounceSettings} [options] 防抖函数的额外参数
  * @returns {*}
  */
 export function debounceAndMerge<T extends (...args: any[]) => any>(
@@ -53,19 +53,14 @@ export function debounceAndMerge<T extends (...args: any[]) => any>(
     newParams: Parameters<T>,
   ) => Parameters<T>,
   wait?: number,
-  options?: DebounceSettings,
 ) {
   // 缓存上一次的函数参数
   let oldParams: Parameters<T> | undefined;
-  const debounceFunc = debounce(
-    (...params: Parameters<T>) => {
-      // 防抖函数执行的时候清空缓存参数
-      oldParams = undefined;
-      return func(...params);
-    },
-    wait,
-    options,
-  );
+  const debounceFunc = debounce((...params: Parameters<T>) => {
+    // 防抖函数执行的时候清空缓存参数
+    oldParams = undefined;
+    return func(...params);
+  }, wait);
   return (...args: Parameters<T>) => {
     // 合并参数，并把参数缓存到oldParams里，用新参数调用防抖函数
     let newParams = args;
@@ -76,3 +71,66 @@ export function debounceAndMerge<T extends (...args: any[]) => any>(
     return debounceFunc(...newParams);
   };
 }
+
+/**
+ * 防抖并合并每次的参数，最后一次才会执行
+ * 绑定方法为异步方法，给每次调用返回最终执行那次的结果
+ *
+ * @author lxm
+ * @date 2022-09-20 21:09:53
+ * @export
+ * @template T
+ * @param {T} func 要防抖的函数
+ * @param {(
+ *     oldParams: Parameters<T>,
+ *     newParams: Parameters<T>,
+ *   ) => Parameters<T>} mergeFunc 合并的回调函数
+ * @param {number} [wait] 防抖的延迟毫秒数
+ * @returns {*}
+ */
+export function debounceAndAsyncMerge<
+  T extends (...args: any[]) => Promise<any>,
+>(
+  func: T,
+  mergeFunc: (
+    oldParams: Parameters<T>,
+    newParams: Parameters<T>,
+  ) => Parameters<T>,
+  wait?: number,
+): T {
+  // 缓存上一次的函数参数
+  let oldParams: Parameters<T> | undefined;
+  let promises: Array<{ resolve: any; reject: any }> = [];
+  const debounceFunc = debounce(async (...params: Parameters<T>) => {
+    // 防抖函数执行的时候清空缓存参数
+    oldParams = undefined;
+    try {
+      const result = await func(...params);
+      promises.forEach(promise => {
+        promise.resolve(result);
+      });
+      promises = [];
+      return result;
+    } catch (error) {
+      promises.forEach(promise => {
+        promise.reject(error);
+      });
+      promises = [];
+    }
+  }, wait);
+  const fun = async (...args: Parameters<T>) => {
+    // 合并参数，并把参数缓存到oldParams里，用新参数调用防抖函数
+    let newParams = args;
+    if (oldParams) {
+      newParams = mergeFunc(oldParams, newParams);
+    }
+    oldParams = newParams;
+    // 执行防抖函数
+    debounceFunc(...newParams);
+    return new Promise((resolve, reject) => {
+      // 阻塞当前调用，当防抖函数被执行后返回
+      promises.push({ resolve, reject });
+    });
+  };
+  return fun as T;
+}