sohelp-eleplus 1.1.21 → 1.1.22

package/cache/DictCache.js

@@ -5,11 +5,21 @@ import { ElMessage } from 'element-plus';
  * 字典缓存
  */
 export class DictCache {
+  /**
+   * 构造函数
+   * 初始化缓存Map和并发请求Promise
+   */
   constructor() {
     this.cache = new Map(); // 使用 Map 作为缓存存储结构
     this.initPromise = null; // 防止并发重复请求
   }
-  //初始化字典数据
+  /**
+   * 初始化字典数据
+   * 
+   * 首次调用时从后端获取字典数据并缓存，后续调用直接返回Promise。
+   * 防止并发重复请求。
+   * @returns {Promise<void>}
+   */
   async init() {
     if (this.initPromise) return this.initPromise;
     this.initPromise = getDictData()
@@ -22,34 +32,55 @@ export class DictCache {
     await this.initPromise;
     this.initPromise = null;
   }
-  //设置字典数据
+  /**
+   * 批量设置字典数据
+   * @param {Object} data 字典数据对象，key为字典编码，value为字典项列表
+   */
   setData(data) {
     for (let key in data) {
       this.set(key, data[key]);
     }
   }
-  // 设置缓存
+  /**
+   * 设置缓存
+   * @param {string} key 字典编码
+   * @param {Array} value 字典项列表
+   */
   set(key, value) {
     this.cache.set(key, value);
   }
-  // 获取缓存
+  /**
+   * 获取缓存
+   * 如果缓存为空，会先触发初始化
+   * @param {string} key 字典编码
+   * @returns {Promise<Array|null>} 字典项列表或null
+   */
   async get(key) {
     if (this.cache.size === 0) {
       await this.init();
     }
     return this.cache.has(key) ? this.cache.get(key) : null;
   }
-  // 检查缓存是否存在
+  /**
+   * 检查缓存是否存在
+   * @param {string} key 字典编码
+   * @returns {boolean}
+   */
   has(key) {
     return this.cache.has(key);
   }
 
-  // 删除缓存
+  /**
+   * 删除缓存
+   * @param {string} key 字典编码
+   */
   delete(key) {
     this.cache.delete(key);
   }
 
-  // 清空缓存
+  /**
+   * 清空所有字典缓存
+   */
   clear() {
     this.cache.clear();
   }

package/cache/ModuleCache.js

@@ -6,6 +6,17 @@ import { ElMessage } from "element-plus";
  * 模块缓存
  */
 class ModuleCache {
+  /**
+   * 构造函数
+   * 
+   * 初始化各类缓存Map：
+   * - moduleCache: 模块缓存
+   * - layoutCache: 布局缓存
+   * - gridCache: 网格缓存
+   * - entityFormCache: 实体表单缓存
+   * - entityGridCache: 实体网格缓存
+   * - workflowCache: 工作流缓存
+   */
   constructor() {
     // 使用 Map 作为缓存模块存储结构
     this.moduleCache = new Map();
@@ -147,7 +158,13 @@ class ModuleCache {
   }
 
 
-  //获取缓存
+  /**
+   * 获取模块配置缓存
+   * 
+   * 如果缓存中不存在，会尝试从后端加载并缓存。
+   * @param {string} refid 模块引用ID
+   * @returns {Promise<Object|null>} 模块配置对象或null
+   */
   async getModule(refid) {
     const moduleRef = refid.split("!")[0];
     if (!this.hasModule(refid)) {

package/cache/README.md

@@ -0,0 +1,53 @@
+# 缓存管理 (Cache)
+
+本文档列出了 `src/components/sohelp-eleplus/cache` 目录下的缓存管理类。这些类主要用于在前端缓存频繁访问的数据（如字典、模块配置），以减少网络请求并提升应用性能。
+
+## 1. DictCache (字典缓存)
+
+用于缓存系统字典数据。通常在应用启动或首次访问字典时加载所有字典数据，后续访问直接从内存中获取。
+
+| 方法名 | 说明 | 参数 |
+| :--- | :--- | :--- |
+| `init()` | 初始化字典数据 | - |
+| `get(key)` | 获取指定编码的字典项列表 | `key`: 字典编码<br>返回: `Promise<Array>` |
+| `set(key, value)` | 手动设置字典缓存 | `key`: 字典编码<br>`value`: 字典项列表 |
+| `has(key)` | 检查是否存在指定字典 | `key`: 字典编码 |
+| `delete(key)` | 删除指定字典缓存 | `key`: 字典编码 |
+| `clear()` | 清空所有字典缓存 | - |
+
+**使用示例:**
+```javascript
+import { dictCache } from './DictCache';
+
+// 获取性别字典
+const genderList = await dictCache.get('gender');
+```
+
+## 2. ModuleCache (模块配置缓存)
+
+用于缓存低代码模块的元数据配置，包括模块信息、布局、列表配置、表单配置和工作流配置。
+
+| 方法名 | 说明 | 参数 |
+| :--- | :--- | :--- |
+| `init(refid)` | 初始化指定模块的配置 | `refid`: 模块引用ID |
+| `getModule(refid)` | 获取模块基础信息 | `refid`: 模块引用ID |
+| `getLayout(refid)` | 获取模块布局配置 | `refid`: 模块引用ID |
+| `getGrid(refid)` | 获取模块列表(Grid)配置 | `refid`: 模块引用ID |
+| `getEntityForm(refid)` | 获取实体表单配置 | `refid`: 模块引用ID |
+| `getWorkflow(refid)` | 获取工作流配置 | `refid`: 模块引用ID |
+| `clear()` | 清空所有模块相关缓存 | - |
+
+**缓存结构:**
+- `moduleCache`: 模块基础信息
+- `layoutCache`: 界面布局配置
+- `gridCache`: 列表视图配置
+- `entityFormCache`: 实体表单配置
+- `workflowCache`: 工作流配置
+
+**使用示例:**
+```javascript
+import { moduleCache } from './ModuleCache';
+
+// 获取模块配置
+const moduleConfig = await moduleCache.getModule('user_module');
+```

package/http/CrudHttp.js

@@ -6,9 +6,13 @@ import SohelpHttp from "./SohelpHttp";
 export const CrudHttp = {
   /**
    * 表单初始化数据
-   * @param refid
-   * @param params
-   * @param callback
+   * 
+   * 获取表单初始化所需的数据，如默认值、选项等。
+   * 
+   * @param {string} refid 模块引用ID
+   * @param {Object} [params={}] 请求参数
+   * @param {Function} [callback] 请求完成后的回调函数
+   * @returns {Promise<any>} 返回Promise对象
    */
   initial: function(refid, params = {}, callback) {
     params["refid"] = refid;
@@ -16,9 +20,13 @@ export const CrudHttp = {
   },
   /**
    * 根据ID获取某一行数据
-   * @param refid
-   * @param params
-   * @param callback
+   * 
+   * 用于获取单行数据的详细信息。
+   * 
+   * @param {string} refid 模块引用ID
+   * @param {Object} [params={}] 请求参数，通常包含 id
+   * @param {Function} [callback] 请求完成后的回调函数
+   * @returns {Promise<any>} 返回Promise对象
    */
   getById: function(refid, params = {}, callback) {
     params["refid"] = refid;
@@ -26,9 +34,13 @@ export const CrudHttp = {
   },
   /**
    * 根据ID,获取主体数据和外键数据
-   * @param refid
-   * @param params
-   * @param callback
+   * 
+   * 获取详细数据，包括关联的外键数据。
+   * 
+   * @param {string} refid 模块引用ID
+   * @param {Object} [params={}] 请求参数，通常包含 id
+   * @param {Function} [callback] 请求完成后的回调函数
+   * @returns {Promise<any>} 返回Promise对象
    */
   detail: function(refid, params = {}, callback) {
     params["refid"] = refid;
@@ -36,9 +48,13 @@ export const CrudHttp = {
   },
   /**
    * 根据外键分页读取数据列表
-   * @param refid 网格列表
-   * @param data
-   * @param callback
+   * 
+   * 用于加载子表或关联表的分页数据。
+   * 
+   * @param {string} refid 模块引用ID
+   * @param {Object} [params={}] 请求参数，包含分页信息和外键条件
+   * @param {Function} [callback] 请求完成后的回调函数
+   * @returns {Promise<any>} 返回Promise对象
    */
   pageByFk: function(refid, params = {}, callback) {
     params["refid"] = refid;
@@ -46,10 +62,13 @@ export const CrudHttp = {
   },
   /**
    * 保存单据
-   * @param refid 模块地址
-   * @param data 数据对象
-   * @param callback 回调函数
-   * @returns {Promise<axios.AxiosResponse<any>>}
+   * 
+   * 保存表单数据（通用保存接口）。
+   * 
+   * @param {string} refid 模块引用ID
+   * @param {Object} [data={}] 表单数据对象
+   * @param {Function} [callback] 请求完成后的回调函数
+   * @returns {Promise<axios.AxiosResponse<any>>} 返回Promise对象
    */
   save: function(refid, data = {}, callback) {
     data["refid"] = refid;
@@ -57,10 +76,13 @@ export const CrudHttp = {
   },
   /**
    * 创建单据
-   * @param refid 模块地址
-   * @param data 数据对象
-   * @param callback 回调函数
-   * @returns {Promise<axios.AxiosResponse<any>>}
+   * 
+   * 创建新的单据记录。
+   * 
+   * @param {string} refid 模块引用ID
+   * @param {Object} [data={}] 表单数据对象
+   * @param {Function} [callback] 请求完成后的回调函数
+   * @returns {Promise<axios.AxiosResponse<any>>} 返回Promise对象
    */
   create: function(refid, data = {}, callback) {
     data["refid"] = refid;
@@ -68,10 +90,13 @@ export const CrudHttp = {
   },
   /**
    * 更新单据
-   * @param refid 模块地址
-   * @param data 数据对象
-   * @param callback 回调函数
-   * @returns {Promise<axios.AxiosResponse<any>>}
+   * 
+   * 更新已存在的单据记录。
+   * 
+   * @param {string} refid 模块引用ID
+   * @param {Object} [data={}] 表单数据对象，通常包含 id
+   * @param {Function} [callback] 请求完成后的回调函数
+   * @returns {Promise<axios.AxiosResponse<any>>} 返回Promise对象
    */
   update: function(refid, data = {}, callback) {
     data["refid"] = refid;
@@ -79,10 +104,13 @@ export const CrudHttp = {
   },
   /**
    * 删除单据
-   * @param refid 模块地址
-   * @param data 数据对象
-   * @param callback 回调函数
-   * @returns {Promise<axios.AxiosResponse<any>>}
+   * 
+   * 删除指定的单据记录。
+   * 
+   * @param {string} refid 模块引用ID
+   * @param {Object} [data={}] 数据对象，通常包含 id 或 ids
+   * @param {Function} [callback] 请求完成后的回调函数
+   * @returns {Promise<axios.AxiosResponse<any>>} 返回Promise对象
    */
   delete: function(refid, data = {}, callback) {
     data["refid"] = refid;
@@ -90,10 +118,13 @@ export const CrudHttp = {
   },
   /**
    * 单据分页
-   * @param refid 模块地址
-   * @param params 数据对象
-   * @param callback 回调函数
-   * @returns {Promise<axios.AxiosResponse<any>>}
+   * 
+   * 获取主表的分页数据列表。
+   * 
+   * @param {string} refid 模块引用ID
+   * @param {Object} [params={}] 查询参数，包含分页、排序和筛选条件
+   * @param {Function} [callback] 请求完成后的回调函数
+   * @returns {Promise<axios.AxiosResponse<any>>} 返回Promise对象
    */
   page: async function(refid, params = {}, callback) {
     params["refid"] = refid;
@@ -101,10 +132,13 @@ export const CrudHttp = {
   },
   /**
    * 单据详情
-   * @param refid 模块地址
-   * @param params 数据对象
-   * @param callback 回调函数
-   * @returns {Promise<axios.AxiosResponse<any>>}
+   * 
+   * 获取单据的详细信息，通常用于查看或编辑页面。
+   * 
+   * @param {string} refid 模块引用ID
+   * @param {Object} [params={}] 查询参数，通常包含 id
+   * @param {Function} [callback] 请求完成后的回调函数
+   * @returns {Promise<axios.AxiosResponse<any>>} 返回Promise对象
    */
   detail: async function(refid, params = {}, callback) {
     params["refid"] = refid;

package/http/DictHttp.js

@@ -1,7 +1,11 @@
 
 
 /**
- * 字典数据
+ * 获取所有字典数据
+ * 
+ * 从后端加载完整的字典数据列表。
+ * 
+ * @returns {Promise<*>} 返回包含字典数据的Promise对象
  */
 export async function getDictData() {
   const res = await SohelpHttp.get('/engine/web/dict/list', {});

package/http/ModuleHttp.js

@@ -2,8 +2,11 @@
 
 /**
  * 获取界面配置
- * @param refid
- * @returns {Promise<*>}
+ * 
+ * 获取指定模块的界面布局配置信息。
+ * 
+ * @param {string} refid 模块引用ID
+ * @returns {Promise<*>} 返回布局配置数据
  */
 export async function getLayout(refid) {
   const res = await SohelpHttp.get("/engine/web/layout/read", {refid});
@@ -14,9 +17,12 @@ export async function getLayout(refid) {
 }
 
 /**
- * 获取界面配置
- * @param refid
- * @returns {Promise<*>}
+ * 获取模块配置
+ * 
+ * 获取模块的元数据定义，包括字段、属性等信息。
+ * 
+ * @param {string} refid 模块引用ID
+ * @returns {Promise<*>} 返回模块配置数据
  */
 export async function getModule(refid) {
   const res = await SohelpHttp.get("/engine/web/module/read", {refid});
@@ -29,8 +35,11 @@ export async function getModule(refid) {
 
 /**
  * 保存属性配置
- * @param {*} data
- * @returns
+ * 
+ * 保存用户对表格列的筛选、排序等个性化配置。
+ * 
+ * @param {*} data 配置数据对象
+ * @returns {Promise<*>} 返回保存结果
  */
 export async function saveGridFilter(data) {
   const res = await SohelpHttp.post('/engine/web/module/grid/save', data);
@@ -43,8 +52,11 @@ export async function saveGridFilter(data) {
 
 /**
  * 重置列设置
- * @param {*} refid
- * @returns
+ * 
+ * 恢复表格列的默认配置。
+ * 
+ * @param {*} refid 模块引用ID
+ * @returns {Promise<string>} 返回操作消息
  */
 export async function resetCommonConfig(refid) {
   const res = await SohelpHttp.post('/engine/web/module/grid/resetCommonConfig', refid);
@@ -56,8 +68,11 @@ export async function resetCommonConfig(refid) {
 
 /**
  * 更新列设置
- * @param {*} refid
- * @returns
+ * 
+ * 更新表格列的通用配置。
+ * 
+ * @param {*} data 配置数据对象
+ * @returns {Promise<string>} 返回操作消息
  */
 export async function updateCommonConfig(data) {
   const res = await SohelpHttp.post('/engine/web/module/grid/updateCommonConfig', data);

package/http/README.md

@@ -0,0 +1,50 @@
+# HTTP 接口文档
+
+本文档列出了 `src/components/sohelp-eleplus/http` 目录下的所有 HTTP 接口封装。
+
+## 1. SohelpHttp (核心请求工具)
+
+封装了基础的 Axios 请求方法，提供统一的错误处理和参数序列化。
+
+| 方法名 | 说明 | 参数 |
+| :--- | :--- | :--- |
+| `getBaseUrl()` | 获取后端上下文地址 | - |
+| `download(_url, param, fileName, onProgress, config)` | 下载文件 | `_url`: 请求地址<br>`param`: 请求参数<br>`fileName`: 文件名<br>`onProgress`: 进度回调<br>`config`: Axios配置 |
+| `get(url, param, callback)` | 发送 GET 请求 | `url`: 请求地址<br>`param`: 请求参数<br>`callback`: 回调函数 |
+| `post(url, param, callback, error)` | 发送 POST 请求 | `url`: 请求地址<br>`param`: 请求参数<br>`callback`: 回调函数<br>`error`: 错误回调 |
+
+## 2. CrudHttp (增删改查操作)
+
+封装了通用的 CRUD 接口，用于与后端引擎进行数据交互。
+
+| 方法名 | 说明 | 参数 |
+| :--- | :--- | :--- |
+| `initial(refid, params, callback)` | 表单初始化数据 | `refid`: 模块引用ID<br>`params`: 其他参数<br>`callback`: 回调函数 |
+| `getById(refid, params, callback)` | 根据ID获取某一行数据 | `refid`: 模块引用ID<br>`params`: 包含id等参数<br>`callback`: 回调函数 |
+| `detail(refid, params, callback)` | 根据ID获取主体数据和外键数据 | `refid`: 模块引用ID<br>`params`: 参数<br>`callback`: 回调函数 |
+| `pageByFk(refid, params, callback)` | 根据外键分页读取数据列表 | `refid`: 模块引用ID<br>`params`: 参数<br>`callback`: 回调函数 |
+| `save(refid, data, callback)` | 保存单据 | `refid`: 模块引用ID<br>`data`: 数据对象<br>`callback`: 回调函数 |
+| `create(refid, data, callback)` | 创建单据 | `refid`: 模块引用ID<br>`data`: 数据对象<br>`callback`: 回调函数 |
+| `update(refid, data, callback)` | 更新单据 | `refid`: 模块引用ID<br>`data`: 数据对象<br>`callback`: 回调函数 |
+| `delete(refid, data, callback)` | 删除单据 | `refid`: 模块引用ID<br>`data`: 数据对象<br>`callback`: 回调函数 |
+| `page(refid, params, callback)` | 单据分页查询 | `refid`: 模块引用ID<br>`params`: 查询参数<br>`callback`: 回调函数 |
+
+## 3. ModuleHttp (模块配置)
+
+用于获取和保存模块的界面配置、列设置等。
+
+| 方法名 | 说明 | 参数 |
+| :--- | :--- | :--- |
+| `getLayout(refid)` | 获取界面布局配置 | `refid`: 模块引用ID |
+| `getModule(refid)` | 获取模块配置 | `refid`: 模块引用ID |
+| `saveGridFilter(data)` | 保存列表属性配置 | `data`: 配置数据 |
+| `resetCommonConfig(refid)` | 重置列设置 | `refid`: 模块引用ID |
+| `updateCommonConfig(data)` | 更新列设置 | `data`: 配置数据 |
+
+## 4. DictHttp (字典数据)
+
+用于获取系统字典数据。
+
+| 方法名 | 说明 | 参数 |
+| :--- | :--- | :--- |
+| `getDictData()` | 获取所有字典数据 | - |

package/http/SohelpHttp.js

@@ -1,16 +1,14 @@
 /**
  * axios实例
  */
-import { ElMessageBox } from "element-plus/es";
-
+import { ElMessageBox } from 'element-plus/es';
 
 export const SohelpHttp = {
-
   /**
    * 获取后端上下文地址
    */
-  getBaseUrl(){
-    return window.$axios.defaults.baseURL
+  getBaseUrl() {
+    return window.$axios.defaults.baseURL;
   },
 
   /**
@@ -22,30 +20,34 @@ export const SohelpHttp = {
    * @param config
    * @returns {Promise<never>}
    */
-  download: async function(_url, param, fileName, onProgress, config = {}) {
+  download: async function (_url, param, fileName, onProgress, config = {}) {
     if (window.$axios == null) {
-      console.error("请在配置main.js中配置window.$axios实例！！");
+      console.error('请在配置main.js中配置window.$axios实例！！');
       return;
     }
     try {
       if (!fileName) {
-        fileName = (new Date()).getTime();
+        fileName = new Date().getTime();
       }
-      // 发起POST请求，设置responseType为blob
-      const response = await window.$axios.post(_url, param || {}, {
-        responseType: 'blob',
-        ...config,
-        onDownloadProgress: (evt) => {
-          if (typeof onProgress === "function") {
-            const total = evt?.total || 0;
-            const loaded = evt?.loaded || 0;
-            onProgress(loaded, total);
+      // 发起GET请求，设置responseType为blob
+      const response = await window.$axios
+        .get(_url, {
+          params: param || {},
+          responseType: 'blob',
+          ...config,
+          onDownloadProgress: (evt) => {
+            if (typeof onProgress === 'function') {
+              const total = evt?.total || 0;
+              const loaded = evt?.loaded || 0;
+              onProgress(loaded, total);
+            }
           }
-        }
-      }).catch(e => {
-        return Promise.reject(e.message);
-      });
-      if (response.type === "application/json") {
+        })
+        .catch((e) => {
+          return Promise.reject(e.message);
+        });
+
+      if (response.type === 'application/json') {
         try {
           const text = await response.text();
           const res = JSON.parse(text);
@@ -53,7 +55,7 @@ export const SohelpHttp = {
             return res.data;
           } else {
             if (res?.meta?.error) {
-              console.log("SohelpHttp.download:", res.meta.error);
+              console.log('SohelpHttp.download:', res.meta.error);
             }
             return Promise.reject(new Error(res.meta.message));
           }
@@ -63,10 +65,12 @@ export const SohelpHttp = {
         return;
       }
       // 创建一个链接元素用于下载
-      const url = window.URL.createObjectURL(response);
-      const link = document.createElement("a");
+      const url = _url + '?' + new URLSearchParams(param).toString();
+      // const url = window.URL.createObjectURL(response.data);
+      const link = document.createElement('a');
       link.href = url;
-      link.setAttribute("download", fileName); // 设置下载的文件名
+      link.target = '_blank';
+      link.setAttribute('download', fileName); // 设置下载的文件名
       document.body.appendChild(link);
 
       // 触发下载
@@ -78,52 +82,47 @@ export const SohelpHttp = {
       return Promise.reject(error);
     }
   },
-  get: function(url, param, callback) {
+  get: function (url, param, callback) {
     if (window.$axios == null) {
-      console.error("请在配置main.js中配置window.$axios实例！！");
+      console.error('请在配置main.js中配置window.$axios实例！！');
       return;
     }
     for (const key in param) {
-      if (typeof param[key] === "object" && param[key] !== null) {
+      if (typeof param[key] === 'object' && param[key] !== null) {
         param[key] = JSON.stringify(param[key]); // 转换为 JSON 字符串
       }
     }
     let promise = window.$axios.get(url, { params: param });
     return promise.then((r) => {
       if (!r.meta.success && r.meta.error) {
-        console.error(
-          "(GET请求URL):",
-          url,
-          "(请求参数):",
-          param,
-          "(返回结果):",
-          r.meta.error
-        );
+        console.error('(GET请求URL):', url, '(请求参数):', param, '(返回结果):', r.meta.error);
       }
-      if (typeof callback === "function") {
+      if (typeof callback === 'function') {
         callback.call(this, r);
       }
       return Promise.resolve(r);
     });
   },
-  post: function(url, param, callback, error) {
+  /**
+   * 发送POST请求
+   *
+   * @param {string} url 请求地址
+   * @param {Object} param 请求参数
+   * @param {Function} [callback] 请求成功后的回调函数
+   * @param {Function} [error] 错误回调函数（目前未使用）
+   * @returns {Promise<any>} 返回Promise对象
+   */
+  post: function (url, param, callback, error) {
     if (window.$axios == null) {
-      console.error("请在配置main.js中配置window.$axios实例！！");
+      console.error('请在配置main.js中配置window.$axios实例！');
       return;
     }
     let promise = window.$axios.post(url, param);
     return promise.then((r) => {
       if (!r.meta.success && r.meta.error) {
-        console.error(
-          "(GET请求URL):",
-          url,
-          "(请求参数):",
-          param,
-          "(返回结果):",
-          r.meta.error
-        );
+        console.error('(GET请求URL):', url, '(请求参数):', param, '(返回结果):', r.meta.error);
       }
-      if (typeof callback === "function") {
+      if (typeof callback === 'function') {
         callback.call(this, r);
       }
       return Promise.resolve(r);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sohelp-eleplus",
-  "version": "1.1.21",
+  "version": "1.1.22",
   "description": "SohelpEleplus Extension Components",
   "public": true,
   "main": "index.js",