chanjs 2.3.0 → 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._isStarted = false;
+    // 应用路由
     this.router = express.Router();
   }
 
@@ -97,63 +103,52 @@ class Chan {
    * @returns {Promise<void>}
    */
   async start() {
-    if (this._isStarted) {
-      console.warn("App already started");
-      return;
-    }
-
-    global.appContext = this.context;
-    global.Chan = Chan;
-
-    await this.initConfig();
-    await this.initDB();
-    await this.initExtend();
-    await this.initMiddleware();
-
-    this._applyConfig();
-
+    //加载配置
+    await this.config();
+    //加载数据库
+    await this.loadDB();
+    //加载扩展方法
+    await this.loadExtend();
+    //加载中间件
+    await this.loadAppMiddleware();
+    //设置app
+    this.setApp();
+     //加载路由
     await this.loadRouter();
     await this.loadCommonRouter();
-
-    this._applyRoutes();
-    this._applyErrorHandling();
-
-    await this._listen();
-
-    this._isStarted = true;
+    this.useRouter();
+    //404 500 处理
+    this.setErrorHandler();
   }
 
   /**
-   * 初始化配置
+   * 加载配置
    * @async
    * @returns {Promise<void>}
-   * @description 加载应用配置并设置到上下文
+   * @description 加载应用配置并设置到全局变量
    */
-  async initConfig() {
+  async config() {
     let config = await loadConfig();
     Chan.config = config;
-    this.context.set("config", config);
   }
 
   /**
-   * 初始化数据库
+   * 加载数据库
    * @async
    * @returns {Promise<void>}
    * @description 根据配置初始化所有数据库连接
    */
-  async initDB() {
+  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;
         }
@@ -163,17 +158,17 @@ class Chan {
     }
 
     console.log(
-      `[DB] 初始化完成，已加载 ${dbList.length} 个数据库，成功 ${Object.keys(connections).length} 个`,
+      `[DB] 初始化完成，已加载 ${dbList.length} 个数据库`,
     );
   }
 
   /**
-   * 初始化扩展模块
+   * 加载扩展模块
    * @async
    * @returns {Promise<void>}
    * @description 加载 common、helper、extend 目录下的扩展模块
    */
-  async initExtend() {
+  async loadExtend() {
     const extensions = [
       { _path: Paths.commonPath, key: "common" },
       { _path: Paths.helperPath, key: "helper" },
@@ -198,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);
       }
     }
@@ -210,10 +205,21 @@ class Chan {
    * @returns {Promise<void>}
    * @description 配置并注册所有应用中间件
    */
-  async initMiddleware() {
+  async loadAppMiddleware() {
     const config = Chan.config;
-    const { views = [], env = "development", APP_NAME = "ChanCMS", APP_VERSION = "1.0.0", cookieKey, BODY_LIMIT = "10mb", statics = [], cors = {}, PROXY = "false", waf: wafConfig = { enabled: false } } = config;
-
+    const { 
+      views = [], 
+      env = "development", 
+      APP_NAME = "ChanCMS",
+       APP_VERSION = "1.0.0", 
+       cookieKey, 
+       BODY_LIMIT = "10mb",
+        statics = [], 
+        cors = {}, 
+        PROXY = "false", 
+        waf: wafConfig = { enabled: false } 
+      } = config;
+    
     await waf(this.app, wafConfig);
     setFavicon(this.app);
     setStatic(this.app, statics);
@@ -229,9 +235,8 @@ class Chan {
    * @private
    * @description 设置 Express 应用配置
    */
-  _applyConfig() {
+  setApp() {
     this.app.set("trust proxy", Chan.config.PROXY === "true");
-    this.app.set("env", this.options.env);
     this.app.disable("x-powered-by");
   }
 
@@ -240,20 +245,22 @@ class Chan {
    * @private
    * @description 将所有路由应用到 Express 应用
    */
-  _applyRoutes() {
+  useRouter() {
     this.app.use(this.router);
   }
 
   /**
-   * 应用错误处理
+   * 应用错误处理404 500
    * @private
    * @description 配置全局错误处理中间件
    */
-  _applyErrorHandling() {
+  setErrorHandler() {
+    //404
     this.app.use((req, res) => {
       res.status(404).json(notFoundResponse(req));
     });
 
+    // 500
     this.app.use((err, req, res, next) => {
       if (res.headersSent) return next(err);
 
@@ -326,23 +333,7 @@ class Chan {
     return { message: stackLines[0] || '未知错误', file: errorLine };
   }
 
-  /**
-   * 启动服务器监听
-   * @async
-   * @private
-   * @returns {Promise<void>}
-   * @description 启动 HTTP 服务器监听指定端口
-   */
-  async _listen() {
-    return new Promise((resolve, reject) => {
-      const server = this.app.listen(this.options.port, () => {
-        console.log(`Server running on port ${this.options.port}`);
-        resolve(server);
-      });
-
-      server.on("error", reject);
-    });
-  }
+ 
 
   /**
    * 加载模块路由
@@ -355,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);
       }
     }
@@ -368,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);
     }
@@ -379,9 +370,14 @@ class Chan {
    * @param {Function} [cb] - 回调函数
    * @description 在启动前执行回调，传递端口号
    */
-  ready(cb) {
-    cb?.(this.options.port);
+  run(cb) {
+    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),
-        },
-      },
-    });
-  }
 }