midway-fatcms 0.0.1-beta.55 → 0.0.1-beta.57

package/src/libs/crud-pro/CrudPro.ts

@@ -0,0 +1,165 @@
+import { ICrudProCfg, ILogger, IRequestCfgModel, IRequestModel, ISqlCfgModel, IVisitor } from './interfaces';
+import { ExecuteContext } from './models/ExecuteContext';
+import { RequestModel } from './models/RequestModel';
+import { CurdProServiceHub } from './services/CurdProServiceHub';
+import { CommonException, Exceptions } from './exceptions';
+import { RequestCfgModel } from './models/RequestCfgModel';
+import { MixinUtils } from './utils/MixinUtils';
+import { Transaction } from './models/Transaction';
+import { IExecuteContextFunc } from './models/ExecuteContextFunc';
+
+class CrudPro {
+  private readonly executeContext: ExecuteContext;
+  private readonly serviceHub: CurdProServiceHub;
+
+  constructor() {
+    this.executeContext = new ExecuteContext();
+    this.serviceHub = new CurdProServiceHub(this.executeContext);
+  }
+
+  // 必填
+  set transaction(transaction: Transaction) {
+    this.executeContext.setTransaction(transaction);
+  }
+  // 必填
+  set logger(logger: ILogger) {
+    this.executeContext.setLogger(logger);
+  }
+  // 必填
+  set visitor(visitor: IVisitor) {
+    this.executeContext.setVisitor(visitor);
+  }
+
+  set contextFunc(contextFunc: IExecuteContextFunc) {
+    contextFunc.setExecuteContext(this.executeContext);
+    this.executeContext.contextFunc = contextFunc;
+  }
+
+  set contextCfg(contextCfg: ICrudProCfg) {
+    this.executeContext.setContextCfg(contextCfg);
+  }
+
+  /**
+   * 直接执行一个SQL
+   * @param sqlCfgModel
+   */
+  public async executeSQL(sqlCfgModel: ISqlCfgModel): Promise<any> {
+    const RES_NAME = 'executeResult';
+
+    const sqlCfgModel2 = {
+      resName: RES_NAME,
+      executeSql: '',
+      executeSqlArgs: [],
+      sqlDatabase: '',
+      ...sqlCfgModel,
+    };
+    Object.assign(sqlCfgModel2, sqlCfgModel);
+
+    const cfgModel: IRequestCfgModel = {
+      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
+   */
+  public async executeCrud(reqJson: IRequestModel, isEnableCache: boolean): Promise<ExecuteContext> {
+    const cfgJson = await this.getCachedCfgByMethod(reqJson.method, isEnableCache);
+    if (!cfgJson) {
+      throw new CommonException(Exceptions.CFG_NOT_FOUND, reqJson.method);
+    }
+    return await this.executeCrudByCfg(reqJson, cfgJson);
+  }
+
+  /**
+   * 核心执行函数，其他都是这个函数的变种
+   * @param reqJson
+   * @param cfgJson
+   */
+  public async executeCrudByCfg(reqJson: IRequestModel, cfgJson: IRequestCfgModel): Promise<ExecuteContext> {
+    const logger = this.executeContext.getLogger();
+    logger.info('CurdPro executeCrudByCfg', cfgJson);
+
+    // 在执行之前可以根据业务需要修改需要执行的内容。
+    await this.beforeExecuteSQLList(reqJson, cfgJson);
+
+    const exeCtx = this.executeContext;
+
+    if (!cfgJson.method) {
+      throw new CommonException(Exceptions.CFG_METHOD_EMPTY, JSON.stringify(cfgJson));
+    }
+
+    reqJson.method = cfgJson.method;
+
+    const reqModel = new RequestModel(reqJson, this.executeContext.getVisitor());
+    const cfgModel = new 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();
+    // 执行SQL
+    await this.executeSQLList();
+    // 执行SQL执行之后的的处理
+    await this.afterExecuteSQLList();
+
+    return exeCtx;
+  }
+
+  public async getCachedCfgByMethod(method: string, isEnableCache: boolean): Promise<IRequestCfgModel> {
+    return this.serviceHub.getCachedCfgByMethod(method, isEnableCache);
+  }
+
+  private async executeSQLList() {
+    try {
+      await this.serviceHub.executeSqlCfgModels();
+    } catch (e) {
+      const message = MixinUtils.getErrorMessage(e);
+      const logger = this.executeContext.getLogger();
+      logger.error('RUN_SQL_EXCEPTION', message);
+      throw this.parseRunSqlException(e || {});
+    }
+  }
+
+  private parseRunSqlException(e: any): CommonException {
+    const sqlMessage = '' + e.sqlMessage;
+    if (e.code === 'ER_DUP_ENTRY' && sqlMessage.startsWith('Duplicate entry')) {
+      return new CommonException(Exceptions.RUN_SQL_EXCEPTION_ER_DUP_ENTRY, '此对象实体已存在，不能创建重复对象');
+    }
+    if (e.code === 'ER_NO_SUCH_TABLE') {
+      return new CommonException(Exceptions.RUN_SQL_EXCEPTION_ER_NO_SUCH_TABLE, '查询的表不存在：' + sqlMessage);
+    }
+    return e;
+  }
+
+  private async afterExecuteSQLList() {
+    return this.executeContext.contextFunc.afterExecuteSQLList();
+  }
+
+  private async beforeExecuteSQLList(reqJson: IRequestModel, cfgJson: IRequestCfgModel) {
+    return this.executeContext.contextFunc.beforeExecuteSQLList(reqJson, cfgJson);
+  }
+}
+
+export { CrudPro };

package/src/libs/crud-pro/defaultConfigs.ts

@@ -0,0 +1,15 @@
+import { ICrudProCfg } from './interfaces';
+import { SqlDbType } from './models/keys';
+
+export const defaultCrudProCfg: ICrudProCfg = {
+  sysDatabaseName: 'fatcms',
+  sysDatabaseDbType: SqlDbType.mysql, // 默认系统数据库名称，默认 mysql
+  sysConfigTableName: 'sys_configs', // 数据表：通用配置
+  dictItemTableName: 'sys_data_dict_item', // 数据表：数据字典，字典项。
+  methodsTableName: 'sys_crud_methods',
+  methodsCacheTime: 1000 * 60,
+  tableMetaCacheTime: 1000 * 3600 * 24 * 365, // 表格元信息缓存时间。 开发环境可以设置的短一些
+};
+
+export const DEFAULT_MAX_LIMIT = 1000;
+export const DEFAULT_LIMIT = 100;

package/src/libs/crud-pro/exceptions.ts

@@ -0,0 +1,124 @@
+export enum Exceptions {
+  NO_AUTH = 'NO_AUTH', // 没有权限
+  NOT_LOGIN = 'NOT_LOGIN', // 没有登陆
+
+  MUST_OBJECT = 'MUST_OBJECT',
+  MUST_NOT_EMPTY = 'MUST_NOT_EMPTY',
+  RUN_GET_COND_OR_DATA_JSONOBJECT = 'RUN_GET_COND_OR_DATA_JSONOBJECT',
+
+  /**
+   * MySQL配置中不存在此数据库
+   */
+  DB_NOT_FOUND = 'DB_NOT_FOUND',
+  DB_QUERY_PARAM_EMPTY = 'DB_QUERY_PARAM_EMPTY',
+
+  /**
+   * 配置错误
+   */
+  CFG_ERROR = 'CFG_ERROR',
+  CFG_NOT_FOUND = 'CFG_NOT_FOUND',
+  CFG_METHOD_EMPTY = 'CFG_METHOD_EMPTY',
+  CFG_AUTH_CODE_EMPTY = 'CFG_AUTH_CODE_EMPTY',
+  CFG_NOT_FOUND_FILE = 'CFG_NOT_FOUND_FILE',
+  CFG_NOT_FOUND_FUNCTION = 'CFG_NOT_FOUND_FUNCTION',
+  CFG_EMPTY_TABLE_NAME = 'CFG_EMPTY_TABLE_NAME',
+  CFG_EMPTY_SQL = 'CFG_EMPTY_SQL',
+  CFG_NOT_SUPPORT_PICK_BY_EXPRESS_SCRIPT = 'CFG_NOT_SUPPORT_PICK_BY_EXPRESS_SCRIPT',
+  CFG_NOT_SUPPORT_THE_SIMPLE_SQL = 'CFG_NOT_SUPPORT_THE_SIMPLE_SQL',
+  CFG_NOT_SUPPORT_THE_SQL = 'CFG_NOT_SUPPORT_THE_SQL',
+  CFG_GET_ATTR_NAME_EMPTY = 'CFG_GET_ATTR_NAME_EMPTY',
+  CFG_GET_ATTR_VALUE_ERROR = 'CFG_GET_ATTR_VALUE_ERROR',
+  CFG_IO_EXCEPTION_GET_CONFIG_BY_METHOD = 'CFG_IO_EXCEPTION_GET_CONFIG_BY_METHOD',
+  CFG_SQLSIMPLENAME_AND_SQLCUSTOMLIST_EMPTY = 'CFG_SQLSIMPLENAME_AND_SQLCUSTOMLIST_EMPTY',
+  CFG_VALIDATE_NOT_JSON_ARRAY = 'CFG_VALIDATE_NOT_JSON_ARRAY',
+  CFG_VALIDATE_LENGTH_ERROR = 'CFG_VALIDATE_LENGTH_ERROR',
+  CFG_VALIDATE_SCALE_ERROR = 'CFG_VALIDATE_SCALE_ERROR',
+  CFG_VALIDATE_ENUM_ERROR = 'CFG_VALIDATE_ENUM_ERROR',
+  CFG_VALIDATE_NOT_SUPPORT = 'CFG_VALIDATE_NOT_SUPPORT',
+  CFG_VALIDATE_CUSTOM_FUNCTION_EMPTY = 'CFG_VALIDATE_CUSTOM_FUNCTION_EMPTY',
+  CFG_VALIDATE_CUSTOM_FUNCTION_MUST_RETURN_BOOL = 'CFG_VALIDATE_CUSTOM_FUNCTION_MUST_RETURN_BOOL',
+  CFG_UPDATE_MUST_JSON_OBJECT = 'CFG_UPDATE_MUST_JSON_OBJECT',
+  CFG_CHECK_EXECUTE_WHEN_EMPTY = 'CFG_CHECK_EXECUTE_WHEN_EMPTY',
+  CFG_IS_NEED_EXECUTE_FUNC_MUST_RETURN_BOOL = 'CFG_IS_NEED_EXECUTE_FUNC_MUST_RETURN_BOOL',
+  CFG_GET_CONNECTION_NULL = 'CFG_GET_CONNECTION_NULL',
+  CFG_SQL_FUNCTION_EMPTY = 'CFG_SQL_FUNCTION_EMPTY',
+  CFG_SQL_CFG_EXECUTE_VALIDATE_EMPTY = 'CFG_SQL_CFG_EXECUTE_VALIDATE_EMPTY',
+  CFG_UPDATE_ITEM_MUST_FUNC_CFG = 'CFG_UPDATE_ITEM_MUST_FUNC_CFG',
+  CFG_PARSE_ERROR = 'CFG_PARSE_ERROR',
+  CFG_ERROR_POSTGRES_UNIQUE_COLUMNS_NULL = 'CFG_ERROR_POSTGRES_UNIQUE_COLUMNS_NULL',
+  CFG_UNIQUE_COLUMN_COUNT_MUST_ONE = 'CFG_UNIQUE_COLUMN_COUNT_MUST_ONE',
+
+  /**
+   * 数据传错
+   */
+  DATA_GET_JSON_OBJECT_ERROR = 'DATA_GET_JSON_OBJECT_ERROR',
+  DATA_GET_DATA_EMPTY = 'DATA_GET_DATA_EMPTY',
+  DATA_GET_DATA_EMPTY_ON_UPDATE = 'DATA_GET_DATA_EMPTY_ON_UPDATE',
+  DATA_GET_DATA_EMPTY_ON_INSERT_KEYS = 'DATA_GET_DATA_EMPTY_ON_INSERT_KEYS',
+  DATA_GET_DATA_EMPTY_ON_INSERT_VALUES = 'DATA_GET_DATA_EMPTY_ON_INSERT_VALUES',
+
+  /**
+   * 请求的Method字段为空
+   */
+  REQUEST_METHOD_EMPTY = 'REQUEST_METHOD_EMPTY', // 解析排序字段失败
+  REQUEST_MUST_JSON_OBJECT = 'REQUEST_MUST_JSON_OBJECT',
+  REQUEST_OR_PARAM_MUST_ARRAY = 'REQUEST_PARAM_MUST_ARRAY',
+  REQUEST_PARAM_MUST_BASIC_TYPE = 'REQUEST_PARAM_MUST_BASIC_TYPE',
+  REQUEST_PARAM_MUST_BASIC_TYPE_ARRAY = 'REQUEST_PARAM_MUST_BASIC_TYPE_ARRAY',
+  REQUEST_MODEL_PARSE_ORDER_BY_FAILED = 'REQUEST_MODEL_PARSE_ORDER_BY_FAILED', // 解析排序字段失败
+  REQUEST_PARAM_ERROR = 'REQUEST_PARAM_ERROR',
+
+  /**
+   * 执行错误
+   */
+  RUN_EMBED_FUNC_ERR = 'RUN_EMBED_FUNC_ERR',
+  RUN_SQL_EXCEPTION = 'RUN_SQL_EXCEPTION',
+  RUN_SQL_EXCEPTION_ER_DUP_ENTRY = 'RUN_SQL_EXCEPTION_ER_DUP_ENTRY',
+  RUN_SQL_EXCEPTION_ER_NO_SUCH_TABLE = 'RUN_SQL_EXCEPTION_ER_NO_SUCH_TABLE',
+  RUN_IS_NEED_EXECUTE_ERR = 'RUN_IS_NEED_EXECUTE_ERR',
+  RUN_PICK_ERR_VISITOR_NULL = 'RUN_PICK_ERR_VISITOR_NULL',
+  RUN_PICK_ERR_VISITOR_FIELD = 'RUN_PICK_ERR_VISITOR_FIELD',
+  RUN_PICK_ERR_VISITOR_FIELD_NULL = 'RUN_PICK_ERR_VISITOR_FIELD_NULL',
+  RUN_EXECUTE_VALIDATE = 'RUN_EXECUTE_VALIDATE',
+  RUN_FUNCTION_NOT_FOUND = 'RUN_FUNCTION_NOT_FOUND',
+
+  /**
+   * 参数校验错误
+   */
+  VALIDATE_ERR = 'VALIDATE_ERR',
+  VALIDATE_ALLOW_ERR = 'VALIDATE_ALLOW_ERR',
+  VALIDATE_REJECT_ERR = 'VALIDATE_REJECT_ERR',
+  VALIDATE_EXCEPTION = 'VALIDATE_EXCEPTION',
+
+  /**
+   * update异常
+   */
+  UPDATE_EXCEPTION = 'UPDATE_EXCEPTION',
+
+  /**
+   * 类型转换错误
+   */
+  CAST_JSON_ARRAY_ERROR = 'CAST_JSON_ARRAY_ERROR',
+  CAST_JSON_OBJECT_ERROR = 'CAST_JSON_OBJECT_ERROR',
+  CAST_TYPE_NOT_SUPPORT = 'CAST_TYPE_NOT_SUPPORT',
+
+  /**
+   * 其他异常
+   */
+  OTHER_EXCEPTION = 'OTHER_EXCEPTION',
+}
+
+export class CommonException {
+  public code: string;
+  public message: string;
+  constructor(code: string, message?: any) {
+    this.code = code;
+    if (message) {
+      if (typeof message === 'object') {
+        this.message = JSON.stringify(message);
+      } else {
+        this.message = '' + message;
+      }
+    }
+  }
+}

package/src/libs/crud-pro/interfaces.ts

@@ -0,0 +1,190 @@
+// import { Pool as MysqlPool } from 'mysql2/promise';
+// import { Pool as PostgresPool } from 'pg';
+import { KeysOfAuthType, KeysOfSimpleSQL, KeysOfValidators, SqlDbType } from './models/keys';
+
+export interface ICrudProCfg {
+  sysDatabaseName?: string; // 默认系统数据库名称，默认 fatcms
+  sysDatabaseDbType?: SqlDbType; // 默认系统数据库名称，默认 mysql
+  methodsTableName?: string; // 方法配置的表名，默认 sys_crud_methods
+  methodsCacheTime?: number; //内存缓存时间默认 1分钟
+  dictItemTableName?: string; // 字典项表名称，默认：sys_data_dict_item
+  sysConfigTableName?: string; // 字典项表名称，默认：sys_configs
+  tableMetaCacheTime?: number; // 表格元信息缓存时间
+}
+
+export interface ITableMeta {
+  expiredTime: number; // 过期时间
+  tableColumns: string[]; // 表格所有字段
+}
+
+export interface IConnectionPool {
+  dbType: SqlDbType;
+  poolName: string;
+  poolInstance: any; //MysqlPool | PostgresPool;
+}
+
+export interface IPoolConnectionClient {
+  query: (sql: string, values: any[]) => Promise<any[]>;
+}
+
+/**
+ * 用户请求
+ */
+export interface IRequestModel {
+  method?: string;
+  columns?: string | string[]; // "columns": "id,name,age,sex,addr",
+  condition?: Record<string, any>; // 拼接查询条件
+  data?: Record<string, any>; //拼接update/insert语句的数据部分
+  orderBy?: string | IOrderByItem[];
+  limit?: number;
+  offset?: number;
+  pageSize?: number;
+  pageNo?: number;
+}
+
+type IBasicType = boolean | string | number;
+
+export interface ICompareCondition {
+  $gt?: IBasicType;
+  $gte?: IBasicType;
+  $lt?: IBasicType;
+  $lte?: IBasicType;
+  $ne?: IBasicType;
+
+  $in?: IRequestCondition[];
+  $nin?: IRequestCondition[];
+  $like?: IBasicType;
+  $match?: IBasicType;
+  $matchBool?: IBasicType;
+  $range?: number[];
+}
+
+export interface IRequestCondition extends Record<string, any>, ICompareCondition {
+  $or?: IRequestCondition[];
+}
+
+/**
+ * 用户基本信息
+ */
+export interface IVisitor {
+  isLogin: boolean;
+  isSuperAdmin: boolean;
+  accountId: string;
+  nickName: string;
+  roleCodes: string[];
+  functionCodes: string[];
+}
+
+/**
+ * 系统只支持Dict和SysConfigEnum两种
+ * 实际配置时，可以配置其他的枚举值，但系统不处理，用户需要在自己的crudConfigFactory.afterExecuteSQLList进行处理
+ */
+export enum BasicRecordEnum {
+  dict = 'dict', // 关联数据字典
+  sysCfgEnum = 'sysCfgEnum', // 配置文件中，必须包含code一列，作为唯一键。
+}
+
+export interface CopyAttr {
+  from: string;
+  to: string;
+}
+
+export interface ColumnRelation {
+  relatedType: any; // 如： dict
+  relatedCode?: string; // SexEnum
+  sourceColumn: string; // 从row中取值的字段名
+  targetColumns?: CopyAttr[]; //[{from:'label', to:'user_sex_text'}]
+}
+
+/**
+ * 基本响应配置
+ */
+export interface IBaseCfgModel {
+  sqlTable?: string; // 可以为空. originSql中不包含@@table时可以为空
+  sqlSchema?: string; // 可以为空
+  sqlDatabase?: string; // 可以为空，用此字段进行connection的选择和切换。配合getBizConnectionPool使用
+  sqlDbType?: SqlDbType; // 数据库类型，mysql(默认) 、postgres
+  maxLimit?: number; // 最大一次性返回的数量
+  columns?: string | string[]; // "columns": "id,name,age,sex,addr",
+  columnsRelation?: ColumnRelation[];
+}
+
+export type IFunctionParam = IFuncCfgModel | string | number | boolean | null;
+export interface IFuncCfgModel extends Record<any, any> {
+  ___PLAIN_OBJECT___?: boolean; // 本身就是一个对象
+  functionName?: string; // 函数名
+  functionParams?: IFunctionParam[]; // 函数参数
+
+  const?: any; // 常量,任意类型。可以是json对象
+  constString?: any; // 常量字符串
+  constNumber?: number; // 常量数字，任意形式, int,bigDecimal,bigInteger，字符串，等。
+  constBool?: boolean; // 常量bool值。与js的判断逻辑一致，false, null, 0 , "" 被认为是 false，其他认为是true
+
+  context?: string; // 从context中取值
+  contextAsString?: string; // 从context中取值
+  contextAsNumber?: string; // 从context中取值
+  contextAsBool?: string; // 从context中取值
+
+  message?: string; // 在校验阶段有用，其他阶段没有用
+}
+
+export interface ISqlCfgModel extends IBaseCfgModel {
+  resName?: string;
+  resPicker?: string;
+  originSql?: string; // 有特殊占位符的SQL, 原始的SQL
+  validate?: IFuncCfgModel; //执行前，进行校验，校验不通过就抛出异常. 校验函数可以返回 boolean或直接抛出异常
+  executeWhen?: IFuncCfgModel; //满足表达式的结果，才能执行。 默认：true 校验函数必须返回 boolean
+  executeSql?: string; // 可以运行的SQL。在postgres/sqlserver环境下也可以使用问号。
+  executeSqlArgs?: any[]; //可以运行的SQL的参数
+  crudType?: string;
+}
+
+/**
+ * 自定义校验函数。如果不正确请抛出异常。{code:'xxx',message:'xxx'}
+ */
+export type ICustomValidateFunc = (value: string) => void;
+
+/**
+ * validateCfg中允许的配置
+ */
+export type IValidatorCfgItem = IFuncCfgModel | KeysOfValidators | string | ICustomValidateFunc;
+
+/**
+ * 接口响应配置
+ */
+export interface IRequestCfgModel extends IBaseCfgModel {
+  method?: string; // 不能为空
+  transactionEnable?: boolean; // 是否开启事务，默认不开启，每条语句都是autocommit
+  transactionIsolation?: number; // 事务隔离级别
+  sqlSimpleName?: KeysOfSimpleSQL; // 二选一 sqlSimpleName  sqlCfgList；； sqlCfgList 优先级高于sqlSimpleName
+  sqlCfgList?: ISqlCfgModel[]; // 二选一 sqlSimpleName  sqlCfgList；； sqlCfgList 优先级高于sqlSimpleName
+  updateCfg?: Record<string, IFuncCfgModel>;
+  allowCfg?: Record<string, string[]>;
+  rejectCfg?: Record<string, string[]>;
+  validateCfg?: Record<string, IValidatorCfgItem[]>;
+  authType?: KeysOfAuthType;
+  authConfig?: string | string[];
+}
+
+export interface IOrderByItem {
+  fieldName: string;
+  orderType: string;
+}
+
+export interface ILimitOffset {
+  limit: number;
+  offset: number;
+}
+
+export interface ILogger {
+  info(msg: any, ...args: any[]): void;
+  debug(msg: any, ...args: any[]): void;
+  error(msg: any, ...args: any[]): void;
+  warn(msg: any, ...args: any[]): void;
+}
+
+export interface IExecuteUnsafeQueryCtx {
+  sqlTable: string;
+  sqlDatabase: string;
+  sqlDbType: SqlDbType;
+}

package/src/libs/crud-pro/models/ExecuteContext.ts

@@ -0,0 +1,120 @@
+import * as _ from 'lodash';
+import { RequestModel } from './RequestModel';
+import { RequestCfgModel } from './RequestCfgModel';
+import { SqlCfgModel } from './SqlCfgModel';
+import { messageParseUtils } from '../utils/MessageParseUtils';
+import { Transaction } from './Transaction';
+import { ColumnRelation, ICrudProCfg, ILogger, IVisitor } from '../interfaces';
+import { IExecuteContextFunc } from './ExecuteContextFunc';
+import { defaultCrudProCfg } from '../defaultConfigs';
+import { ResModelFlexible } from './ResModel';
+
+class ExecuteContext {
+  // 运行前设置的
+  private transaction: Transaction;
+  private logger: ILogger;
+  private visitor: IVisitor;
+  private contextCfg: ICrudProCfg = defaultCrudProCfg;
+  public contextFunc: IExecuteContextFunc;
+
+  // 运行时设置的。
+  private sqlCfgModels: SqlCfgModel[] = [];
+  private reqModel: RequestModel = null;
+  private resModel: ResModelFlexible = {};
+  private cfgModel: RequestCfgModel = null;
+
+  setTransaction(transaction: Transaction) {
+    this.transaction = transaction;
+  }
+  getTransaction(): Transaction {
+    return this.transaction;
+  }
+
+  setContextCfg(contextCfg: ICrudProCfg) {
+    if (typeof contextCfg === 'object') {
+      Object.assign(this.contextCfg, contextCfg);
+    }
+  }
+
+  getContextCfg(): ICrudProCfg {
+    return this.contextCfg;
+  }
+
+  setLogger(logger: ILogger) {
+    this.logger = logger;
+  }
+  getLogger(): ILogger {
+    return this.logger;
+  }
+
+  setVisitor(visitor: IVisitor) {
+    this.visitor = visitor;
+  }
+  getVisitor(): IVisitor {
+    return this.visitor;
+  }
+
+  getReqModel(): RequestModel {
+    return this.reqModel;
+  }
+
+  setReqModel(reqModel: RequestModel) {
+    this.reqModel = reqModel;
+  }
+
+  getResModel(): ResModelFlexible {
+    return this.resModel;
+  }
+
+  getOneObj() {
+    return this.resModel['row'];
+  }
+
+  getResRows(): any[] {
+    return this.resModel['rows'];
+  }
+
+  setResModelItem(resName: string, data: any) {
+    this.resModel[resName] = data;
+  }
+
+  getResModelItem(resName: string): any {
+    return this.resModel[resName];
+  }
+
+  getResModelItemLodash(resName: string): any {
+    return _.get(this.resModel, resName);
+  }
+
+  setCfgModel(cfgModel: RequestCfgModel) {
+    this.cfgModel = cfgModel;
+  }
+
+  getCfgModel(): RequestCfgModel {
+    return this.cfgModel;
+  }
+
+  getSqlCfgModels(): SqlCfgModel[] {
+    return this.sqlCfgModels;
+  }
+
+  getResMessage(): string {
+    return messageParseUtils.getResMessage(this);
+  }
+}
+
+interface IExecuteContextCustom {
+  rows: any[];
+  columnsRelation?: ColumnRelation[];
+  isCustomContext?: boolean;
+}
+
+type HandleExecuteContextType = ExecuteContext | IExecuteContextCustom;
+// type HandleExecuteContextType = IExecuteContextCustom
+
+interface IExecuteContextHandler {
+  handleExecuteContextPrepare(executeContext: HandleExecuteContextType): Promise<void>;
+  handleExecuteContext(executeContext: HandleExecuteContextType): Promise<void>;
+}
+
+export { ExecuteContext, IExecuteContextHandler, HandleExecuteContextType, IExecuteContextCustom };