midway-fatcms 0.0.3 → 0.0.4

package/dist/libs/crud-pro/CrudPro.d.ts

@@ -1,37 +1,51 @@
-import { ICrudProCfg, ILogger, IRequestCfgModel, IRequestModel, ISqlCfgModel, IVisitor } from './interfaces';
-import { ExecuteContext } from './models/ExecuteContext';
-import { Transaction } from './models/Transaction';
-import { IExecuteContextFunc } from './models/ExecuteContextFunc';
-declare class CrudPro {
-    private readonly executeContext;
-    private readonly serviceHub;
-    constructor();
-    set transaction(transaction: Transaction);
-    set logger(logger: ILogger);
-    set visitor(visitor: IVisitor);
-    set contextFunc(contextFunc: IExecuteContextFunc);
-    set contextCfg(contextCfg: ICrudProCfg);
-    /**
-     * 直接执行一个SQL
-     * @param sqlCfgModel
-     */
-    executeSQL(sqlCfgModel: ISqlCfgModel): Promise<any>;
-    /**
-     * 从DB中读取配置
-     * @param reqJson
-     * @param isEnableCache
-     */
-    executeCrud(reqJson: IRequestModel, isEnableCache: boolean): Promise<ExecuteContext>;
-    /**
-     * 核心执行函数，其他都是这个函数的变种
-     * @param reqJson
-     * @param cfgJson
-     */
-    executeCrudByCfg(reqJson: IRequestModel, cfgJson: IRequestCfgModel): Promise<ExecuteContext>;
-    getCachedCfgByMethod(method: string, isEnableCache: boolean): Promise<IRequestCfgModel>;
-    private executeSQLList;
-    private parseRunSqlException;
-    private afterExecuteSQLList;
-    private beforeExecuteSQLList;
-}
-export { CrudPro };
+import { ICrudProCfg, ILogger, IRequestCfgModel, IRequestModel, ISqlCfgModel, IVisitor } from './interfaces';
+import { ExecuteContext } from './models/ExecuteContext';
+import { Transaction } from './models/Transaction';
+import { IExecuteContextFunc } from './models/ExecuteContextFunc';
+declare class CrudPro {
+    private readonly executeContext;
+    private readonly serviceHub;
+    constructor();
+    set transaction(transaction: Transaction);
+    set logger(logger: ILogger);
+    set visitor(visitor: IVisitor);
+    set contextFunc(contextFunc: IExecuteContextFunc);
+    set contextCfg(contextCfg: ICrudProCfg);
+    /**
+     * 直接执行一个SQL
+     * @param sqlCfgModel
+     */
+    executeSQL(sqlCfgModel: ISqlCfgModel): Promise<any>;
+    /**
+     * 从DB中读取配置
+     * @param reqJson
+     * @param isEnableCache
+     */
+    executeCrud(reqJson: IRequestModel, isEnableCache: boolean): Promise<ExecuteContext>;
+    /**
+     * 核心执行函数，其他都是这个函数的变种
+     * @param reqJson
+     * @param cfgJson
+     */
+    executeCrudByCfg(reqJson: IRequestModel, cfgJson: IRequestCfgModel): Promise<ExecuteContext>;
+    getCachedCfgByMethod(method: string, isEnableCache: boolean): Promise<IRequestCfgModel>;
+    /**
+     * 如果是 INSERT/UPDATE 操作（sqlSimpleName 模式），根据真实表结构过滤 reqModel.data 中的字段
+     * 避免传入不存在的字段导致 SQL 执行报错
+     * 注意：只处理 sqlSimpleName 模式，不处理 sqlCfgList 模式
+     * @param reqModel 请求模型
+     * @param cfgModel 配置模型
+     */
+    private filterDataByTableMetaIfNeeded;
+    /**
+     * 判断 sqlSimpleName 是否为 INSERT/UPDATE 类型
+     * @param sqlSimpleName 简单 SQL 名称
+     * @returns 是否为 INSERT/UPDATE 类型
+     */
+    private isSimpleInsertOrUpdateType;
+    private executeSQLList;
+    private parseRunSqlException;
+    private afterExecuteSQLList;
+    private beforeExecuteSQLList;
+}
+export { CrudPro };

package/dist/libs/crud-pro/CrudPro.js

@@ -1,146 +1,207 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CrudPro = void 0;
-const ExecuteContext_1 = require("./models/ExecuteContext");
-const RequestModel_1 = require("./models/RequestModel");
-const CurdProServiceHub_1 = require("./services/CurdProServiceHub");
-const exceptions_1 = require("./exceptions");
-const RequestCfgModel_1 = require("./models/RequestCfgModel");
-const MixinUtils_1 = require("./utils/MixinUtils");
-class CrudPro {
-    constructor() {
-        this.executeContext = new ExecuteContext_1.ExecuteContext();
-        this.serviceHub = new CurdProServiceHub_1.CurdProServiceHub(this.executeContext);
-    }
-    // 必填
-    set transaction(transaction) {
-        this.executeContext.setTransaction(transaction);
-    }
-    // 必填
-    set logger(logger) {
-        this.executeContext.setLogger(logger);
-    }
-    // 必填
-    set visitor(visitor) {
-        this.executeContext.setVisitor(visitor);
-    }
-    set contextFunc(contextFunc) {
-        contextFunc.setExecuteContext(this.executeContext);
-        this.executeContext.contextFunc = contextFunc;
-    }
-    set contextCfg(contextCfg) {
-        this.executeContext.setContextCfg(contextCfg);
-    }
-    /**
-     * 直接执行一个SQL
-     * @param sqlCfgModel
-     */
-    async executeSQL(sqlCfgModel) {
-        const RES_NAME = 'executeResult';
-        const sqlCfgModel2 = {
-            resName: RES_NAME,
-            executeSql: '',
-            executeSqlArgs: [],
-            sqlDatabase: '',
-            ...sqlCfgModel,
-        };
-        Object.assign(sqlCfgModel2, sqlCfgModel);
-        const cfgModel = {
-            method: `executeSQL:${sqlCfgModel2.executeSql}`,
-            sqlTable: '',
-            sqlSimpleName: null,
-            sqlDatabase: sqlCfgModel.sqlDatabase,
-            sqlCfgList: [sqlCfgModel2],
-        };
-        const ss = await this.executeCrudByCfg({}, cfgModel);
-        return ss.getResModelItem(RES_NAME);
-    }
-    /**
-     * 从DB中读取配置
-     * @param reqJson
-     * @param isEnableCache
-     */
-    async executeCrud(reqJson, isEnableCache) {
-        const cfgJson = await this.getCachedCfgByMethod(reqJson.method, isEnableCache);
-        if (!cfgJson) {
-            throw new exceptions_1.CommonException(exceptions_1.Exceptions.CFG_NOT_FOUND, reqJson.method);
-        }
-        return await this.executeCrudByCfg(reqJson, cfgJson);
-    }
-    /**
-     * 核心执行函数，其他都是这个函数的变种
-     * @param reqJson
-     * @param cfgJson
-     */
-    async executeCrudByCfg(reqJson, cfgJson) {
-        const logger = this.executeContext.getLogger();
-        logger.info('CurdPro executeCrudByCfg', cfgJson);
-        // 在执行之前可以根据业务需要修改需要执行的内容。
-        await this.beforeExecuteSQLList(reqJson, cfgJson);
-        const exeCtx = this.executeContext;
-        if (!cfgJson.method) {
-            throw new exceptions_1.CommonException(exceptions_1.Exceptions.CFG_METHOD_EMPTY, JSON.stringify(cfgJson));
-        }
-        reqJson.method = cfgJson.method;
-        const reqModel = new RequestModel_1.RequestModel(reqJson, this.executeContext.getVisitor());
-        const cfgModel = new RequestCfgModel_1.RequestCfgModel(cfgJson);
-        exeCtx.setReqModel(reqModel);
-        exeCtx.setCfgModel(cfgModel);
-        // 参数校验
-        this.serviceHub.validateByAllow(cfgModel, reqModel);
-        this.serviceHub.validateByReject(cfgModel, reqModel);
-        this.serviceHub.validateByCfg(cfgModel, reqModel);
-        // 权限校验
-        await this.serviceHub.validateByAuthCfg(cfgModel, reqModel);
-        // 默认参数设置
-        await this.serviceHub.updateByCfg(cfgModel, reqModel);
-        // 生成SQL
-        await this.serviceHub.generateSQLList();
-        try {
-            // 执行SQL
-            await this.executeSQLList();
-            // 执行SQL执行之后的的处理
-            await this.afterExecuteSQLList();
-        }
-        catch (e) {
-            throw e;
-        }
-        finally {
-            // 再次尝试释放一下资源。避免因为不正确的使用方式导致，连接未释放。
-            const txObj = this.executeContext.getTransaction();
-            await txObj.releaseTxOnlyReleased();
-        }
-        return exeCtx;
-    }
-    async getCachedCfgByMethod(method, isEnableCache) {
-        return this.serviceHub.getCachedCfgByMethod(method, isEnableCache);
-    }
-    async executeSQLList() {
-        try {
-            await this.serviceHub.executeSqlCfgModels();
-        }
-        catch (e) {
-            const message = MixinUtils_1.MixinUtils.getErrorMessage(e);
-            const logger = this.executeContext.getLogger();
-            logger.error('RUN_SQL_EXCEPTION', message);
-            throw this.parseRunSqlException(e || {});
-        }
-    }
-    parseRunSqlException(e) {
-        const sqlMessage = '' + e.sqlMessage;
-        if (e.code === 'ER_DUP_ENTRY' && sqlMessage.startsWith('Duplicate entry')) {
-            return new exceptions_1.CommonException(exceptions_1.Exceptions.RUN_SQL_EXCEPTION_ER_DUP_ENTRY, '此对象实体已存在，不能创建重复对象');
-        }
-        if (e.code === 'ER_NO_SUCH_TABLE') {
-            return new exceptions_1.CommonException(exceptions_1.Exceptions.RUN_SQL_EXCEPTION_ER_NO_SUCH_TABLE, '查询的表不存在：' + sqlMessage);
-        }
-        return e;
-    }
-    async afterExecuteSQLList() {
-        return this.executeContext.contextFunc.afterExecuteSQLList();
-    }
-    async beforeExecuteSQLList(reqJson, cfgJson) {
-        return this.executeContext.contextFunc.beforeExecuteSQLList(reqJson, cfgJson);
-    }
-}
-exports.CrudPro = CrudPro;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CrudPro = void 0;
+const ExecuteContext_1 = require("./models/ExecuteContext");
+const RequestModel_1 = require("./models/RequestModel");
+const CurdProServiceHub_1 = require("./services/CurdProServiceHub");
+const exceptions_1 = require("./exceptions");
+const RequestCfgModel_1 = require("./models/RequestCfgModel");
+const MixinUtils_1 = require("./utils/MixinUtils");
+const keys_1 = require("./models/keys");
+class CrudPro {
+    constructor() {
+        this.executeContext = new ExecuteContext_1.ExecuteContext();
+        this.serviceHub = new CurdProServiceHub_1.CurdProServiceHub(this.executeContext);
+    }
+    // 必填
+    set transaction(transaction) {
+        this.executeContext.setTransaction(transaction);
+    }
+    // 必填
+    set logger(logger) {
+        this.executeContext.setLogger(logger);
+    }
+    // 必填
+    set visitor(visitor) {
+        this.executeContext.setVisitor(visitor);
+    }
+    set contextFunc(contextFunc) {
+        contextFunc.setExecuteContext(this.executeContext);
+        this.executeContext.contextFunc = contextFunc;
+    }
+    set contextCfg(contextCfg) {
+        this.executeContext.setContextCfg(contextCfg);
+    }
+    /**
+     * 直接执行一个SQL
+     * @param sqlCfgModel
+     */
+    async executeSQL(sqlCfgModel) {
+        const RES_NAME = 'executeResult';
+        const sqlCfgModel2 = {
+            resName: RES_NAME,
+            executeSql: '',
+            executeSqlArgs: [],
+            sqlDatabase: '',
+            ...sqlCfgModel,
+        };
+        Object.assign(sqlCfgModel2, sqlCfgModel);
+        const cfgModel = {
+            method: `executeSQL:${sqlCfgModel2.executeSql}`,
+            sqlTable: '',
+            sqlSimpleName: null,
+            sqlDatabase: sqlCfgModel.sqlDatabase,
+            sqlCfgList: [sqlCfgModel2],
+        };
+        const ss = await this.executeCrudByCfg({}, cfgModel);
+        return ss.getResModelItem(RES_NAME);
+    }
+    /**
+     * 从DB中读取配置
+     * @param reqJson
+     * @param isEnableCache
+     */
+    async executeCrud(reqJson, isEnableCache) {
+        const cfgJson = await this.getCachedCfgByMethod(reqJson.method, isEnableCache);
+        if (!cfgJson) {
+            throw new exceptions_1.CommonException(exceptions_1.Exceptions.CFG_NOT_FOUND, reqJson.method);
+        }
+        return await this.executeCrudByCfg(reqJson, cfgJson);
+    }
+    /**
+     * 核心执行函数，其他都是这个函数的变种
+     * @param reqJson
+     * @param cfgJson
+     */
+    async executeCrudByCfg(reqJson, cfgJson) {
+        const logger = this.executeContext.getLogger();
+        logger.info('CurdPro executeCrudByCfg', cfgJson);
+        // 在执行之前可以根据业务需要修改需要执行的内容。
+        await this.beforeExecuteSQLList(reqJson, cfgJson);
+        const exeCtx = this.executeContext;
+        if (!cfgJson.method) {
+            throw new exceptions_1.CommonException(exceptions_1.Exceptions.CFG_METHOD_EMPTY, JSON.stringify(cfgJson));
+        }
+        reqJson.method = cfgJson.method;
+        const reqModel = new RequestModel_1.RequestModel(reqJson, this.executeContext.getVisitor());
+        const cfgModel = new RequestCfgModel_1.RequestCfgModel(cfgJson);
+        exeCtx.setReqModel(reqModel);
+        exeCtx.setCfgModel(cfgModel);
+        // 如果是 sqlSimpleName模式的 update/insert，则需要将 reqJson.data 部分根据真实的表结构进行过滤
+        await this.filterDataByTableMetaIfNeeded(reqModel, cfgModel);
+        // 参数校验
+        this.serviceHub.validateByAllow(cfgModel, reqModel);
+        this.serviceHub.validateByReject(cfgModel, reqModel);
+        this.serviceHub.validateByCfg(cfgModel, reqModel);
+        // 权限校验
+        await this.serviceHub.validateByAuthCfg(cfgModel, reqModel);
+        // 默认参数设置
+        await this.serviceHub.updateByCfg(cfgModel, reqModel);
+        // 生成SQL
+        await this.serviceHub.generateSQLList();
+        try {
+            // 执行SQL
+            await this.executeSQLList();
+            // 执行SQL执行之后的的处理
+            await this.afterExecuteSQLList();
+        }
+        catch (e) {
+            throw e;
+        }
+        finally {
+            // 再次尝试释放一下资源。避免因为不正确的使用方式导致，连接未释放。
+            const txObj = this.executeContext.getTransaction();
+            await txObj.releaseTxOnlyReleased();
+        }
+        return exeCtx;
+    }
+    async getCachedCfgByMethod(method, isEnableCache) {
+        return this.serviceHub.getCachedCfgByMethod(method, isEnableCache);
+    }
+    /**
+     * 如果是 INSERT/UPDATE 操作（sqlSimpleName 模式），根据真实表结构过滤 reqModel.data 中的字段
+     * 避免传入不存在的字段导致 SQL 执行报错
+     * 注意：只处理 sqlSimpleName 模式，不处理 sqlCfgList 模式
+     * @param reqModel 请求模型
+     * @param cfgModel 配置模型
+     */
+    async filterDataByTableMetaIfNeeded(reqModel, cfgModel) {
+        // 只有在有 data 数据时才需要过滤
+        if (!reqModel.data || Object.keys(reqModel.data).length === 0) {
+            return;
+        }
+        // 只处理 sqlSimpleName 模式
+        const sqlSimpleName = cfgModel.sqlSimpleName;
+        if (!sqlSimpleName) {
+            return;
+        }
+        // 判断是否为 INSERT/UPDATE 类型的简单 SQL
+        if (!this.isSimpleInsertOrUpdateType(sqlSimpleName)) {
+            return;
+        }
+        // 构建 SqlCfgModel 用于获取表结构
+        const sqlCfgModel = {
+            sqlTable: cfgModel.sqlTable,
+            sqlSchema: cfgModel.sqlSchema,
+            sqlDatabase: cfgModel.sqlDatabase,
+            sqlDbType: cfgModel.sqlDbType,
+            columns: cfgModel.columns,
+            columnsRelation: cfgModel.columnsRelation,
+        };
+        const filteredData = await this.serviceHub.filterDataByTableMeta(reqModel.data, sqlCfgModel);
+        // 记录被过滤的字段
+        const originalKeys = Object.keys(reqModel.data);
+        const filteredKeys = Object.keys(filteredData);
+        const removedKeys = originalKeys.filter(key => !filteredKeys.includes(key));
+        if (removedKeys.length > 0) {
+            this.executeContext.getLogger().info('CrudPro.filterDataByTableMetaIfNeeded: 过滤掉表中不存在的字段', {
+                table: cfgModel.sqlTable,
+                removedFields: removedKeys,
+            });
+        }
+        // 直接修改 reqModel.data，只保留表中存在的字段
+        reqModel.data = filteredData;
+    }
+    /**
+     * 判断 sqlSimpleName 是否为 INSERT/UPDATE 类型
+     * @param sqlSimpleName 简单 SQL 名称
+     * @returns 是否为 INSERT/UPDATE 类型
+     */
+    isSimpleInsertOrUpdateType(sqlSimpleName) {
+        const insertOrUpdateTypes = [
+            keys_1.KeysOfSimpleSQL.SIMPLE_INSERT,
+            keys_1.KeysOfSimpleSQL.SIMPLE_UPDATE,
+            keys_1.KeysOfSimpleSQL.SIMPLE_INSERT_ON_DUPLICATE_UPDATE,
+            keys_1.KeysOfSimpleSQL.SIMPLE_INSERT_OR_UPDATE,
+        ];
+        return insertOrUpdateTypes.includes(sqlSimpleName);
+    }
+    async executeSQLList() {
+        try {
+            await this.serviceHub.executeSqlCfgModels();
+        }
+        catch (e) {
+            const message = MixinUtils_1.MixinUtils.getErrorMessage(e);
+            const logger = this.executeContext.getLogger();
+            logger.error('RUN_SQL_EXCEPTION', message);
+            throw this.parseRunSqlException(e || {});
+        }
+    }
+    parseRunSqlException(e) {
+        const sqlMessage = '' + e.sqlMessage;
+        if (e.code === 'ER_DUP_ENTRY' && sqlMessage.startsWith('Duplicate entry')) {
+            return new exceptions_1.CommonException(exceptions_1.Exceptions.RUN_SQL_EXCEPTION_ER_DUP_ENTRY, '此对象实体已存在，不能创建重复对象');
+        }
+        if (e.code === 'ER_NO_SUCH_TABLE') {
+            return new exceptions_1.CommonException(exceptions_1.Exceptions.RUN_SQL_EXCEPTION_ER_NO_SUCH_TABLE, '查询的表不存在：' + sqlMessage);
+        }
+        return e;
+    }
+    async afterExecuteSQLList() {
+        return this.executeContext.contextFunc.afterExecuteSQLList();
+    }
+    async beforeExecuteSQLList(reqJson, cfgJson) {
+        return this.executeContext.contextFunc.beforeExecuteSQLList(reqJson, cfgJson);
+    }
+}
+exports.CrudPro = CrudPro;

package/dist/libs/crud-pro/defaultConfigs.d.ts

@@ -1,4 +1,4 @@
-import { ICrudProCfg } from './interfaces';
-export declare const defaultCrudProCfg: ICrudProCfg;
-export declare const DEFAULT_MAX_LIMIT = 1000;
-export declare const DEFAULT_LIMIT = 100;
+import { ICrudProCfg } from './interfaces';
+export declare const defaultCrudProCfg: ICrudProCfg;
+export declare const DEFAULT_MAX_LIMIT = 1000;
+export declare const DEFAULT_LIMIT = 100;

package/dist/libs/crud-pro/defaultConfigs.js

@@ -1,15 +1,15 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_LIMIT = exports.DEFAULT_MAX_LIMIT = exports.defaultCrudProCfg = void 0;
-const keys_1 = require("./models/keys");
-exports.defaultCrudProCfg = {
-    sysDatabaseName: 'fatcms',
-    sysDatabaseDbType: keys_1.SqlDbType.mysql,
-    sysConfigTableName: 'sys_configs',
-    dictItemTableName: 'sys_data_dict_item',
-    methodsTableName: 'sys_crud_methods',
-    methodsCacheTime: 1000 * 60,
-    tableMetaCacheTime: 1000 * 3600 * 24 * 365, // 表格元信息缓存时间。 开发环境可以设置的短一些
-};
-exports.DEFAULT_MAX_LIMIT = 1000;
-exports.DEFAULT_LIMIT = 100;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_LIMIT = exports.DEFAULT_MAX_LIMIT = exports.defaultCrudProCfg = void 0;
+const keys_1 = require("./models/keys");
+exports.defaultCrudProCfg = {
+    sysDatabaseName: 'fatcms',
+    sysDatabaseDbType: keys_1.SqlDbType.mysql,
+    sysConfigTableName: 'sys_configs',
+    dictItemTableName: 'sys_data_dict_item',
+    methodsTableName: 'sys_crud_methods',
+    methodsCacheTime: 1000 * 60,
+    tableMetaCacheTime: 1000 * 3600 * 24 * 365, // 表格元信息缓存时间。 开发环境可以设置的短一些
+};
+exports.DEFAULT_MAX_LIMIT = 1000;
+exports.DEFAULT_LIMIT = 100;