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

package/out/utils/net/net.js

@@ -1,4 +1,5 @@
 import axios from 'axios';
+import { merge } from 'lodash-es';
 import { stringify } from 'qs';
 import { notNilEmpty } from 'qx-util';
 import { HttpError } from '../../error';
@@ -13,27 +14,80 @@ import { HttpError } from '../../error';
 export class Net {
     /**
      * Creates an instance of Net.
-     *
-     * @author chitanda
-     * @date 2022-07-21 10:07:27
-     * @param {string} [prefix] 请求前缀
+     * @author lxm
+     * @date 2022-10-27 16:10:05
+     * @param {CreateAxiosDefaults} [config] 创建实例用的默认配置
      */
-    constructor(prefix) {
+    constructor(config) {
         /**
-         * 标准请求前缀
+         * 注册的拦截器
          *
-         * @author chitanda
-         * @date 2022-07-21 10:07:48
-         * @protected
-         * @type {string}
+         * @author lxm
+         * @date 2022-10-27 17:10:18
+         * @type {Map<string, Interceptor>}
          */
-        this._prefix = '';
-        if (prefix) {
-            this._prefix = prefix;
+        this.interceptors = new Map();
+        this.instance = axios.create(config);
+    }
+    /**
+     * 添加拦截器
+     *
+     * @author lxm
+     * @date 2022-10-27 17:10:42
+     * @param {string} name 唯一标识
+     * @param {Interceptor} interceptor 拦截器
+     */
+    addInterceptor(name, interceptor) {
+        interceptor.use(this.instance);
+        this.interceptors.set(name, interceptor);
+    }
+    /**
+     * 删除拦截器
+     *
+     * @author lxm
+     * @date 2022-10-27 17:10:27
+     * @param {string} name 唯一标识
+     */
+    removeInterceptor(name) {
+        const interceptor = this.interceptors.get(name);
+        if (interceptor) {
+            interceptor.eject(this.instance);
+            this.interceptors.delete(name);
         }
     }
-    get prefix() {
-        return this._prefix || ibiz.env.baseUrl;
+    /**
+     * 预置config,绑定动态的配置
+     *
+     * @author lxm
+     * @date 2022-10-27 16:10:48
+     * @readonly
+     * @protected
+     * @type {AxiosRequestConfig}
+     */
+    get presetConfig() {
+        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 {*}
+     */
+    mergeConfig(...configs) {
+        if (configs.length === 0) {
+            return this.presetConfig;
+        }
+        return merge(this.presetConfig, ...configs);
     }
     /**
      * Post 请求
@@ -49,11 +103,10 @@ export class Net {
     async post(url, data, params = {}, headers = {}) {
         url = this.handleAppPresetParam(url, params);
         try {
-            const response = await axios({
+            const response = await this.request(url, {
                 method: 'post',
-                url,
                 data,
-                headers: Object.assign({ 'Content-Type': 'application/json;charset=UTF-8', Accept: 'application/json' }, headers),
+                headers,
             });
             return this.doResponseResult(response);
         }
@@ -79,7 +132,7 @@ export class Net {
         // }
         url = this.attachUrlParam(url, params);
         try {
-            const response = await axios.get(url, Object.assign({ headers }, option));
+            const response = await this.request(url, merge({ method: 'get', headers }, option));
             return this.doResponseResult(response);
         }
         catch (error) {
@@ -99,7 +152,7 @@ export class Net {
     async delete(url, params, headers = {}) {
         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) {
@@ -120,7 +173,11 @@ export class Net {
     async put(url, data, params = {}, headers = {}) {
         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) {
@@ -138,7 +195,7 @@ export class Net {
      */
     async getModel(url, headers = {}) {
         try {
-            const response = await axios.get(url, {
+            const response = await this.instance.get(url, {
                 headers,
             });
             return this.doResponseResult(response);
@@ -147,6 +204,24 @@ export class Net {
             throw new HttpError(error);
         }
     }
+    /**
+     * 基础请求方法，会合并预置配置
+     *
+     * @author lxm
+     * @date 2022-10-27 14:10:06
+     * @param {string} url
+     * @param {AxiosRequestConfig} [config={}]
+     * @returns {*}  {Promise<IHttpResponse>}
+     */
+    async request(url, config = {}) {
+        try {
+            const response = await this.instance.request(this.mergeConfig({ url }, config));
+            return this.doResponseResult(response);
+        }
+        catch (error) {
+            throw new HttpError(error);
+        }
+    }
     /**
      * 统一处理请求返回
      *
@@ -197,7 +272,6 @@ export class Net {
      * @return {*}  {string}
      */
     attachUrlParam(url, params) {
-        url = this.attachUrl(url);
         const strParams = stringify(params);
         if (notNilEmpty(strParams)) {
             if (url.endsWith('?')) {
@@ -215,16 +289,4 @@ export class Net {
         }
         return url;
     }
-    /**
-     * 处理 url 参数
-     *
-     * @author chitanda
-     * @date 2022-07-20 20:07:17
-     * @private
-     * @param {string} url
-     * @return {*}  {string}
-     */
-    attachUrl(url) {
-        return `${this.prefix}${url}`;
-    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ibiz-template/core",
-  "version": "0.0.1-alpha.33",
+  "version": "0.0.1-alpha.37",
   "description": "核心包",
   "type": "module",
   "main": "out/index.js",
@@ -30,6 +30,7 @@
   "license": "MIT",
   "dependencies": {
     "axios": "^1.1.3",
+    "loglevel": "^1.8.0",
     "pluralize": "^8.0.0",
     "qs": "^6.11.0"
   },
@@ -37,11 +38,11 @@
     "@types/pluralize": "^0.0.29",
     "@types/qs": "^6.9.7",
     "lodash-es": "^4.17.21",
-    "qx-util": "0.4.3"
+    "qx-util": "^0.4.4"
   },
   "peerDependencies": {
     "lodash-es": "^4.17.21",
-    "qx-util": "^0.4.1"
+    "qx-util": "^0.4.4"
   },
-  "gitHead": "4fa409c39d3cecd7605818a865abf2b91f2a9e72"
+  "gitHead": "5dc73da226eb8c5863add2ee60a25d0251a26ed3"
 }

package/src/environment/environment.ts

@@ -6,8 +6,10 @@ import { IEnvironment } from '../interface';
  */
 export const Environment: IEnvironment = {
   dev: false,
+  logLevel: 'ERROR',
   jsCdn: 'https://cdn.jsdelivr.net',
   baseUrl: '',
+  pluginBaseUrl: './plugins',
   remoteModelUrl: '/remotemodel',
   assetsUrl: './assets',
   dcSystem: '',

package/src/ibizsys.ts

@@ -1,6 +1,6 @@
 import { Environment } from './environment/environment';
 import { OrgData } from './interface';
-import { Net } from './utils';
+import { Logger, Net } from './utils';
 
 /**
  * 全局对象
@@ -19,6 +19,14 @@ export class IBizSys {
    */
   env = Environment;
 
+  /**
+   * 日志对象
+   *
+   * @author chitanda
+   * @date 2022-10-25 20:10:22
+   */
+  log = Logger;
+
   /**
    * 网络请求工具类
    *

package/src/install.ts

@@ -1,6 +1,6 @@
 import { FactoryCenter } from './factory-center';
 import { IBizSys } from './ibizsys';
-import { Interceptor } from './utils';
+import { CoreInterceptor } from './utils';
 
 /**
  * 初始化全局对象
@@ -15,5 +15,5 @@ export function install(): void {
   }
   window.ibiz = new IBizSys();
   window.___fc = new FactoryCenter();
-  new Interceptor();
+  ibiz.net.addInterceptor('CoreInterceptor', new CoreInterceptor());
 }

package/src/interface/i-environment/i-environment.ts

@@ -1,3 +1,4 @@
+import { LogLevelDesc } from 'loglevel';
 import { LoginMode, MenuPermissionMode } from '../../constant';
 
 /**
@@ -28,6 +29,15 @@ export interface IEnvironment {
    */
   dev: boolean;
 
+  /**
+   * 日志级别
+   *
+   * @author chitanda
+   * @date 2022-10-25 20:10:55
+   * @type {LogLevelDesc}
+   */
+  logLevel: LogLevelDesc;
+
   /**
    * js 静态文件 cdn 地址
    *
@@ -47,6 +57,15 @@ export interface IEnvironment {
    */
   baseUrl: string;
 
+  /**
+   * 插件默认所在目录
+   *
+   * @author chitanda
+   * @date 2022-10-31 14:10:49
+   * @type {string}
+   */
+  pluginBaseUrl: string;
+
   /**
    * 登录模式
    *

package/src/utils/index.ts

@@ -1,4 +1,5 @@
-export { Interceptor } from './interceptor/interceptor';
+export * from './interceptor';
+export { Logger } from './logger/logger';
 export { Namespace } from './namespace/namespace';
 export { IHttpResponse, HttpResponse } from './net/http-response';
 export { Net } from './net/net';

package/src/utils/interceptor/core-interceptor.ts

@@ -0,0 +1,35 @@
+import { AxiosRequestConfig } from 'axios';
+import { getToken } from '../util/util';
+import { Interceptor } from './interceptor';
+
+/**
+ * 核心包拦截器
+ *
+ * @author lxm
+ * @date 2022-10-27 17:10:48
+ * @export
+ * @class CoreInterceptor
+ * @extends {Interceptor}
+ */
+export class CoreInterceptor extends Interceptor {
+  protected async onBeforeRequest(
+    config: AxiosRequestConfig,
+  ): Promise<AxiosRequestConfig> {
+    await super.onBeforeRequest(config);
+
+    if (!config.headers) {
+      config.headers = {};
+    }
+    config.headers.Authorization = `Bearer ${getToken()}`;
+    const { orgData } = ibiz;
+    if (orgData) {
+      if (orgData.systemid) {
+        config.headers.srfsystemid = orgData.systemid;
+      }
+      if (orgData.orgid) {
+        config.headers.srforgid = orgData.orgid;
+      }
+    }
+    return config;
+  }
+}

package/src/utils/interceptor/index.ts

@@ -0,0 +1,2 @@
+export * from './core-interceptor';
+export * from './interceptor';

package/src/utils/interceptor/interceptor.ts

@@ -1,8 +1,8 @@
-import axios from 'axios';
-import { getToken } from '../util/util';
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
 
 /**
- * 默认请求拦截器
+ * 拦截器基类
  *
  * @author chitanda
  * @date 2022-07-20 18:07:11
@@ -10,26 +10,115 @@ import { getToken } from '../util/util';
  * @class Interceptor
  */
 export class Interceptor {
-  constructor() {
-    this.init();
+  /**
+   * 请求拦截器绑定标识
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:20
+   * @private
+   * @type {number}
+   */
+  private requestTag?: number;
+
+  /**
+   * 响应拦截器绑定标识
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:19
+   * @private
+   * @type {number}
+   */
+  private responseTag?: number;
+
+  /**
+   * 请求之前处理
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:41
+   * @protected
+   * @param {AxiosRequestConfig} config
+   * @returns {*}  {Promise<AxiosRequestConfig>}
+   */
+  protected async onBeforeRequest(
+    config: AxiosRequestConfig,
+  ): Promise<AxiosRequestConfig> {
+    return config;
+  }
+
+  /**
+   * 请求失败之后处理
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:40
+   * @protected
+   * @param {*} error
+   */
+  protected onRequestError(error: any) {
+    // 处理请求错误
+    console.log(error);
+    return Promise.reject(error);
+  }
+
+  /**
+   * 响应成功之后处理
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:38
+   * @protected
+   * @param {AxiosResponse} config
+   * @returns {*}  {Promise<AxiosRequestConfig>}
+   */
+  protected async onResponseSuccess(
+    config: AxiosResponse,
+  ): Promise<AxiosResponse> {
+    return config;
+  }
+
+  /**
+   * 响应失败之后处理
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:37
+   * @protected
+   * @param {*} _error
+   */
+  protected onResponseError(error: any) {
+    // 处理响应错误
+    console.log(error);
+    return Promise.reject(error);
+  }
+
+  /**
+   * 使用拦截器
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:28
+   * @param {AxiosInstance} instance
+   */
+  use(instance: AxiosInstance): void {
+    this.requestTag = instance.interceptors.request.use(
+      this.onBeforeRequest,
+      this.onRequestError,
+    );
+    this.responseTag = instance.interceptors.response.use(
+      this.onResponseSuccess,
+      this.onResponseError,
+    );
   }
 
-  protected init(): void {
-    axios.interceptors.request.use(config => {
-      if (!config.headers) {
-        config.headers = {};
-      }
-      config.headers.Authorization = `Bearer ${getToken()}`;
-      const { orgData } = ibiz;
-      if (orgData) {
-        if (orgData.systemid) {
-          config.headers.srfsystemid = orgData.systemid;
-        }
-        if (orgData.orgid) {
-          config.headers.srforgid = orgData.orgid;
-        }
-      }
-      return config;
-    });
+  /**
+   * 移出拦截器
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:27
+   * @param {AxiosInstance} instance
+   */
+  eject(instance: AxiosInstance) {
+    if (this.requestTag) {
+      instance.interceptors.request.eject(this.requestTag);
+    }
+    if (this.responseTag) {
+      instance.interceptors.response.eject(this.responseTag);
+    }
   }
 }

package/src/utils/logger/logger.ts

@@ -0,0 +1,3 @@
+import * as Logger from 'loglevel';
+
+export { Logger };