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

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/sync/count-latch.ts

@@ -0,0 +1,99 @@
+import { RuntimeError } from '../../error';
+
+/**
+ * 计数插销工具类
+ *
+ * @author lxm
+ * @date 2022-11-24 19:11:49
+ * @export
+ * @class CountLatch
+ */
+export class CountLatch {
+  private promise: Promise<void> | null = null;
+
+  private resolve: ((value: void) => void) | null = null;
+
+  /**
+   * 计数，当前等待的异步逻辑个数
+   *
+   * @author lxm
+   * @date 2022-11-24 19:11:59
+   * @type {number}
+   */
+  count: number = 0;
+
+  /**
+   * 开启promise
+   *
+   * @author lxm
+   * @date 2022-11-24 19:11:32
+   * @private
+   */
+  private startPromise() {
+    this.promise = new Promise(resolve => {
+      this.resolve = resolve;
+    });
+  }
+
+  /**
+   * 结束promise
+   *
+   * @author lxm
+   * @date 2022-11-24 19:11:44
+   * @private
+   */
+  private endPromise() {
+    if (this.resolve) {
+      this.resolve();
+      this.resolve = null;
+      this.promise = null;
+    }
+  }
+
+  /**
+   * 上锁，计数加一
+   * 第一次计数，开启异步
+   *
+   * @author lxm
+   * @date 2022-11-24 19:11:27
+   */
+  lock() {
+    console.log('lock');
+    this.count += 1;
+    if (!this.promise) {
+      console.log('startPromise');
+      this.startPromise();
+    }
+  }
+
+  /**
+   * 解锁，计数减一
+   * 归零时结束异步
+   *
+   * @author lxm
+   * @date 2022-11-24 19:11:47
+   */
+  unlock() {
+    if (this.count < 1) {
+      throw new RuntimeError('lock和unlock次数不匹配！');
+    }
+    console.log('unlock');
+    this.count -= 1;
+    if (this.count === 0) {
+      debugger;
+      this.endPromise();
+    }
+  }
+
+  /**
+   * 等待，计数归零异步结束
+   *
+   * @author lxm
+   * @date 2022-11-24 19:11:20
+   */
+  async await() {
+    if (this.promise) {
+      await this.promise;
+    }
+  }
+}

package/src/utils/sync/index.ts

@@ -0,0 +1 @@
+export { CountLatch } from './count-latch';

package/src/utils/upload/select-file.ts

@@ -0,0 +1,86 @@
+import { merge } from 'lodash-es';
+
+/**
+ * 文件List转数组
+ *
+ * @author lxm
+ * @date 2022-11-18 13:11:03
+ * @export
+ * @param {FileList} fileList
+ * @returns {*}
+ */
+export function fileListToArr(fileList: FileList): File[] {
+  const files = [];
+  for (let i = 0; i < fileList.length; i++) {
+    files.push(fileList[i]);
+  }
+  return files;
+}
+
+/**
+ * JS打开文件上传操作配置参数
+ *
+ * @author lxm
+ * @date 2022-11-20 21:11:47
+ * @export
+ * @interface SelectFileOpts
+ */
+export interface SelectFileOpts {
+  /**
+   * 接受的文件类型
+   *
+   * @author lxm
+   * @date 2022-11-20 21:11:52
+   * @type {string}
+   */
+  accept?: string;
+  /**
+   * 是否支持多选
+   *
+   * @author lxm
+   * @date 2022-11-20 21:11:52
+   * @type {boolean}
+   */
+  multiple?: boolean;
+  /**
+   * 选中文件后回调
+   *
+   * @author lxm
+   * @date 2022-11-20 21:11:50
+   */
+  onSelected: (_fileList: File[]) => void;
+}
+
+/**
+ * JS打开文件上传操作
+ *
+ * @author lxm
+ * @date 2022-11-20 21:11:31
+ * @export
+ * @param {SelectFileOpts} _opts 配置参数
+ */
+export function selectFile(_opts: SelectFileOpts) {
+  const opts: Required<SelectFileOpts> = merge(
+    {
+      multiple: true,
+      accept: '',
+    },
+    _opts,
+  );
+  const input = document.createElement('input');
+  input.setAttribute('type', 'file');
+  input.setAttribute('multiple', `${opts.multiple}`);
+  input.setAttribute('accept', opts.accept);
+  input.onchange = e => {
+    const inputEl = e.target as HTMLInputElement;
+    const files = inputEl.files ? fileListToArr(inputEl.files) : [];
+    if (files.length === 0) {
+      return;
+    }
+    opts.onSelected(files);
+    inputEl.value = ''; // 如果不置空，相同的文件不会触发change事件
+  };
+  document.body.appendChild(input);
+  input.click();
+  document.body.removeChild(input);
+}

package/src/utils/upload/upload-file.ts

@@ -0,0 +1,206 @@
+/* eslint-disable @typescript-eslint/no-empty-function */
+/* eslint-disable no-param-reassign */
+import { cloneDeep, isFunction, merge, round, uniqueId } from 'lodash-es';
+import { HttpResponse } from '../net/http-response';
+import { selectFile } from './select-file';
+
+export interface IUploadFile {
+  name: string;
+  uid: string;
+  status: 'uploading' | 'finished' | 'fail' | 'cancel';
+  percentage: number;
+  response?: HttpResponse;
+  error?: unknown;
+}
+
+export interface IUploadFileOpts {
+  uploadUrl: string;
+  /**
+   * 接受的文件类型
+   *
+   * @author lxm
+   * @date 2022-11-20 21:11:52
+   * @type {string}
+   */
+  accept?: string;
+  /**
+   * 是否支持多选
+   *
+   * @author lxm
+   * @date 2022-11-20 21:11:52
+   * @type {Boolean}
+   */
+  multiple?: boolean;
+  separate?: string;
+  request?: (_files: File[]) => Promise<HttpResponse>;
+  beforeUpload?: (_fileData: File[], _files: IUploadFile[]) => boolean;
+  finish?: (_resultFiles: IUploadFile[]) => void;
+  success?: (_resultFiles: IUploadFile[], _res: HttpResponse) => void;
+  error?: (_resultFiles: IUploadFile[], _error: unknown) => void;
+  progress?: (_files: IUploadFile[]) => void;
+}
+
+/**
+ * 使用上传文件逻辑
+ *
+ * @author lxm
+ * @date 2022-11-20 21:11:52
+ * @export
+ * @param {IUploadFileOpts} _opts
+ * @returns {*}
+ */
+export function uploadFile(_opts: IUploadFileOpts) {
+  const opts: Required<IUploadFileOpts> = merge(
+    {
+      multiple: true,
+      accept: '',
+      separate: true,
+      beforeUpload: (_fileData: File[], _files: IUploadFile[]) => true,
+      finish: (_resultFiles: IUploadFile[]) => {},
+      success: (_resultFiles: IUploadFile[], _res: HttpResponse) => {},
+      error: (_resultFiles: IUploadFile[], _error: unknown) => {},
+      progress: (_files: IUploadFile[]) => {},
+    },
+    _opts,
+  );
+
+  /**
+   * 进度条回调
+   *
+   * @author lxm
+   * @date 2022-11-20 21:11:47
+   * @param {IParams} event
+   * @param {IUploadFile[]} files
+   */
+  const onUploadProgress = (event: IParams, files: IUploadFile[]) => {
+    files.forEach(file => {
+      file.percentage = round(event.progress * 100);
+    });
+    opts.progress(cloneDeep(files));
+  };
+
+  /**
+   * 上传请求方法，返回响应对象
+   *
+   * @author lxm
+   * @date 2022-11-18 13:11:57
+   * @param {File[]} files
+   * @returns {*}  {Promise<HttpResponse>}
+   */
+  const uploadRequest = async (
+    files: File[],
+    onProgress: (_event: IParams) => void,
+  ): Promise<HttpResponse> => {
+    // 自定义上传请求
+    if (opts.request && isFunction(opts.request)) {
+      return opts.request(files);
+    }
+
+    // 默认每次单个文件上传，可能存在接口一次上传多个文件,
+    const data = new FormData();
+    files.forEach(file => {
+      data.append('file', file);
+    });
+    const res = await ibiz.net.request(opts.uploadUrl, {
+      method: 'post',
+      baseURL: '',
+      data,
+      headers: { 'Content-Type': 'multipart/form-data' },
+      onUploadProgress: onProgress,
+    });
+    return res;
+  };
+
+  /**
+   * 执行一次上传，可能是一个文件也可能是多个文件
+   *
+   * @author lxm
+   * @date 2022-11-18 14:11:54
+   * @param {File[]} files 此次上传文件的集合
+   * @returns {*}  {Promise<IUploadFile[]>}
+   */
+  const executeSingleUpload = async (files: File[]): Promise<IUploadFile[]> => {
+    const resultFiles: IUploadFile[] = files.map(file => {
+      return {
+        status: 'uploading',
+        name: file.name,
+        uid: uniqueId(),
+        percentage: 0,
+      };
+    });
+
+    // 上传前回调，可以取消此次下载
+    const pass = opts.beforeUpload(files, resultFiles);
+    if (!pass) {
+      resultFiles.forEach(file => {
+        file.status = 'cancel';
+      });
+      ibiz.log.debug('取消上传', resultFiles);
+      return resultFiles;
+    }
+
+    try {
+      const res = await uploadRequest(files, event => {
+        onUploadProgress(event, resultFiles);
+      });
+      resultFiles.forEach(file => {
+        file.status = 'finished';
+      });
+      // 上传成功事件
+      opts.success(resultFiles, res);
+      resultFiles.forEach(file => {
+        file.response = res;
+      });
+    } catch (error) {
+      resultFiles.forEach(file => {
+        file.status = 'fail';
+      });
+      // 上传失败事件
+      opts.error(resultFiles, error);
+      resultFiles.forEach(file => {
+        file.error = error;
+      });
+      ibiz.log.error(error);
+      ibiz.log.error(`${files.map(file => file.name).join(',')}上传失败`);
+    }
+    return resultFiles;
+  };
+
+  /**
+   * 执行上传文件逻辑
+   *
+   * @author lxm
+   * @date 2022-11-18 13:11:21
+   * @param {files} File[] 文件集合
+   */
+  const uploadFiles = async (files: File[]) => {
+    const uploadSequence = opts.separate ? files.map(file => [file]) : [files];
+    const res = await Promise.allSettled(
+      uploadSequence.map(async sequence => {
+        return executeSingleUpload(sequence);
+      }),
+    );
+
+    // 整合所有的返回文件
+    const resultFiles: IUploadFile[] = [];
+    res.forEach(result => {
+      if (result.status === 'fulfilled') {
+        resultFiles.push(...result.value);
+      }
+    });
+
+    opts.finish(resultFiles);
+  };
+
+  const select = () => {
+    selectFile({
+      accept: opts.accept,
+      multiple: opts.multiple,
+      onSelected: files => {
+        uploadFiles(files);
+      },
+    });
+  };
+
+  select();
+}