chanjs 2.3.1 → 2.5.0

package/App.js

@@ -2,18 +2,18 @@ import express from "express";
 import fs from "fs";
 import path from "path";
 
-import AppContext from "./base/Context.js";
+// 引入基础组件
 import Controller from "./base/Controller.js";
-import DatabaseManager from "./base/Database.js";
-
 import Service from "./base/Service.js";
+import DatabaseManager from "./base/Database.js";
 
+// 引入配置和工具
 import { Paths } from "./config/index.js";
 import { getChildrenId, filterBody, filterImgFromStr, CODE as commonCode, sendMail, genRegEmailHtml, genResetPasswordEmail, pages, getHtmlFilesSync } from "./common/index.js";
-import { db, loadConfig, loadController, loaderSort, prefixDbConfig, formatDateFields, request, delImg, getIp, setToken, getToken, verifyToken, generateToken, getFileTree, readFileContent, saveFileContent, isPathSafe, arrToObj, htmlDecode } from "./helper/index.js";
+import { loadConfig, loadController, loaderSort, formatDateFields, request, delImg, getIp, setToken, getToken, verifyToken, generateToken, getFileTree, readFileContent, saveFileContent, isPathSafe, arrToObj, htmlDecode } from "./helper/index.js";
 import { Cors, setBody, setCookie, setFavicon, setHeader, setStatic, setTemplate, waf } from "./middleware/index.js";
-import { errorResponse, notFoundResponse, parseDatabaseError } from "./utils/error-handler.js";
-import { error as responseError, fail, success } from "./utils/response.js";
+import { errorResponse, notFoundResponse, parseDatabaseError, error as responseError, fail, success, checkKeywords } from "./utils/index.js";
+import { importFile, importjs } from "./global/import.js";
 
 import "./global/index.js";
 
@@ -22,14 +22,14 @@ import "./global/index.js";
  * @class Chan
  * @description 管理应用程序的路由、中间件、数据库连接和服务
  * @example
- * const app = new Chan({ port: 3000, env: "production" });
+ * const app = new Chan();
  * await app.start();
  */
 class Chan {
+
+  // 静态属性：提供全局访问的辅助函数和工具
   static helper = {
     loadController,
-    db,
-    prefixDbConfig,
     loaderSort,
     loadConfig,
     formatDateFields,
@@ -47,6 +47,8 @@ class Chan {
     arrToObj,
     htmlDecode,
   };
+
+  // 静态属性：提供全局访问的常用业务函数和工具
   static common = {
     success,
     fail,
@@ -61,31 +63,35 @@ class Chan {
     filterBody,
     filterImgFromStr,
   };
+
+  // 静态属性：提供全局访问的配置
   static config = {};
+  // 静态属性：提供全局访问的数据库
+  static db = {};
+  // 静态属性：提供全局访问的服务类
   static Service = Service;
+  // 静态属性：提供全局访问的控制器类
   static Controller = Controller;
+  // 静态属性：提供全局访问的路径配置
   static paths = Paths;
+  // 静态属性：提供全局访问的导入函数
+  static importFile = importFile;
+  static importjs = importjs;
+  // 静态属性：提供全局访问的工具函数
+  static utils = {
+    checkKeywords,
+  };
 
   /**
    * 构造函数
    * @constructor
-   * @param {Object} options - 应用配置选项
-   * @param {number} [options.port=3000] - 服务器端口
-   * @param {string} [options.env] - 运行环境
    * @description 初始化 Express 应用和核心组件
    */
-  constructor(options = {}) {
+  constructor() {
     this.app = express();
-    this.context = new AppContext();
+    // 数据库连接管理
     this.dbManager = new DatabaseManager();
-
-    this.options = {
-      port: options.port || 3000,
-      env: options.env || process.env.NODE_ENV || "development",
-      ...options,
-    };
-
-   
+    // 应用路由
     this.router = express.Router();
   }
 
@@ -97,10 +103,6 @@ class Chan {
    * @returns {Promise<void>}
    */
   async start() {
-   
-    global.appContext = this.context;
-    global.Chan = Chan;
-
     //加载配置
     await this.config();
     //加载数据库
@@ -117,19 +119,17 @@ class Chan {
     this.useRouter();
     //404 500 处理
     this.setErrorHandler();
-
   }
 
   /**
    * 加载配置
    * @async
    * @returns {Promise<void>}
-   * @description 加载应用配置并设置到上下文
+   * @description 加载应用配置并设置到全局变量
    */
   async config() {
     let config = await loadConfig();
     Chan.config = config;
-    this.context.set("config", config);
   }
 
   /**
@@ -140,17 +140,15 @@ class Chan {
    */
   async loadDB() {
     const dbList = Chan.config?.db || [];
-    const connections = this.dbManager.getConnections();
 
     for (const [index, item] of dbList.entries()) {
       const key = item.key || String(index);
       try {
-        const dbConfig = prefixDbConfig(key) || item;
+        const dbConfig = item;
         if (!dbConfig) throw new Error("未找到配置");
 
         const connection = this.dbManager.add(key, dbConfig, { isDefault: index === 0 });
-        this.context.set(`db:${key}`, connection);
-        
+
         if (index === 0) {
           Chan.db = connection;
         }
@@ -160,7 +158,7 @@ class Chan {
     }
 
     console.log(
-      `[DB] 初始化完成，已加载 ${dbList.length} 个数据库，成功 ${Object.keys(connections).length} 个`,
+      `[DB] 初始化完成，已加载 ${dbList.length} 个数据库`,
     );
   }
 
@@ -195,7 +193,7 @@ class Chan {
       const files = fs.readdirSync(_path).filter((file) => file.endsWith(".js"));
       for (const file of files) {
         const filePath = path.join(_path, file);
-        let helperModule = await importFile(filePath);
+        let helperModule = await Chan.importFile(filePath);
         Object.assign(Chan[key], helperModule);
       }
     }
@@ -221,7 +219,7 @@ class Chan {
         PROXY = "false", 
         waf: wafConfig = { enabled: false } 
       } = config;
-
+    
     await waf(this.app, wafConfig);
     setFavicon(this.app);
     setStatic(this.app, statics);
@@ -239,7 +237,6 @@ class Chan {
    */
   setApp() {
     this.app.set("trust proxy", Chan.config.PROXY === "true");
-    this.app.set("env", this.options.env);
     this.app.disable("x-powered-by");
   }
 
@@ -349,7 +346,7 @@ class Chan {
     if (fs.existsSync(configPath)) {
       const dirs = loaderSort(Chan.config.modules);
       for (const item of dirs) {
-        let router = await importFile(`app/modules/${item}/router.js`);
+        let router = await Chan.importFile(`app/modules/${item}/router.js`);
         router(this.app, this.router, Chan.config);
       }
     }
@@ -362,7 +359,7 @@ class Chan {
    * @description 加载 app/router.js 中的公共路由
    */
   async loadCommonRouter() {
-    let router = await importFile("app/router.js");
+    let router = await Chan.importFile("app/router.js");
     if (router) {
       router(this.app, this.router, Chan.config);
     }
@@ -374,11 +371,13 @@ class Chan {
    * @description 在启动前执行回调，传递端口号
    */
   run(cb) {
-    this.app.listen(this.options.port, () => {
-        console.log(`Server running on port ${this.options.port}`);
-        cb?.(this.options.port);
+    this.app.listen(Chan.config.PORT, () => {
+        console.log(`Server running on port ${Chan.config.PORT}`);
+        cb?.(Chan.config.PORT);
       });
   }
 }
 
+global.Chan = Chan;
+
 export default Chan;

package/base/Controller.js

@@ -1,92 +1,21 @@
-import { success, fail, error as responseError } from "../utils/response.js";
+import { success, fail } from "../utils/response.js";
 
 /**
  * 控制器基类
  * 提供统一的响应格式和常用方法
  */
 export default class Controller {
-  /**
-   * 构造函数
-   * @param {Object} context - 应用上下文实例
-   */
-  constructor(context = null) {
-    if (context) {
-      this.context = context;
-    } else if (global.appContext) {
-      this.context = global.appContext;
-    } else {
-      this.context = { get: () => null, set: () => null };
-    }
-  }
-
-  /**
-   * 标准化返回结果
-   * @private
-   * @param {*} result - 原始结果
-   * @param {string} defaultMsg - 默认消息
-   * @returns {Object} 标准化的结果对象
-   */
-  _normalizeResult(result, defaultMsg = "操作成功") {
-    if (result === null || result === undefined) {
-      return { success: false, code: 5001, msg: "Service 返回空值", data: {} };
-    }
-
-    if (typeof result === 'object' && 'success' in result) {
-      return result;
-    }
-
-    if (typeof result === 'object' || Array.isArray(result)) {
-      return { success: true, code: 200, msg: defaultMsg, data: result };
-    }
-
-    return { success: true, code: 200, msg: defaultMsg, data: result };
-  }
+  constructor() {}
 
   /**
    * 返回成功响应
-   * @param {*} options - 响应选项或数据
+   * @param {Object} options - 响应选项
    * @param {*} options.data - 响应数据
    * @param {string} options.msg - 响应消息，默认"操作成功"
    * @returns {Object} 标准成功响应
    */
-  success(options, msg = "操作成功") {
-    let data, message = msg, extra = {};
-
-    if (options === null || options === undefined) {
-      data = undefined;
-    } else if (typeof options === 'object' && options !== null && !Array.isArray(options)) {
-      if ('data' in options) {
-        data = options.data;
-        message = options.msg || msg;
-        extra = { ...options };
-        delete extra.data;
-        delete extra.msg;
-      } else if ('success' in options && 'code' in options) {
-        return options;
-      } else {
-        data = options;
-      }
-    } else {
-      data = options;
-    }
-
-    if (data instanceof Error) {
-      return this.error({ err: data });
-    }
-
-    const normalized = this._normalizeResult(data, message);
-    
-    if (!normalized.success) {
-      return this.fail({ msg: normalized.msg, data: normalized.data, code: normalized.code });
-    }
-
-    return {
-      success: true,
-      code: 200,
-      msg: normalized.msg,
-      data: normalized.data,
-      ...extra
-    };
+  success({ data, msg = "操作成功" } = {}) {
+    return success({ data, msg });
   }
 
   /**
@@ -100,38 +29,4 @@ export default class Controller {
   fail({ msg = "操作失败", data = {}, code = 201 } = {}) {
     return fail({ msg, data, code });
   }
-
-  /**
-   * 返回错误响应
-   * @param {Object} options - 响应选项
-   * @param {Error} options.err - 错误对象
-   * @param {*} options.data - 响应数据
-   * @param {number} options.code - 错误码，默认500
-   * @returns {Object} 标准错误响应
-   */
-  error({ err, data = {}, code = 500 } = {}) {
-    return responseError({ err, data, code });
-  }
-
-  /**
-   * 返回分页响应
-   * @param {Array} list - 数据列表
-   * @param {number} total - 总记录数
-   * @param {number} current - 当前页码
-   * @param {number} pageSize - 每页大小
-   * @returns {Object} 标准分页响应
-   */
-  paginate(list, total, current, pageSize) {
-    return success({
-      data: {
-        list,
-        pagination: {
-          total,
-          current,
-          pageSize,
-          totalPages: Math.ceil(total / pageSize),
-        },
-      },
-    });
-  }
 }

package/base/Database.js

@@ -2,7 +2,7 @@ import knex from "knex";
 
 /**
  * 数据库管理器类
- * 用于管理多个数据库连接和创建数据模型
+ * 用于管理多个数据库连接
  */
 class DatabaseManager {
   /**
@@ -78,237 +78,6 @@ class DatabaseManager {
     }
   }
 
-  /**
-   * 关闭所有数据库连接
-   * @returns {Promise<void>}
-   */
-  async closeAll() {
-    const closePromises = [];
-    for (const [name, connection] of this._connections) {
-      closePromises.push(
-        connection.destroy().catch((err) => {
-          console.error(`Error closing database "${name}":`, err);
-        })
-      );
-    }
-    await Promise.all(closePromises);
-    this._connections.clear();
-  }
-
-  /**
-   * 获取所有连接名称
-   * @returns {Array<string>} 连接名称数组
-   */
-  getConnections() {
-    return Array.from(this._connections.keys());
-  }
-
-  /**
-   * 创建数据模型
-   * @param {string} name - 模型名称
-   * @param {string} tableName - 表名
-   * @param {string} connectionName - 连接名称
-   * @returns {Object} 模型对象
-   */
-  createModel(name, tableName, connectionName) {
-    const db = this.get(connectionName);
-    return {
-      db,
-      tableName,
-
-      /**
-       * 查询字段
-       * @param {string} fields - 字段列表，默认"*"
-       * @returns {Object} Knex查询构建器
-       */
-      select(fields = "*") {
-        return db(this.tableName).select(fields);
-      },
-
-      /**
-       * 条件查询
-       * @param {Object} conditions - 查询条件
-       * @returns {Object} Knex查询构建器
-       */
-      where(conditions) {
-        return db(this.tableName).where(conditions);
-      },
-
-      /**
-       * 查找记录
-       * @param {Object} query - 查询参数
-       * @param {Object} query.sort - 排序条件
-       * @param {Object} query.where - 查询条件
-       * @returns {Promise<Array>} 查询结果数组
-       */
-      find(query = {}) {
-        let q = db(this.tableName);
-        const { sort, ...where } = query;
-
-        if (Object.keys(where).length > 0) {
-          q = q.where(where);
-        }
-
-        if (sort && typeof sort === "object") {
-          for (const [field, dir] of Object.entries(sort)) {
-            q = q.orderBy(field, dir);
-          }
-        }
-
-        return q.select();
-      },
-
-      /**
-       * 查找单条记录
-       * @param {Object} query - 查询条件
-       * @returns {Promise<Object|null>} 查询结果或null
-       */
-      findOne(query = {}) {
-        let q = db(this.tableName);
-        if (Object.keys(query).length > 0) {
-          q = q.where(query);
-        }
-        return q.first();
-      },
-
-      /**
-       * 根据ID查找记录
-       * @param {number|string} id - 记录ID
-       * @returns {Promise<Object|null>} 查询结果或null
-       */
-      findById(id) {
-        return db(this.tableName).where({ id }).first();
-      },
-
-      /**
-       * 创建记录
-       * @param {Object} data - 要插入的数据
-       * @returns {Promise<Array>} 插入结果
-       */
-      create(data) {
-        return db(this.tableName).insert(data);
-      },
-
-      /**
-       * 批量创建记录
-       * @param {Array} records - 要插入的记录数组
-       * @returns {Promise<Array>} 插入结果
-       */
-      createMany(records) {
-        return db(this.tableName).insert(records);
-      },
-
-      /**
-       * 更新记录
-       * @param {Object} conditions - 更新条件
-       * @param {Object} data - 更新数据
-       * @returns {Promise<number>} 影响的行数
-       */
-      update(conditions, data) {
-        return db(this.tableName).where(conditions).update(data);
-      },
-
-      /**
-       * 删除记录
-       * @param {Object} conditions - 删除条件
-       * @returns {Promise<number>} 影响的行数
-       */
-      delete(conditions) {
-        return db(this.tableName).where(conditions).del();
-      },
-
-      /**
-       * 统计记录数
-       * @param {Object} query - 查询条件
-       * @returns {Promise<number>} 记录总数
-       */
-      count(query = {}) {
-        let q = db(this.tableName).count("* as total");
-        if (Object.keys(query).length > 0) {
-          q = q.where(query);
-        }
-        return q.first().then((result) => result?.total ?? 0);
-      },
-
-      /**
-       * 分页查询
-       * @param {Object} options - 查询选项
-       * @param {number} options.current - 当前页码，默认1
-       * @param {number} options.pageSize - 每页大小，默认10
-       * @param {Object} options.where - 查询条件
-       * @param {Array} options.select - 查询字段
-       * @returns {Promise<Object>} 分页结果
-       */
-      query(options = {}) {
-        const { current = 1, pageSize = 10, where = {}, select } = options;
-        const offset = (current - 1) * pageSize;
-
-        const countQuery = db(this.tableName).count("* as total");
-        const dataQuery = db(this.tableName);
-
-        if (Object.keys(where).length > 0) {
-          countQuery.where(where);
-          dataQuery.where(where);
-        }
-
-        if (select) {
-          dataQuery.select(select);
-        }
-
-        return Promise.all([
-          countQuery.first(),
-          dataQuery.offset(offset).limit(pageSize),
-        ]).then(([totalResult, list]) => ({
-          list,
-          total: totalResult?.total ?? 0,
-          current,
-          pageSize,
-        }));
-      },
-
-      /**
-       * 关联查询
-       * @param {Object} options - 查询选项
-       * @param {string} options.joinTable - 关联表名
-       * @param {string} options.localField - 本地表字段
-       * @param {string} options.foreignField - 关联表字段
-       * @param {string} options.select - 查询字段，默认"*"
-       * @param {Object} options.where - 查询条件
-       * @returns {Object} Knex查询构建器
-       */
-      join(options) {
-        const { joinTable, localField, foreignField, select = "*", where = {} } = options;
-        let q = db(this.tableName)
-          .join(joinTable, `${this.tableName}.${localField}`, "=", `${joinTable}.${foreignField}`)
-          .select(select);
-
-        if (Object.keys(where).length > 0) {
-          q = q.where(where);
-        }
-
-        return q;
-      },
-
-      /**
-       * 执行事务
-       * @param {Function} callback - 事务回调函数
-       * @returns {Promise} 事务执行结果
-       */
-      transaction(callback) {
-        return db.transaction(callback);
-      },
-
-      /**
-       * 执行原生SQL
-       * @param {string} sql - SQL语句
-       * @param {Array} bindings - 绑定参数
-       * @returns {Promise} 查询结果
-       */
-      raw(sql, bindings) {
-        return db.raw(sql, bindings);
-      },
-    };
-  }
 }
 
 export default DatabaseManager;

package/base/Service.js

@@ -14,11 +14,6 @@ class Service {
     if (knex && tableName) {
       this.db = knex;
       this.tableName = tableName;
-      this._config = Chan.config || {};
-    } else if (global.appContext) {
-      this.context = global.appContext;
-    } else {
-      this.context = { get: () => null, set: () => null };
     }
 
     this._dateFields = ['created_at', 'updated_at', 'deleted_at', 'publish_time', 'start_time', 'end_time', 'login_time', 'created_date', 'updated_date', 'createdAt', 'updatedAt', 'deletedAt', 'publishTime', 'startTime', 'endTime', 'loginTime', 'createdDate', 'updatedDate'];
@@ -29,7 +24,7 @@ class Service {
    * @returns {number} 每页记录数，默认20
    */
   get pageSize() {
-    return this._config.PAGE_SIZE || 20;
+    return Chan.config.PAGE_SIZE || 20;
   }
 
   /**
@@ -37,35 +32,7 @@ class Service {
    * @returns {number} 最大记录数，默认300
    */
   get limit() {
-    return this._config.LIMIT_MAX || 300;
-  }
-
-  /**
-   * 获取模型实例
-   * @param {string} name - 模型名称
-   * @returns {Object} 模型实例
-   */
-  getModel(name) {
-    return this.context.getModel(name);
-  }
-
-  /**
-   * 获取数据库连接
-   * @param {string} name - 数据库名称
-   * @returns {Object} 数据库实例
-   */
-  getDB(name) {
-    return this.context.get(`db:${name}`);
-  }
-
-  /**
-   * 执行事务
-   * @param {Function} callback - 事务回调函数
-   * @returns {Promise} 事务执行结果
-   */
-  async withTransaction(callback) {
-    const db = this.getDB("default") || Chan.db;
-    return db.transaction(callback);
+    return Chan.config.LIMIT_MAX || 300;
   }
 
   /**

package/global/import.js

@@ -36,8 +36,4 @@ const importFile = async (filepath) => {
  */
 export const importjs = createRequire(import.meta.url);
 
-/**
- * 将导入函数挂载到全局
- */
-global.requirejs = importjs;
-global.importFile = importFile;
+export { importFile };

package/helper/index.js

@@ -1,5 +1,3 @@
-export { db } from "./db.js";
-export { prefixDbConfig } from "./db.js";
 export { loaderSort, loadConfig, clearConfigCache, bindInstance, loadController } from "./loader.js";
 export { formatTime } from "./time.js";
 export { formatDateFields } from "./time.js";

package/index.js

@@ -1,7 +1,6 @@
 export { default as Chan } from "./App.js";
 export { default as Controller } from "./base/Controller.js";
 export { default as Service } from "./base/Service.js";
-export { default as AppContext } from "./base/Context.js";
 export { default as DatabaseManager } from "./base/Database.js";
 
 export * as helper from "./helper/index.js";

package/middleware/index.js

@@ -10,5 +10,4 @@ export { setStatic } from "./static.js";
 export { setHeader } from "./header.js";
 export { setTemplate } from "./template.js";
 export { Cors } from "./cors.js";
-export { validator } from "./validator.js";
 export { waf } from "./waf.js";

package/middleware/template.js

@@ -1,4 +1,5 @@
 import "../extend/index.js";
+import { importjs } from "../global/import.js";
 
 /**
  * 模板引擎中间件配置
@@ -30,5 +31,5 @@ export let setTemplate = (app, config) => {
   });
   app.set("view engine", "html");
   app.set("views", all);
-  app.engine(".html", requirejs("express-art-template"));
+  app.engine(".html", importjs("express-art-template"));
 };