chanjs 1.2.6 → 2.0.0

package/index.js

@@ -1,68 +1,90 @@
-import express from "express";
+import "./common/global.js";
 import path from "path";
 import fs from "fs";
-import cors from "cors";
-import { pathToFileURL } from 'url';  // 新增顶部导入
-import config from "./core/config.js";
-import * as helper from "./core/helper.js";
-import Controller from "./core/lib/controller.js";
-import Service from "./core/lib/service.js";
-import Cache from './core/lib/cache.js';
-import Task from "./core/lib/task.js";
-import core from "./core/lib/index.js";
-const {bindClass, createKnex, loadWebToEnd} = helper;
-import { z } from 'zod';
-/**
- * @description 基于express封装的mvc框架，遵循约定优于配置原则
- */
+import {
+  bindClass,
+  db,
+  loaderSort,
+  getPackage,
+  loadConfig,
+  loadController,
+} from "./utils/index.js";
+import { express, z } from "./extend/import.js";
+import { Controller, Service } from "./core/index.js";
+import {
+  log,
+  setCookie,
+  setFavicon,
+  setBody,
+  setStatic,
+  setHeader,
+  setTemplate,
+  Cors,
+  validator,
+} from "./middleware/index.js";
+
 class Chan {
-  static helper = {...helper};
-  static modules = {};
-  static plugins = {};
-  static config = config;
-  static Controller = Controller;
-  static Service = Service;
-  static Cache = Cache;
-  static Task = Task;
-  static z = z;
+  static helper = {
+    bindClass,
+    getPackage,
+    loadController,
+    db,
+    z, //验证器
+    validator,
+  }; //工具类
+  static config = {}; //配置
+  //数据库
+
+  // static Router = express.Router; //路由
+  static Service = Service; //服务
+  static Controller = Controller; //控制器
+  static extend = {}; //组件扩展
+  static middleware = {}; //中间件
+
   constructor() {
     this.app = express();
     this.router = express.Router();
   }
-  async init() {
-    await this.loadConfig();
-    await this.loadExtends();
-    this.loadCore();
-    this.loadDB();
-    this.loadCors();
-  }
-  async loadConfig() {
-    const configPath = path.join(Chan.config.APP_PATH, "config/index.js");
-    if (fs.existsSync(configPath)) {
-      const configUrl = pathToFileURL(configPath).href; // 新增转换
-      const configModule = await import(configUrl);     // 使用 URL 导入
-      Chan.config = { ...Chan.config, ...configModule.default }; // 注意 default
-    }
+
+  beforeStart(cb) {
+    cb && cb();
   }
 
-  async loadExtends() {
-    const extendPath = path.join(Chan.config.APP_PATH, "extend");
-    if (fs.existsSync(extendPath)) {
-      const files = fs.readdirSync(extendPath).filter(file => file.endsWith(".js"));
-      for (const file of files) {
-        const filePath = path.join(extendPath, file);
-        const fileUrl = pathToFileURL(filePath).href;  // 转换路径
-        const helperModule = await import(fileUrl);    // 使用 URL 导入
-        Chan.helper[file.replace(".js", "")] = helperModule?.default || helperModule; // 注意 default
-      }
-    }
+  async init() {
+    await this.config();
+    await this.loadExtend(); //utils
+    this.loadMiddleware();
+    this.loadDB();
   }
 
-  /**
-   * @description app核心模块：日志、favicon 图标、cookie、json、url、模板引擎、静态资源
-   */
-  loadCore() {
-    core(this.app, Chan.config);
+  //加载配置文件
+  async config() {
+    let config = await loadConfig();
+    Chan.config = config;
+  }
+
+  //加载中间件
+  async loadMiddleware() {
+    const {
+      views,
+      env,
+      appName,
+      version,
+      cookieKey,
+      JSON_LIMIT,
+      statics,
+      logger,
+      cors,
+    } = Chan.config;
+
+    log(this.app, logger);
+    setFavicon(this.app);
+    setCookie(this.app, cookieKey);
+    setBody(this.app, JSON_LIMIT);
+    setTemplate(this.app, { views, env });
+    setStatic(this.app, statics);
+    Cors(this.app, cors);
+    setHeader(this.app, { appName, version });
   }
 
   //数据库操作
@@ -70,135 +92,66 @@ class Chan {
     if (Chan.config?.db?.length > 0) {
       Chan.config.db.map((item, index) => {
         if (index == 0) {
-          Chan.knex = createKnex(item);
+          Chan.knex = db(item);
         } else {
-          Chan[`knex${index}`] = createKnex(item);
+          Chan[`knex${index}`] = db(item);
         }
-      })
-      Chan.Service = Service;
+      });
     }
   }
 
-  //解决跨域
-  loadCors() {
-    Chan.config?.cors?.origin && this.app.use(cors(Chan.config.cors));
-  }
-
-  //开始启动
-  beforeStart(cb) {
-    cb && cb();
-  }
-  //启动
-  async start(cb) {
-    await this.init();
-    await this.loadPlugins();
-    await this.loadModules();
-    await this.loadCommonRouter();
-    cb && cb();
-  }
-
-  // 加载插件
-  async loadPlugins() {
-    await this.loadModules("plugins");
-  }
-
-  /**
-   * @description 模块加载入口（路由&控制器& 服务）
-   */
-  async loadModules(modules = "modules") {
-    const configPath = path.join(Chan.config.APP_PATH, modules);
+  async loadRouter() {
+    const configPath = path.join(APP_PATH, "modules");
     if (fs.existsSync(configPath)) {
-      const dirs = loadWebToEnd(Chan.config[modules]);
-      Chan[modules] = {};
-
-      // 先加载所有服务
+      const dirs = loaderSort(Chan.config.modules);
       for (const item of dirs) {
-        Chan[modules][item] = {
-          service: {},
-          controller: {},
-        };
-        await this.loadServices(modules, item); // 确保每个模块的服务加载完成
-      }
-
-      // 加载控制器和路由
-      for (const item of dirs) {
-        await this.loadModule(modules, item); // 确保每个模块的加载完成
+        let router = await importRootFile(`app/modules/${item}/router.js`);
+        router(this.app, this.router, Chan.config);
       }
     }
   }
 
-  /**
-   * @description 加载模块，包括 controller service router
-   * @param {String} moduleName 模块名称
-   */
-  async loadModule(modules, moduleName) {
-    await this.loadControllers(modules, moduleName); // 确保控制器加载完成
-    await this.loadRoutes(modules, moduleName); // 然后加载路由
+  //通用路由，加载错误处理和500路由和爬虫处理
+  async loadCommonRouter() {
+    try {
+      let router = await importRootFile("app/router.js");
+      router(this.app, this.router, Chan.config);
+    } catch (error) {
+      console.log(error);
+    }
   }
 
-  async loadFiles(modules, moduleName, type) {
-    const dir = path.join(Chan.config.APP_PATH, modules, moduleName, type);
-    if (fs.existsSync(dir)) {
-      const files = fs.readdirSync(dir).filter(file => file.endsWith(".js"));
-      await Promise.all(files.map(async (file) => {
-        try {
-          const filePath = path.join(dir, file);
-          const fileUrl = pathToFileURL(filePath).href;
-          const module = await import(fileUrl);
-          const name = file.replace(".js", "");
-          Chan[modules][moduleName][type][name] = { ...bindClass(module.default) };
-        } catch (e) {
-          console.error(`加载${type}模块失败: ${file}`, e);
-          throw e;
-        }
-      }));
+  async loadExtend() {
+    if (fs.existsSync(EXTEND_PATH)) {
+      const files = fs
+        .readdirSync(EXTEND_PATH)
+        .filter((file) => file.endsWith(".js"));
+      for (const file of files) {
+        const filePath = path.join(EXTEND_PATH, file);
+        let helperModule = await importFile(filePath);
+        Chan.helper[file.replace(".js", "")] = helperModule;
+      }
     }
   }
 
-  /**
-   * @description 扫描模块下所有service
-   * @param {*} moduleDir 模块路径
-   * @param {*} moduleName 模块名称
-   */
-  async loadServices(modules, moduleName) {
-    await this.loadFiles(modules, moduleName, "service");
-  }
+  async start(cb) {
+    await this.init();
+    await this.loadRouter();
+    await this.loadCommonRouter();
 
-  /**
-   * @description 扫描模块下所有controller
-   * @param {*} moduleDir 模块路径
-   * @param {*} moduleName 模块名称
-   */
-  async loadControllers(modules, moduleName) {
-    await this.loadFiles(modules, moduleName, "controller");
+    cb && cb();
   }
 
-  /**
-   * @description 扫描模块下所有router.js
-   * @param {*} moduleDir 模块路径
-   * @param {*} moduleName 模块名称
-   */
-  async loadRoutes(modules, moduleName) {
-    const routersDir = path.join(Chan.config.APP_PATH, modules, moduleName, "router.js");
-    if (fs.existsSync(routersDir)) {
-      const routeUrl = pathToFileURL(routersDir).href; // 转换路径
-      const routes = await import(routeUrl);           // 使用 URL 导入
-      routes.default({ router: this.router, modules: Chan[modules], app: this.app });
-    }
-  }
+  getAllRouter() {
+    // 获取所有路径
+    const routes = this.router.stack
+      .filter((r) => r.route) // 过滤掉中间件
+      .map((r) => ({
+        path: r.route.path,
+        methods: Object.keys(r.route.methods),
+      }));
 
-  //通用路由，加载错误处理和500路由和爬虫处理
-  async loadCommonRouter() {
-    try {
-      const baseRouterPath = path.join(Chan.config.APP_PATH, "router.js");
-      if (fs.existsSync(baseRouterPath)) {
-        const routerUrl = pathToFileURL(baseRouterPath).href; // 转换路径
-        const _router = await import(routerUrl);              // 使用 URL 导入
-        _router.default(this.app, this.router, Chan.config);  // 注意 default
-      }
-    } catch (error) {
-      console.log(error);
-    }
+    console.log(routes);
   }
 
   run(cb) {
@@ -208,5 +161,6 @@ class Chan {
     });
   }
 }
+
 global.Chan = Chan;
 export default Chan;

package/middleware/cookie.js

@@ -0,0 +1,4 @@
+import cookieParser from "cookie-parser";
+export const setCookie = (app,cookieKey) => {
+   app.use(cookieParser(cookieKey));
+};

package/middleware/cors.js

@@ -0,0 +1,4 @@
+import cors from "cors";
+export const Cors = (app,_cors) => {
+    app.use(cors(_cors));
+};

package/middleware/favicon.js

@@ -0,0 +1,5 @@
+import path from "path";
+import favicon from "serve-favicon";
+export const setFavicon = (app) => {
+  app.use(favicon(path.join(APP_PATH, "public/favicon.ico")));
+};

package/middleware/header.js

@@ -0,0 +1,9 @@
+export let setHeader =  (app, { appName, version })=>{
+  app.use((req, res, next) => {
+    res.setHeader("Create-By", "Chanjs");
+    res.setHeader("X-Powered-By", "ChanCMS");
+    res.setHeader("ChanCMS", version);
+    res.setHeader("Server", appName);
+    next();
+  });
+};

package/middleware/index.js

@@ -0,0 +1,21 @@
+import {log} from "./log.js";
+import {setCookie} from "./cookie.js";
+import {setFavicon} from "./favicon.js";
+import {setBody} from "./setBody.js";
+import {setStatic} from "./static.js";
+import {setHeader} from "./header.js";
+import {setTemplate} from "./template.js";
+import {validator} from "./validator.js";
+import {Cors} from "./cors.js";
+
+export {
+    log,
+    setCookie,
+    setFavicon,
+    setBody,
+    setStatic,
+    setHeader,
+    setTemplate,
+    Cors,
+    validator
+}

package/middleware/log.js

@@ -0,0 +1,4 @@
+import morgan from "morgan";
+export const log = (app,logger) => {
+    app.use(morgan(logger.level));
+};

package/middleware/setBody.js

@@ -0,0 +1,11 @@
+import express from "express";
+
+
+let setBody = function (app, JSON_LIMIT) {
+  app.use(express.json({ limit: JSON_LIMIT }));
+  app.use(express.urlencoded({ extended: false }));
+};
+
+export {
+  setBody
+}

package/middleware/static.js

@@ -0,0 +1,10 @@
+import express from "express";
+
+export const setStatic = async function (app, statics) {
+  if (statics.length > 0) {
+    statics.forEach((item) => {
+      const { prefix, dir, maxAge } = item;
+      app.use(prefix, express.static(dir, { maxAge: maxAge || 0 }));
+    });
+  }
+};

package/middleware/template.js

@@ -0,0 +1,14 @@
+import '../extend/art-template.js'
+export let setTemplate = (app, config) => {
+  const {  views, env } = config;
+ //合并插件中的view
+  const all = [...views, 'app/modules/web/view'];
+  app.set("view options", {
+    debug: env === "dev",
+    cache: env === "prd",
+    minimize: true,
+  });
+  app.set("view engine", "html");
+  app.set("views", all);
+  app.engine(".html", requirejs("express-art-template"));
+};

package/middleware/validator.js

@@ -0,0 +1,23 @@
+export const validator = (schemas) => (req, res, next) => {
+  // 分别验证 headers/params/query/body
+  const sections = {
+    headers: schemas.headers,
+    params: schemas.params,
+    query: schemas.query,
+    body: schemas.body
+  };
+
+  for (const [key, schema] of Object.entries(sections)) {
+    if (!schema) continue;
+    
+    const result = schema.safeParse(req[key]);
+    if (!result.success) {
+      // 返回首个错误信息
+      const firstError = result.error.errors[0];
+      return res.status(400).json({ error: firstError.message });
+    }
+    // 将验证后的数据挂载到 req 对象
+    req[key] = result.data;
+  }
+  next();
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "chanjs",
-  "version": "1.2.6",
+  "version": "2.0.0",
   "description": "chanjs基于express5 纯js研发的轻量级mvc框架。",
   "main": "index.js",
   "module": "index.js",
@@ -11,7 +11,7 @@
     "express mysql",
     "express knex",
     "chancms",
-    "nodejs"
+    "nodejs mvc"
   ],
   "engines": {
     "node": ">=20.0.0"
@@ -24,7 +24,6 @@
     "cookie-parser": "^1.4.7",
     "cors": "^2.8.5",
     "dayjs": "^1.11.13",
-    "deepmerge": "^4.3.1",
     "express": "^5.1.0",
     "express-art-template": "^1.0.1",
     "knex": "^3.1.0",

package/utils/bind.js

@@ -0,0 +1,21 @@
+
+/**
+ * @description 实例化一个类，并将该类的所有方法绑定到一个新的对象上。
+ * @param {Function} className - 需要实例化的类。
+ *@returns {Object} 包含绑定方法的对象。
+ */
+ export const bindClass = function(className) {
+  let obj = {};
+  const cls = new className();
+  Object.getOwnPropertyNames(cls.constructor.prototype).forEach(
+    (methodName) => {
+      if (
+        methodName !== "constructor" &&
+        typeof cls[methodName] === "function"
+      ) {
+        obj[methodName] = cls[methodName].bind(cls);
+      }
+    }
+  );
+  return obj;
+}

package/utils/db.js

@@ -0,0 +1,75 @@
+import knex from 'knex';
+export const db = function({
+  client='mysql2',
+  host='127.0.0.1',
+  user='root',
+  password='123456',
+  database='test',
+  debug=true,
+  charset='utf8mb4',
+  min=0,
+  max=2,
+} ) {
+
+  let config = {
+    client ,
+    connection: {
+        host ,
+        user ,
+        password,
+        database,
+        charset,
+    } ,
+    debug,
+    pool: { //默认为{min: 2, max: 10},连接池配置
+        min,
+        max,
+      },
+    log: {
+        warn(message) {
+          console.error("[knex warn]", message);
+        },
+        error(message) {
+          console.error("[knex error]", message);
+        },
+        debug(message) {
+          console.log("[knex debug]", message);
+        },
+        deprecate(message) {
+          console.warn("[knex deprecate]", message);
+        },
+        trace(message) {
+          console.log("[knex trace]", message);
+        },
+        log(message) {
+          console.log("[knex log]", message);
+        },
+        info(message) {
+          console.log("[knex info]", message);
+        },
+
+      },
+}
+    return knex(config);
+}
+
+const errCode = {
+  "ECONNREFUSED": "数据库连接被拒绝，请检查数据库服务是否正常运行。",
+  "ER_ACCESS_DENIED_ERROR": "无权限访问，账号或密码错误。",
+  "ER_ROW_IS_REFERENCED_2": "无法删除或更新记录，存在关联数据。",
+  "ER_BAD_FIELD_ERROR": "SQL语句中包含无效字段，请检查查询条件或列名。",
+  "ER_DUP_ENTRY": "插入失败：数据重复，违反唯一性约束。",
+  "ER_NO_SUCH_TABLE": "操作失败：目标表不存在。",
+  "ETIMEOUT": "数据库操作超时，请稍后再试。"
+}
+const getDefaultErrorMessage = (error) => {
+  if (error.message.includes('syntax') ||
+    error.message.includes('SQL')) {
+    return '数据库语法错误，请检查您的查询语句。';
+  } else if (error.message.includes('Connection closed')) {
+    return '数据库连接已关闭，请重试。';
+  } else if (error.message.includes('permission')) {
+    return '数据库权限不足，请检查配置。';
+  }
+  return '数据库发生未知错误，请稍后重试。';
+}

package/utils/index.js

@@ -0,0 +1,11 @@
+import {bindClass} from './bind.js'
+import {db} from './db.js'
+import {loaderSort,getPackage,loadConfig,loadController} from './loader.js'
+export {
+    bindClass,
+    db,
+    loaderSort,
+    getPackage,
+    loadConfig,
+    loadController
+}

package/utils/loader.js

@@ -0,0 +1,63 @@
+import fs from 'fs';
+import path from 'path';
+
+/**
+ * 
+ * @param {*} module 模块目录
+ * @returns Array 
+ * @description 将web模块放到最后加载
+ */
+export const loaderSort = (modules=[])=>{
+  const index = modules.indexOf('web');
+  if (index !== -1) {
+      const web = modules.splice(index, 1);
+      modules.push(web[0]);
+  }
+  return modules;
+}
+
+export const getPackage = async function(){
+  let pkg = await importFile('package.json')
+  return pkg;
+}
+
+export const loadConfig = async function(){
+  let config = await importFile('app/config/index.js')
+  return config;
+}
+
+
+/**
+ * 加载指定模块名下的所有控制器文件
+ * @param {string} moduleName - 模块名称
+ * @returns {Promise<Object>} - 控制器对象
+ */
+export const loadController = async function (moduleName) {
+  const controller = {};
+
+  const dir = path.join(MODULES_PATH, moduleName,'controller');
+
+  if (!fs.existsSync(dir)) {
+    console.warn(`模块路径不存在，跳过加载控制器: ${dir}`);
+    return controller;
+  }
+
+  const files = fs.readdirSync(dir).filter(file => file.endsWith('.js'));
+  for (const file of files) {
+    const filePath = path.join(dir, file);
+    const name = file.replace(/\.js$/i, ''); // 安全处理 .js 后缀
+    try {
+      const module = await importFile(filePath);
+      controller[name] = { ...module};
+    } catch (e) {
+      console.error(`加载控制器失败: ${filePath}`, e);
+      // 可选：抛出错误或继续加载其他文件
+      // throw e;
+    }
+  }
+
+  return controller;
+};
+
+
+ 

package/utils/response.js

@@ -0,0 +1,26 @@
+export let success = (data) => {
+  return {
+    success: true,
+    msg: "操作成功",
+    code: 200,
+    data,
+  };
+};
+
+export let fail = (data, code = 201) => {
+  return {
+    success: false,
+    msg: "操作失败",
+    code,
+    data,
+  };
+};
+
+export let err = (data = {}, code = 500) => {
+  return {
+    success: false,
+    msg: "系统异常",
+    code,
+    data,
+  };
+};