@hzab/data-model 1.5.0 → 1.6.0-beta1

package/CHANGELOG.md

@@ -1,3 +1,8 @@
+# @hzab/data-model@1.6.0
+
+fix: 注释；通用函数抽离
+feat: ArrayDataModel 本地数据 DataModel
+
 # @hzab/data-model@1.5.0
 
 - feat: 增加 patch 请求方式函数

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hzab/data-model",
-  "version": "1.5.0",
+  "version": "1.6.0-beta1",
   "description": "data model",
   "main": "src",
   "scripts": {
@@ -21,12 +21,14 @@
   "author": "CaiYansong",
   "license": "ISC",
   "devDependencies": {
-    "@hzab/permissions": "0.0.4",
-    "@hzab/webpack-config": "^0.0.15",
+    "@hzab/permissions": "^0.1.1",
+    "@hzab/webpack-config": "^0.7.1",
     "@types/react": "^17.0.62",
     "@types/react-dom": "^17.0.20",
     "antd": "^4.14.0",
+    "axios": "^1.6.2",
     "eslint": "^8.30.0",
+    "js-cookie": "^3.0.5",
     "less": "^4.1.3",
     "mobx": "^6.7.0",
     "mobx-react": "^7.6.0",
@@ -34,17 +36,16 @@
     "react-dom": "^17.0.2",
     "react-router-dom": "^6.14.1",
     "typedoc": "^0.24.8",
-    "typescript": "^4.9.4",
-    "axios": "^1.6.2",
-    "js-cookie": "^3.0.5"
+    "typescript": "^4.9.4"
   },
   "peerDependencies": {
     "axios": ">=1.6.2",
     "js-cookie": ">=3.0.5"
   },
   "dependencies": {
-    "axios": "^1.6.2",
-    "js-cookie": "^3.0.5"
+    "axios": ">=1.6.2",
+    "js-cookie": ">=3.0.5",
+    "nanoid": "^3.3.7"
   },
   "directories": {
     "lib": "lib"

package/src/ArrayUtils.js

@@ -0,0 +1,195 @@
+import { nanoid } from "nanoid";
+import _ from "lodash";
+
+export const STATE_CODE = {
+  SUC: 200,
+  NOT_FOUNT: 404,
+  ERR: 500,
+  ERR_INPUT_ID: 501,
+};
+
+/**
+ * 数组模拟数据库存储
+ * TODO: FormData? 考虑到文件存储问题
+ */
+export class ArrayUtils {
+  _idKey = "id";
+  _list = [];
+  constructor(params) {
+    const { idKey = "id", list } = params;
+    /** 子项唯一标志字段 */
+    this._idKey = idKey || "id";
+    /** 列表数据 */
+    this._list = list || [];
+  }
+
+  /**
+   * 通过 id 获取子项
+   * @param {*} id
+   * @returns
+   */
+  findItemById(id) {
+    if (hasId(id)) {
+      return null;
+    }
+    const { _idKey } = this;
+    return _.cloneDeep(this._list.find((it) => it[_idKey] === id));
+  }
+
+  /**
+   * 通过 id 获取子项
+   * @param {*} id
+   * @returns
+   */
+  findItem(query = {}) {
+    const { _idKey } = this;
+    const id = query[_idKey];
+    if (hasId(id)) {
+      return this.findItemById(id);
+    }
+    // TODO: query 查询
+    return _.cloneDeep(this._list.find((it) => it[_idKey] === id));
+  }
+
+  /**
+   * 获取列表
+   * TODO: 搜索？
+   * @param {*} query
+   */
+  findListByQuery(query) {
+    const { pageNum = 1, pageSize = 10 } = query || {};
+    const { _list } = this;
+    // 边界检查
+    if (pageNum < 1 || pageSize <= 0) {
+      return { list: [], pagination: { current: 1, total: 0 } };
+    }
+    // 计算起始索引
+    const startIndex = (pageNum - 1) * pageSize;
+    // 如果起始索引超出数组长度，返回空数组
+    if (startIndex >= _list.length) {
+      return { list: [], pagination: { current: 1, total: 0 } };
+    }
+    // 计算结束索引
+    const endIndex = startIndex + pageSize;
+
+    // 使用 slice 方法截取数据
+    return { list: _list.slice(startIndex, endIndex), pagination: { current: pageNum, total: this.getCount() } };
+  }
+
+  /**
+   * 获取完整列表
+   */
+  findAllList() {
+    return _.cloneDeep(this._list);
+  }
+
+  /**
+   * 获取总数
+   * @returns
+   */
+  getCount() {
+    return this._list.length;
+  }
+
+  /**
+   * push 数据
+   * @param {*} data
+   */
+  pushItem(data) {
+    // TODO: id 去重
+    const item = _.cloneDeep(data);
+    this.setId(item);
+    this._list.push(item);
+    return STATE_CODE.SUC;
+  }
+
+  /**
+   * unshift 数据
+   * @param {*} data
+   */
+  unshiftItem(data) {
+    // TODO: id 去重
+    const item = _.cloneDeep(data);
+    this.setId(item);
+    this._list.unshift(item);
+    return STATE_CODE.SUC;
+  }
+
+  /**
+   * 根据 id 更新子项——直接替换
+   * @param {Object} data
+   * @returns
+   */
+  replaceItem(data) {
+    const { _idKey, _list } = this;
+    const id = data[_idKey];
+    if (hasId(id)) {
+      return STATE_CODE.ERR_INPUT_ID;
+    }
+    const idx = _list.findIndex((it) => it[_idKey] === id);
+    if (idx < 0) {
+      return STATE_CODE.NOT_FOUNT;
+    }
+    _list.splice(idx, 1, data);
+    return STATE_CODE.SUC;
+  }
+
+  /**
+   * 根据 id 更新子项——仅修改传入的数据
+   * @param {Object} data
+   * @returns
+   */
+  updateItemValue(data) {
+    const { _idKey, _list } = this;
+    const id = data[_idKey];
+    if (hasId(id)) {
+      return STATE_CODE.ERR_INPUT_ID;
+    }
+    const item = _list.find((it) => it[_idKey] === id);
+    if (!item) {
+      return STATE_CODE.NOT_FOUNT;
+    }
+    Object.keys(data).forEach((key) => {
+      item[key] = data[key];
+    });
+    return STATE_CODE.SUC;
+  }
+
+  /**
+   * 删除子项
+   * @param {*} id
+   * @param {*} data
+   * @returns
+   */
+  delItem(id) {
+    const { _idKey, _list } = this;
+    if (hasId(id)) {
+      return STATE_CODE.ERR_INPUT_ID;
+    }
+    const idx = _list.findIndex((it) => it[_idKey] === id);
+    if (idx < 0) {
+      return STATE_CODE.NOT_FOUNT;
+    }
+    _list.splice(idx, 1);
+    return STATE_CODE.SUC;
+  }
+
+  /**
+   * 子项没有 id 的时候自动添加
+   * @param {*} item
+   * @returns
+   */
+  setId(item) {
+    const { _idKey } = this;
+    if (!item[_idKey]) {
+      item[_idKey] = nanoid();
+    }
+    return item;
+  }
+}
+
+export const hasId = (id) => {
+  return _.isNil(id) || id === "";
+};
+
+export default ArrayUtils;

package/src/array-data-model.js

@@ -0,0 +1,396 @@
+import _ from "lodash";
+
+import { objToFormData, formDataToObj, _$Temp } from "./utils";
+import ArrayUtils, { STATE_CODE } from "./ArrayUtils";
+
+/**
+ * ArrayDataModel 本地数据 DataModel
+ */
+class ArrayDataModel extends ArrayUtils {
+  constructor(params) {
+    super(params);
+    const {
+      ctx,
+      query,
+      createApi,
+      createMap,
+      getApi,
+      getMap,
+      getListApi,
+      getListMap,
+      getListFunc,
+      updateApi,
+      updateMap,
+      patchApi,
+      patchMap,
+      deleteApi,
+      multipleDeleteApi,
+    } = params;
+
+    /** 请求 url 替换的额外参数 */
+    this.ctx = ctx || {};
+    /** GET 请求的参数 */
+    this.query = query || {};
+
+    /** POST 接口地址 */
+    this.createApi = createApi;
+    /** POST 接口提交前的数据处理回调 record => (record) */
+    this.createMap = createMap;
+    /** GET 详情 接口地址 */
+    this.getApi = getApi;
+    /** GET 详情 接口返回后的数据处理回调 record => (record) */
+    this.getMap = getMap;
+    /** GET 列表 接口地址 */
+    this.getListApi = getListApi;
+    /** GET 列表 接口返回后的数据处理回调 record => (record) */
+    this.getListMap = getListMap;
+    /** GET 列表 接口回调，用于自定义列表请求接口。query => ({list: [], pagination: { total: 0 }}) 优先级高于 getListApi */
+    this.getListFunc = getListFunc;
+    /** PUT 接口地址 */
+    this.updateApi = updateApi;
+    /** PUT 接口提交前的数据处理回调 record => (record) */
+    this.updateMap = updateMap;
+    /** PATCH 接口地址 */
+    this.patchApi = patchApi;
+    /** PATCH 接口提交前的数据处理回调 record => (record) */
+    this.patchMap = patchMap;
+    /** DELETE 接口地址 */
+    this.deleteApi = deleteApi;
+    /** DELETE 批量删除 接口地址 */
+    this.multipleDeleteApi = multipleDeleteApi;
+
+    const {
+      getListReqMap,
+      getListResMap,
+      getReqMap,
+      getResMap,
+      createReqMap,
+      createResMap,
+      updateReqMap,
+      updateResMap,
+      patchReqMap,
+      patchResMap,
+      deleteReqMap,
+      deleteResMap,
+      multipleDeleteReqMap,
+      multipleDeleteResMap,
+    } = params || {};
+
+    /** GET 列表 接口请求前数据处理回调 */
+    this.getListReqMap = getListReqMap;
+    /** GET 列表 接口请求结果数据处理回调 */
+    this.getListResMap = getListResMap;
+    /** GET 详情 接口请求前数据处理回调 */
+    this.getReqMap = getReqMap;
+    /** GET 详情 接口请求结果数据处理回调 */
+    this.getResMap = getResMap;
+    /** POST 接口请求前数据处理回调 */
+    this.createReqMap = createReqMap;
+    /** POST 接口请求结果数据处理回调 */
+    this.createResMap = createResMap;
+    /** PUT 接口请求前数据处理回调 */
+    this.updateReqMap = updateReqMap;
+    /** PUT 接口请求结果数据处理回调 */
+    this.updateResMap = updateResMap;
+    /** PATCH 接口请求前数据处理回调 */
+    this.patchReqMap = patchReqMap;
+    /** PATCH 接口请求结果数据处理回调 */
+    this.patchResMap = patchResMap;
+    /** DELETE 接口请求前数据处理回调 */
+    this.deleteReqMap = deleteReqMap;
+    /** DELETE 接口请求结果数据处理回调 */
+    this.deleteResMap = deleteResMap;
+    /** DELETE 批量删除 接口请求前数据处理回调 */
+    this.multipleDeleteReqMap = multipleDeleteReqMap;
+    /** DELETE 批量删除 接口请求结果数据处理回调 */
+    this.multipleDeleteResMap = multipleDeleteResMap;
+  }
+
+  /**
+   * GET 详情请求
+   * @param {Object} q query 参数
+   * @returns
+   */
+  get(q = {}) {
+    let query = _.merge({}, this.query, q);
+    query = _.pickBy(query, (val) => !_.isNil(val) && val !== "");
+
+    if (this.getReqMap) {
+      query = this.getReqMap(query);
+    }
+
+    return new Promise((resolve, reject) => {
+      let res = this.findItem(query);
+      if (this.getResMap) {
+        res = this.getResMap(res);
+      }
+      resolve(res);
+    });
+  }
+
+  /**
+   * GET 列表请求
+   * @param {Object} q query 参数
+   * @returns
+   */
+  async getList(q) {
+    let query = _.merge({}, this.query, q);
+    query = _.pickBy(query, (val) => !_.isNil(val) && val !== "");
+
+    if (this.getListReqMap) {
+      query = this.getListReqMap(query);
+    }
+
+    let resultList = null;
+    if (this.getListFunc) {
+      resultList = await this.getListFunc(query);
+      if (this.getListResMap) {
+        resultList = this.getListResMap(resultList);
+      }
+    } else {
+      const getPro = this.findListByQuery(query);
+      resultList = await getPro;
+      if (this.getListResMap) {
+        resultList = this.getListResMap(resultList);
+      }
+    }
+    return resultList;
+  }
+
+  /**
+   * POST 请求
+   * @param {Object} params 参数
+   * @returns
+   */
+  create(params) {
+    return new Promise((resolve, reject) => {
+      const _params = this.handleInputParams(params, this.createReqMap);
+      const res = this.pushItem(_params);
+      if (res === STATE_CODE.SUC) {
+        let _res = {};
+        if (this.createResMap) {
+          _res = this.createResMap();
+        }
+        resolve(_res);
+      } else {
+        reject(res);
+      }
+    });
+  }
+
+  /**
+   * PUT 请求
+   * @param {Object} params 参数
+   * @returns
+   */
+  update(params) {
+    return new Promise((resolve, reject) => {
+      const _params = this.handleInputParams(params, this.updateReqMap);
+      const res = this.replaceItem(_params);
+      if (res === STATE_CODE.SUC) {
+        let _res = {};
+        if (this.updateResMap) {
+          _res = this.updateResMap();
+        }
+        resolve(_res);
+      } else {
+        reject(res);
+      }
+    });
+  }
+
+  /**
+   * PATCH 请求
+   * @param {Object} params 参数
+   * @returns
+   */
+  patch(params) {
+    return new Promise((resolve, reject) => {
+      const _params = this.handleInputParams(params, this.patchReqMap);
+      const res = this.updateItemValue(_params);
+      if (res === STATE_CODE.SUC) {
+        let _res = {};
+        if (this.patchResMap) {
+          _res = this.patchResMap();
+        }
+        resolve(_res);
+      } else {
+        reject(res);
+      }
+    });
+  }
+
+  /**
+   * 删除接口
+   * @param {*} config axios.delete config 参数，
+   * @param {*} config.params axios.delete url 参数，
+   * @param {*} config.data axios.delete data 参数，
+   * @param {*} ctx
+   * @returns
+   */
+  delete(config, ctx) {
+    let _config = _.cloneDeep(config) || {};
+    if (this.deleteReqMap) {
+      _config = this.deleteReqMap(_config);
+    }
+    return new Promise((resolve, reject) => {
+      const { _idKey } = this;
+      const id = config[_idKey] || config.params?.[_idKey] || config.data?.[_idKey] || ctx[_idKey];
+      const res = this.delItem(id);
+      console.log("res", res);
+
+      if (res === STATE_CODE.SUC) {
+        let _res = {};
+        if (this.deleteResMap) {
+          _res = this.deleteResMap();
+        }
+        resolve(_res);
+      } else {
+        reject(res);
+      }
+    });
+  }
+
+  /**
+   * 批量删除接口
+   * @param {*} config axios.delete config 参数，
+   * @param {*} config.params axios.delete url 参数，
+   * @param {*} config.data axios.delete data 参数，
+   * @param {*} ctx
+   * @returns
+   */
+  multipleDelete(config, ctx) {
+    let _config = _.cloneDeep(config) || {};
+    if (this.multipleDeleteReqMap) {
+      _config = this.multipleDeleteReqMap(_config);
+    }
+    return new Promise((resolve, reject) => {
+      const { _idKey } = this;
+      let ids = config[_idKey] || config.params?.[_idKey] || config.data?.[_idKey] || ctx[_idKey];
+
+      if (typeof ids === "string") {
+        ids = ids.split(",");
+      }
+
+      if (Array.isArray(ids)) {
+        const sucList = [];
+        const failList = [];
+        ids.forEach((id) => {
+          try {
+            const res = this.delItem(id);
+            if (res === STATE_CODE.SUC) {
+              sucList.push(id);
+            } else {
+              failList.push(id);
+            }
+          } catch (error) {
+            console.log("error", error);
+          }
+        });
+        if (sucList.length > 0) {
+          let _res = { sucList, failList };
+          if (this.multipleDeleteResMap) {
+            _res = this.multipleDeleteResMap();
+          }
+          resolve(_res);
+        } else {
+          reject({ failList });
+        }
+        return;
+      }
+
+      reject({});
+    });
+  }
+
+  /**
+   * 处理传入的数据
+   * @returns
+   */
+  handleInputParams(params, reqMapFn) {
+    let _params = _.cloneDeep(formDataToObj(params));
+    if (reqMapFn) {
+      _params = reqMapFn.bind(this)(_params, params);
+    }
+    // TODO: FormData 文件存储？
+    // if (params instanceof FormData) {
+    //   _params = objToFormData(_params);
+    // }
+    return _params;
+  }
+
+  handleRes(response, resolve, reject) {
+    if (typeof response !== "object") {
+      reject(new Error("response not object"));
+      return;
+    }
+    let _res = response;
+    //  兼容 传入的是 response.data 的情况
+    if (_res.data && _res.headers && _res.request) {
+      _res = _res.data;
+    }
+    const { code, data } = _res;
+    const message = this.handleMsg(response);
+    if (code == 200) {
+      let _data = data ?? {};
+      if (_.isObject(_data)) {
+        if (_data.content && _data.pageNumber && _data.total) {
+          _data.list = _data.content;
+          _data.pagination = { current: _data.pageNumber, total: _data.total };
+        }
+        // 前缀 _ 避免与 data 里已有的 message 冲突
+        _data._msg = message;
+        _data._message = message;
+      }
+      resolve(_data);
+    } else {
+      const error = new Error(message);
+      error.code = code;
+      error.response = response;
+      error._msg = message;
+      error._message = message;
+      reject(error);
+    }
+  }
+
+  errorHandler(err, reject) {
+    const response = err.response || err;
+    if (response) {
+      const message = this.handleMsg(response, { useStatusText: true });
+      const error = new Error(message);
+      error.code = response.status;
+      error.response = response;
+      if (message) {
+        // 前缀 _ 避免与 data 里已有的 message 冲突
+        error._message = message;
+        error._msg = message;
+      }
+      return reject(error);
+    }
+    return reject(err || { _msg: _$Temp.defaultErrMsg });
+  }
+
+  handleMsg(
+    response,
+    opt = {
+      // 是否使用 response.statusText 作为兜底 msg
+      useStatusText: false,
+    },
+  ) {
+    const {
+      // 是否使用 response.statusText 作为兜底 msg
+      useStatusText,
+    } = opt || {};
+    let message = (response.data && (response.data.message || response.data.msg)) || response.msg;
+
+    if (!message && useStatusText) {
+      message = response.statusText;
+    }
+
+    return message || _$Temp.defaultErrMsg;
+  }
+}
+
+export { ArrayDataModel };
+
+export default ArrayDataModel;

package/src/data-model.js

@@ -1,13 +1,7 @@
 import _ from "lodash";
 import axios from "axios";
 
-const DEFAULT_MSG = "未知错误";
-const NETWORK_MSG = "网络异常，请检查网络是否开启";
-
-const _$Temp = {
-  defaultErrMsg: DEFAULT_MSG,
-  networkErrMsg: NETWORK_MSG,
-};
+import { objToFormData, formDataToObj, _$Temp, setDefaultAxios, setDefaultErrMsg, setNetworkErrMsg } from "./utils";
 
 class DataModel {
   constructor(params) {
@@ -20,7 +14,6 @@ class DataModel {
       getMap,
       getListApi,
       getListMap,
-      // 统一 response 回调，用于处理定制 response 格式
       handleResponse,
       getListFunc,
       updateApi,
@@ -29,35 +22,49 @@ class DataModel {
       patchMap,
       deleteApi,
       multipleDeleteApi,
-      axios: as,
-      axiosConf,
       // 是否返回完整的接口数据（response.data）
       isResponseData,
       // 是否直接返回 response
       isResponse,
     } = params;
 
+    /** 是否返回完整的接口数据（response.data） */
     this.isResponseData = isResponseData;
+    /** 是否直接返回 response */
     this.isResponse = isResponse;
+    /** 统一 response 回调，用于处理定制 response 格式 */
+    this.handleResponse = handleResponse;
 
+    /** 请求 url 替换的额外参数 */
     this.ctx = ctx || {};
+    /** GET 请求的参数 */
     this.query = query || {};
-    this.axios = as || _$Temp.axios || axios;
-    this.axiosConf = axiosConf || {};
 
+    /** POST 接口地址 */
     this.createApi = createApi;
+    /** POST 接口提交前的数据处理回调 record => (record) */
     this.createMap = createMap;
+    /** GET 详情 接口地址 */
     this.getApi = getApi;
+    /** GET 详情 接口返回后的数据处理回调 record => (record) */
     this.getMap = getMap;
+    /** GET 列表 接口地址 */
     this.getListApi = getListApi;
+    /** GET 列表 接口返回后的数据处理回调 record => (record) */
     this.getListMap = getListMap;
-    this.handleResponse = handleResponse;
+    /** GET 列表 接口回调，用于自定义列表请求接口。query => ({list: [], pagination: { total: 0 }}) 优先级高于 getListApi */
     this.getListFunc = getListFunc;
+    /** PUT 接口地址 */
     this.updateApi = updateApi;
+    /** PUT 接口提交前的数据处理回调 record => (record) */
     this.updateMap = updateMap;
+    /** PATCH 接口地址 */
     this.patchApi = patchApi;
+    /** PATCH 接口提交前的数据处理回调 record => (record) */
     this.patchMap = patchMap;
+    /** DELETE 接口地址 */
     this.deleteApi = deleteApi;
+    /** DELETE 批量删除 接口地址 */
     this.multipleDeleteApi = multipleDeleteApi;
 
     const {
@@ -76,22 +83,40 @@ class DataModel {
       multipleDeleteReqMap,
       multipleDeleteResMap,
     } = params || {};
+
+    /** GET 列表 接口请求前数据处理回调 */
     this.getListReqMap = getListReqMap;
+    /** GET 列表 接口请求结果数据处理回调 */
     this.getListResMap = getListResMap;
+    /** GET 详情 接口请求前数据处理回调 */
     this.getReqMap = getReqMap;
+    /** GET 详情 接口请求结果数据处理回调 */
     this.getResMap = getResMap;
+    /** POST 接口请求前数据处理回调 */
     this.createReqMap = createReqMap;
+    /** POST 接口请求结果数据处理回调 */
     this.createResMap = createResMap;
+    /** PUT 接口请求前数据处理回调 */
     this.updateReqMap = updateReqMap;
+    /** PUT 接口请求结果数据处理回调 */
     this.updateResMap = updateResMap;
+    /** PATCH 接口请求前数据处理回调 */
     this.patchReqMap = patchReqMap;
+    /** PATCH 接口请求结果数据处理回调 */
     this.patchResMap = patchResMap;
+    /** DELETE 接口请求前数据处理回调 */
     this.deleteReqMap = deleteReqMap;
+    /** DELETE 接口请求结果数据处理回调 */
     this.deleteResMap = deleteResMap;
+    /** DELETE 批量删除 接口请求前数据处理回调 */
     this.multipleDeleteReqMap = multipleDeleteReqMap;
+    /** DELETE 批量删除 接口请求结果数据处理回调 */
     this.multipleDeleteResMap = multipleDeleteResMap;
 
+    // axios 相关配置
     const {
+      axios: as,
+      axiosConf,
       getListAxiosConf,
       getAxiosConf,
       createAxiosConf,
@@ -100,15 +125,36 @@ class DataModel {
       deleteAxiosConf,
       multipleDeleteAxiosConf,
     } = params || {};
+
+    /** 请求的 axios 实例 */
+    this.axios = as || _$Temp.axios || axios;
+    /** axios 配置 */
+    this.axiosConf = axiosConf || {};
+
+    /** GET 列表接口 axios 配置 */
     this.getListAxiosConf = getListAxiosConf;
+    /** GET 详情接口 axios 配置 */
     this.getAxiosConf = getAxiosConf;
+    /** POST 接口 axios 配置 */
     this.createAxiosConf = createAxiosConf;
+    /** PUT 接口 axios 配置 */
     this.updateAxiosConf = updateAxiosConf;
+    /** PATCH 接口 axios 配置 */
     this.patchAxiosConf = patchAxiosConf;
+    /** DELETE 接口 axios 配置 */
     this.deleteAxiosConf = deleteAxiosConf;
+    /** DELETE 批量删除接口 axios 配置 */
     this.multipleDeleteAxiosConf = multipleDeleteAxiosConf;
   }
 
+  /**
+   * 获取请求 url 地址
+   * @param {string} api 接口地址 https://a.com/test/:oId/:uId
+   * @param {Object} record { uId: 81 }
+   * @param {Object} ctx { oId: 100 }
+   * @param {Object} opt
+   * @returns
+   */
   getApiUrl(api, record, ctx = this.ctx, opt) {
     const { from } = opt ?? {};
     if (!api) {
@@ -126,6 +172,13 @@ class DataModel {
     return apiUrl;
   }
 
+  /**
+   * GET 详情请求
+   * @param {Object} q query 参数
+   * @param {Object} ctx url 替换的额外参数
+   * @param {Object} axiosConf axios 配置
+   * @returns
+   */
   get(q = {}, ctx = {}, axiosConf) {
     let query = _.merge({}, this.query, q);
     query = _.pickBy(query, (val) => !_.isNil(val) && val !== "");
@@ -162,6 +215,13 @@ class DataModel {
     });
   }
 
+  /**
+   * GET 列表请求
+   * @param {Object} q query 参数
+   * @param {Object} ctx url 替换的额外参数
+   * @param {Object} axiosConf axios 配置
+   * @returns
+   */
   async getList(q, ctx, axiosConf) {
     let query = _.merge({}, this.query, q);
     query = _.pickBy(query, (val) => !_.isNil(val) && val !== "");
@@ -209,6 +269,13 @@ class DataModel {
     return resultList;
   }
 
+  /**
+   * POST 请求
+   * @param {Object} params 参数
+   * @param {Object} ctx url 替换的额外参数
+   * @param {Object} axiosConf axios 配置
+   * @returns
+   */
   create(params, ctx, axiosConf) {
     return new Promise((resolve, reject) => {
       const opt = {
@@ -243,6 +310,13 @@ class DataModel {
     });
   }
 
+  /**
+   * PUT 请求
+   * @param {Object} params 参数
+   * @param {Object} ctx url 替换的额外参数
+   * @param {Object} axiosConf axios 配置
+   * @returns
+   */
   update(params, ctx, axiosConf) {
     return new Promise((resolve, reject) => {
       const opt = { ...this.axiosConf, ...this.updateAxiosConf, ...axiosConf };
@@ -273,6 +347,13 @@ class DataModel {
     });
   }
 
+  /**
+   * PATCH 请求
+   * @param {Object} params 参数
+   * @param {Object} ctx url 替换的额外参数
+   * @param {Object} axiosConf axios 配置
+   * @returns
+   */
   patch(params, ctx, axiosConf) {
     return new Promise((resolve, reject) => {
       const opt = { ...this.axiosConf, ...this.patchAxiosConf, ...axiosConf };
@@ -498,46 +579,6 @@ export function checkNetwork() {
   return !noNetwork;
 }
 
-function setDefaultAxios(ax) {
-  if (ax) {
-    _$Temp.axios = ax;
-  }
-}
-
-export function setDefaultErrMsg(msg) {
-  if (msg) {
-    _$Temp.defaultErrMsg = msg;
-  }
-}
-
-export function setNetworkErrMsg(msg) {
-  if (msg) {
-    _$Temp.networkErrMsg = msg;
-  }
-}
-
-export function objToFormData(data) {
-  if (data instanceof FormData) {
-    return data;
-  }
-  const formData = new FormData();
-  Object.keys(data)?.forEach((key) => {
-    formData.set(key, data[key]);
-  });
-  return formData;
-}
-
-export function formDataToObj(formData) {
-  if (!(formData instanceof FormData)) {
-    return formData;
-  }
-  const tempData = {};
-  for (const [key, value] of formData.entries()) {
-    tempData[key] = value;
-  }
-  return tempData;
-}
-
-export { axios, DataModel, setDefaultAxios };
+export { axios, DataModel, formDataToObj, objToFormData, setDefaultAxios, setDefaultErrMsg, setNetworkErrMsg };
 
 export default DataModel;

package/src/utils.js

@@ -0,0 +1,92 @@
+/** 默认错误提示文案 */
+const DEFAULT_MSG = "未知错误";
+/** 网络异常提示文案 */
+const NETWORK_MSG = "网络异常，请检查网络是否开启";
+
+/** 暂存相关变量 */
+export const _$Temp = {
+  defaultErrMsg: DEFAULT_MSG,
+  networkErrMsg: NETWORK_MSG,
+};
+
+/**
+ * 设置默认的 axios
+ * @param {*} ax
+ */
+export function setDefaultAxios(ax) {
+  if (ax) {
+    _$Temp.axios = ax;
+  }
+}
+
+/**
+ * 设置默认的错误提示文案
+ * @param {*} ax
+ */
+export function setDefaultErrMsg(msg) {
+  if (msg) {
+    _$Temp.defaultErrMsg = msg;
+  }
+}
+
+/**
+ * 设置默认的网络异常提示文案
+ * @param {*} ax
+ */
+export function setNetworkErrMsg(msg) {
+  if (msg) {
+    _$Temp.networkErrMsg = msg;
+  }
+}
+
+/**
+ * 检测网络状态
+ * @param {*} errMsg 网络异常消息
+ * @returns
+ */
+export function checkNetwork() {
+  if (!navigator) {
+    return true;
+  }
+  if (navigator.onLine === false) {
+    return false;
+  }
+  const connection = navigator.connection || navigator.mozConnection || navigator.webkitConnection;
+  if (!connection) {
+    return true;
+  }
+  const noNetwork = connection?.type === "none" || connection.downlink === 0 || connection.effectiveType === null;
+  return !noNetwork;
+}
+
+/**
+ * 对象转 FormData 格式
+ * @param {Object} data
+ * @returns
+ */
+export function objToFormData(data) {
+  if (data instanceof FormData) {
+    return data;
+  }
+  const formData = new FormData();
+  Object.keys(data)?.forEach((key) => {
+    formData.set(key, data[key]);
+  });
+  return formData;
+}
+
+/**
+ * FormData 转对象
+ * @param {FormData} formData
+ * @returns
+ */
+export function formDataToObj(formData) {
+  if (!(formData instanceof FormData)) {
+    return formData;
+  }
+  const tempData = {};
+  for (const [key, value] of formData.entries()) {
+    tempData[key] = value;
+  }
+  return tempData;
+}