chanjs 2.1.1 → 2.3.0

package/helper/time.js

@@ -1,74 +1,89 @@
-import dayjs from "dayjs";
-import "dayjs/locale/zh-cn.js";
-import relativeTime from "dayjs/plugin/relativeTime.js";
-
-dayjs.extend(relativeTime);
-dayjs.locale("zh-cn");
-
-/**
- * @description 格式化时间
- * @param {Array} data 数组
- * @param {Boolean} time 是否开启具体时间
- * @param {String} format YYYY-MM-DD HH:mm:ss
- * @returns 返回处理过的数组
- */
-export const formatDay = (data, time = true, format = "YYYY-MM-DD") => {
-  data.forEach((item) => {
-    if (item.createdAt) {
-      item.createdAt = time
-        ? dayjs(item.createdAt).format(format)
-        : dayjs(item.createdAt).fromNow().replace(" ", "");
-    }
-  });
-  return data;
-};
-
-export const formatTime = (data, format = "YYYY-MM-DD HH:mm:ss") => {
-  return dayjs(data).format(format);
-};
-
-/**
- * 格式化对象或数组中的日期字段
- * @param {Object|Array} data - 要格式化的数据
- * @param {Object} options - 配置选项
- * @param {Array} options.fields - 要格式化的字段名，默认 ['createdAt', 'updatedAt']
- * @param {String} options.format - 日期格式，默认 'YYYY-MM-DD HH:mm:ss'
- * @returns {Object|Array} - 格式化后的数据
- */
-export const formatDateFields = (data, options = {}) => {
-  const {
-    fields = ['createdAt', 'updatedAt'],
-    format = 'YYYY-MM-DD HH:mm:ss',
-  } = options;
-
-  const isPlainObject = (val) =>
-    Object.prototype.toString.call(val) === '[object Object]';
-
-  if (isPlainObject(data)) {
-    const result = { ...data };
-    fields.forEach(field => {
-      const value = result[field];
-      if (value != null) {
-        const type = typeof value;
-        if (type === 'string' || type === 'number' || value instanceof Date) {
-          try {
-            result[field] = formatTime(value, format);
-          } catch (e) {
-            console.warn(`格式化字段 ${field} 失败:`, e.message);
-          }
-        }
-      }
-    });
-    return result;
-  }
-
-  if (Array.isArray(data)) {
-    return data.map(item =>
-      typeof item === 'object' && item !== null
-        ? formatDateFields(item, options)
-        : item
-    );
-  }
-
-  return data;
-};;
+/**
+ * 格式化时间戳为指定格式的字符串
+ * @param {number|string|Date} timestamp - 时间戳、日期字符串或 Date 对象
+ * @param {string} [format='YYYY-MM-DD HH:mm:ss'] - 输出格式
+ * @returns {string} 格式化后的时间字符串
+ * @description
+ * 支持的格式占位符：
+ * - YYYY: 四位年份
+ * - MM: 两位月份（01-12）
+ * - DD: 两位日期（01-31）
+ * - HH: 两位小时（00-23）
+ * - mm: 两位分钟（00-59）
+ * - ss: 两位秒数（00-59）
+ * @example
+ * formatTime(1704067200000); // '2024-01-01 00:00:00'
+ * formatTime(1704067200000, 'YYYY/MM/DD'); // '2024/01/01'
+ * formatTime('2024-01-01', 'YYYY-MM-DD'); // '2024-01-01'
+ */
+export function formatTime(timestamp, format = 'YYYY-MM-DD HH:mm:ss') {
+  try {
+    const date = new Date(timestamp);
+    if (isNaN(date.getTime())) {
+      return timestamp;
+    }
+    const year = date.getFullYear();
+    const month = String(date.getMonth() + 1).padStart(2, '0');
+    const day = String(date.getDate()).padStart(2, '0');
+    const hours = String(date.getHours()).padStart(2, '0');
+    const minutes = String(date.getMinutes()).padStart(2, '0');
+    const seconds = String(date.getSeconds()).padStart(2, '0');
+
+    return format
+      .replace('YYYY', year)
+      .replace('MM', month)
+      .replace('DD', day)
+      .replace('HH', hours)
+      .replace('mm', minutes)
+      .replace('ss', seconds);
+  } catch (error) {
+    console.error('[formatTime] 格式化时间失败:', error, 'timestamp:', timestamp);
+    return timestamp;
+  }
+}
+
+/**
+ * 格式化对象或数组中的日期字段
+ * @param {Object|Array<Object>} data - 要处理的数据对象或数组
+ * @param {Array<string>} [fields] - 需要格式化的字段名数组（可选，默认处理常用日期字段）
+ * @returns {Object|Array<Object>} 处理后的数据
+ * @description
+ * 将对象或数组中指定的日期字段格式化为 'YYYY-MM-DD HH:mm:ss' 格式
+ * 支持递归处理数组中的每个对象
+ * 自动匹配下划线和驼峰格式的字段名（如 createdAt/created_at）
+ * @example
+ * const data = { id: 1, createdAt: 1704067200000, updatedAt: 1704067200000 };
+ * const result = formatDateFields(data);
+ * console.log(result);
+ * // { id: 1, createdAt: '2024-01-01 00:00:00', updatedAt: '2024-01-01 00:00:00' }
+ * 
+ * const list = [
+ *   { id: 1, createdAt: 1704067200000 },
+ *   { id: 2, createdAt: 1704153600000 }
+ * ];
+ * const formatted = formatDateFields(list);
+ * console.log(formatted);
+ * // [
+ * //   { id: 1, createdAt: '2024-01-01 00:00:00' },
+ * //   { id: 2, createdAt: '2024-01-02 00:00:00' }
+ * // ]
+ */
+export function formatDateFields(data, fields) {
+  if (!data || typeof data !== 'object') return data;
+
+  if (Array.isArray(data)) {
+    return data.map(item => formatDateFields(item, fields));
+  }
+
+  const result = { ...data };
+  
+  const defaultFields = ['createdAt', 'updatedAt', 'created_at', 'updated_at', 'createdAt', 'updatedAt'];
+  const targetFields = fields || defaultFields;
+  
+  for (const field of targetFields) {
+    if (result[field]) {
+      result[field] = formatTime(result[field]);
+    }
+  }
+  return result;
+}

package/helper/tree.js

@@ -0,0 +1,77 @@
+/**
+ * 树形结构工具函数
+ * 提供数组转树形结构和路径查找功能
+ */
+
+/**
+ * 将扁平数组转换为树形结构
+ * @param {Array<Object>} arr - 扁平化的数据数组
+ * @param {number} [pid=0] - 父节点 ID，默认为 0
+ * @returns {Array<Object>} 树形结构数组
+ * @description
+ * 递归构建树形结构，为每个节点添加 level 属性
+ * 如果有子节点，则添加 children 属性
+ * @example
+ * const arr = [
+ *   { id: 1, pid: 0, name: '根节点' },
+ *   { id: 2, pid: 1, name: '子节点' },
+ *   { id: 3, pid: 2, name: '孙节点' }
+ * ];
+ * const tree = tree(arr);
+ * // 返回带有 children 和 level 的树形结构
+ */
+export function tree(arr, pid = 0) {
+  if(arr.length === 0){
+    return []
+  }
+  let result = [];
+  arr.forEach((item) => {
+    if (item.pid === pid) {
+      let children = tree(arr, item.id);
+      if (children.length) {
+        item.children = children;
+      }
+      item.level = 1;
+      result.push(item);
+    }
+  });
+  return result;
+}
+
+/**
+ * 根据 ID 查找节点路径
+ * @param {number} id - 要查找的节点 ID
+ * @param {Array<Object>} source - 数据源数组
+ * @returns {Array<Object>} 从根节点到目标节点的路径数组
+ * @description
+ * 递归查找指定 ID 的节点及其所有父节点
+ * 为每个节点添加 path 属性，包含拼音路径
+ * @example
+ * const arr = [
+ *   { id: 1, pid: 0, pinyin: 'root' },
+ *   { id: 2, pid: 1, pinyin: 'child' }
+ * ];
+ * const path = treeById(2, arr);
+ * // 返回包含 root 和 child 节点的数组
+ */
+export function treeById(id, source) {
+  const arr = [];
+  const findId = (id, source) => {
+    for (let i = 0, item; i < source.length; i++) {
+      item = source[i];
+      if (item.id == id) {
+        arr.unshift(item);
+        if (item.pid != 0) {
+          findId(item.pid, source);
+        }
+      }
+    }
+  };
+  findId(id, source);
+  const _path = [];
+  arr.forEach((item) => {
+    _path.push("/" + item.pinyin);
+    item.path = _path.join("");
+  });
+  return arr;
+}

package/index.js

@@ -1,181 +1,15 @@
-import "./global/index.js";
-import path from "path";
-import fs from "fs";
-import express from "express";
-
-import { Controller, Service } from "./core/index.js";
-import {
-  log,
-  setCookie,
-  setFavicon,
-  setBody,
-  setStatic,
-  setHeader,
-  setTemplate,
-  Cors,
-  validator,
-  waf,
-} from "./middleware/index.js";
-import { db, loaderSort, loadConfig } from "./helper/index.js";
-import { dirname } from "./helper/file.js";
-
-class Chan {
-  //版本号
-  #version = "1.0.0";
-  static helper = {};
-  static common = {}; //公共方法
-  static config = {}; //配置
-  static Service = Service; //服务
-  static Controller = Controller; //控制器
-  static extend = {}; //组件扩展
-  static middleware = {}; //中间件
-  static modules = {}; //模块
-
-  constructor() {
-    this.app = express();
-    this.router = express.Router();
-  }
-
-  beforeStart(cb) {
-    cb && cb();
-  }
-
-  async init() {
-    await this.config();
-    await this.loadExtend(); //utils
-    this.loadMiddleware();
-    this.loadDB();
-  }
-
-  //加载配置文件
-  async config() {
-    let config = await loadConfig();
-    //版本号，先从package.json中获取，如果没有，则使用默认版本号
-    config.APP_VERSION = APP_VERSION || config.APP_VERSION;
-    Chan.config = config;
-  }
-
-  //加载中间件
-  async loadMiddleware() {
-    const {
-      views,
-      env,
-      APP_NAME,
-      APP_VERSION,
-      cookieKey,
-      BODY_LIMIT,
-      statics,
-      logger,
-      cors,
-      PROXY,
-    } = Chan.config;
-
-    this.app.set("trust proxy", PROXY === "true" ? true : false);
-    log(this.app, logger);
-    setFavicon(this.app);
-    setCookie(this.app, cookieKey);
-    setBody(this.app, BODY_LIMIT);
-    waf(this.app);
-    setTemplate(this.app, { views, env });
-    setStatic(this.app, statics);
-    Cors(this.app, cors);
-    setHeader(this.app, { APP_NAME, APP_VERSION });
-  }
-
-  //数据库操作
-  loadDB() {
-    if (Chan.config?.db?.length > 0) {
-      Chan.config.db.map((item, index) => {
-        if (index == 0) {
-          Chan.knex = db(item);
-        } else {
-          Chan[`knex${index}`] = db(item);
-        }
-      });
-    }
-  }
-
-  async loadRouter() {
-    const configPath = path.join(APP_PATH, "modules");
-    if (fs.existsSync(configPath)) {
-      const dirs = loaderSort(Chan.config.modules);
-      for (const item of dirs) {
-        let router = await importFile(`app/modules/${item}/router.js`);
-        router(this.app, this.router, Chan.config);
-      }
-    }
-  }
-
-  //通用路由，加载错误处理和500路由和爬虫处理
-  async loadCommonRouter() {
-    try {
-      let router = await importFile("app/router.js");
-      router(this.app, this.router, Chan.config);
-    } catch (error) {
-      console.log(error);
-    }
-  }
-
-  async loadExtend() {
-    let arr = [
-      {
-        _path: COMMON_PATH,
-        key: "common",
-      },
-      {
-        _path: HELPER_PATH,
-        key: "helper",
-      },
-      {
-        _path: path.join(dirname(import.meta.url), "helper"),
-        key: "helper",
-      },
-    ];
-    for (let item of arr) {
-      await this.loadFn(item._path, item.key);
-    }
-  }
-
-  async loadFn(_path, key) {
-    if (fs.existsSync(_path)) {
-      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);
-        // Chan.common[file.replace(".js", "")] = helperModule;
-        // 将模块导出的所有方法/属性，直接混入到 Chan.common 上
-        Object.assign(Chan[key], helperModule);
-      }
-    }
-  }
-
-  async start(cb) {
-    await this.init();
-    await this.loadRouter();
-    await this.loadCommonRouter();
-
-    cb && cb();
-  }
-
-  getAllRouter() {
-    // 获取所有路径
-    const routes = this.router.stack
-      .filter((r) => r.route) // 过滤掉中间件
-      .map((r) => ({
-        path: r.route.path,
-        methods: Object.keys(r.route.methods),
-      }));
-  }
-
-  run(cb) {
-    const port = parseInt(Chan.config.PORT) || 3000;
-    this.app.listen(port, () => {
-      cb ? cb(port) : console.log(`Server is running on port ${port}`);
-    });
-  }
-}
-
-global.Chan = Chan;
-export default Chan;
+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";
+export * as utils from "./utils/index.js";
+export * as middleware from "./middleware/index.js";
+export * as config from "./config/index.js";
+export * as common from "./common/index.js";
+export * as extend from "./extend/index.js";
+
+import Chan from "./App.js";
+export default Chan;

package/middleware/cookie.js

@@ -1,4 +1,20 @@
-import cookieParser from "cookie-parser";
-export const setCookie = (app, cookieKey) => {
-  app.use(cookieParser(cookieKey));
-};
+import cookieParser from "cookie-parser";
+
+/**
+ * Cookie 中间件配置
+ * 配置 Express 应用的 cookie 解析功能
+ */
+
+/**
+ * 设置 Cookie 解析中间件
+ * @param {Object} app - Express 应用实例
+ * @param {string} cookieKey - Cookie 签名密钥
+ * @description
+ * 为 Express 应用配置 cookie-parser 中间件
+ * 使用密钥对 cookie 进行签名验证
+ * @example
+ * setCookie(app, 'my-secret-key');
+ */
+export const setCookie = (app, cookieKey) => {
+  app.use(cookieParser(cookieKey));
+};

package/middleware/cors.js

@@ -1,4 +1,24 @@
 import cors from "cors";
+
+/**
+ * CORS 中间件配置
+ * 配置跨域资源共享
+ */
+
+/**
+ * 设置 CORS 中间件
+ * @param {Object} app - Express 应用实例
+ * @param {Object} _cors - CORS 配置选项
+ * @description
+ * 为 Express 应用配置 CORS 中间件
+ * 支持自定义 CORS 配置选项
+ * @example
+ * Cors(app, {
+ *   origin: '*',
+ *   methods: ['GET', 'POST'],
+ *   allowedHeaders: ['Content-Type']
+ * });
+ */
 export const Cors = (app, _cors) => {
   app.use(cors(_cors));
 };

package/middleware/favicon.js

@@ -1,5 +1,21 @@
-import path from "path";
-import favicon from "serve-favicon";
-export const setFavicon = (app) => {
-  app.use(favicon(path.join(ROOT_PATH, "public/favicon.ico")));
-};
+import path from "path";
+import favicon from "serve-favicon";
+import { Paths } from "../config/paths.js";
+
+/**
+ * Favicon 中间件配置
+ * 配置网站图标
+ */
+
+/**
+ * 设置 Favicon 中间件
+ * @param {Object} app - Express 应用实例
+ * @description
+ * 为 Express 应用配置 favicon 服务
+ * 从 public 目录加载 favicon.ico 文件
+ * @example
+ * setFavicon(app);
+ */
+export const setFavicon = (app) => {
+  app.use(favicon(path.join(Paths.publicPath, "favicon.ico")));
+};

package/middleware/header.js

@@ -1,9 +1,26 @@
-export let setHeader = (app, { APP_NAME, APP_VERSION }) => {
-  app.use((req, res, next) => {
-    res.setHeader("Create-By", "Chanjs");
-    res.setHeader("X-Powered-By", "ChanCMS");
-    res.setHeader("ChanCMS", APP_VERSION);
-    res.setHeader("Server", APP_NAME);
-    next();
-  });
-};
+/**
+ * 响应头中间件配置
+ * 设置应用相关的响应头信息
+ */
+
+/**
+ * 设置响应头中间件
+ * @param {Object} app - Express 应用实例
+ * @param {Object} options - 配置选项
+ * @param {string} options.APP_NAME - 应用名称
+ * @param {string} options.APP_VERSION - 应用版本
+ * @description
+ * 为所有响应添加自定义响应头
+ * 包含 Create-By、X-Powered-By、ChanCMS、Server 等头
+ * @example
+ * setHeader(app, { APP_NAME: 'MyApp', APP_VERSION: '1.0.0' });
+ */
+export let setHeader = (app, { APP_NAME, APP_VERSION }) => {
+  app.use((req, res, next) => {
+    res.setHeader("Create-By", "Chanjs");
+    res.setHeader("X-Powered-By", "ChanCMS");
+    res.setHeader("ChanCMS", APP_VERSION);
+    res.setHeader("Server", APP_NAME);
+    next();
+  });
+};

package/middleware/index.js

@@ -1,23 +1,14 @@
-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";
-import { waf } from "./waf.js";
-
-export {
-  log,
-  setCookie,
-  setFavicon,
-  setBody,
-  setStatic,
-  setHeader,
-  setTemplate,
-  Cors,
-  validator,
-  waf,
-};
+/**
+ * 中间件模块入口
+ * 导出所有中间件配置函数
+ */
+
+export { setCookie } from "./cookie.js";
+export { setFavicon } from "./favicon.js";
+export { setBody } from "./setBody.js";
+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/preventRetry.js

@@ -0,0 +1,30 @@
+/**
+ * 防止快速重复请求中间件
+ * 使用 Cache 实现请求频率限制
+ */
+
+import Cache from "../helper/cache.js";
+
+const sendResponse = (res, code, message, data = null) => {
+  res.json({ code, msg: message, data });
+};
+
+const requestCache = new Cache({ maxSize: 1000, defaultTTL: 500 });
+
+export default () => {
+  return (req, res, next) => {
+    if (req.method !== 'GET') {
+      return next();
+    }
+
+    const key = `${req.method}:${req.originalUrl}`;
+    
+    if (requestCache.has(key)) {
+      console.log(`[preventRetry] 阻止快速重复请求: ${key}`);
+      return sendResponse(res, 429, '请求过于频繁，请稍后再试');
+    }
+    
+    requestCache.set(key, Date.now());
+    next();
+  };
+};

package/middleware/setBody.js

@@ -1,10 +1,24 @@
-import express from "express";
-let setBody = function (app, JSON_LIMIT) {
-  // 1. 优先解析 XML 数据（必须在 json/urlencoded 之前）
-  app.use(express.raw({ type: "application/xml", limit: JSON_LIMIT }));
-  // 2. 再解析 JSON 和表单数据
-  app.use(express.json({ limit: JSON_LIMIT }));
-  app.use(express.urlencoded({ extended: false }));
-};
-
-export { setBody };
+import express from "express";
+
+/**
+ * 请求体解析中间件配置
+ * 配置请求体的解析方式
+ */
+
+/**
+ * 设置请求体解析中间件
+ * @param {Object} app - Express 应用实例
+ * @param {string} JSON_LIMIT - JSON 请求体大小限制
+ * @description
+ * 为 Express 应用配置请求体解析中间件
+ * 支持 JSON、URL 编码和 XML 格式的请求体
+ * @example
+ * setBody(app, '10mb');
+ */
+let setBody = function (app, JSON_LIMIT) {
+  app.use(express.raw({ type: "application/xml", limit: JSON_LIMIT }));
+  app.use(express.json({ limit: JSON_LIMIT }));
+  app.use(express.urlencoded({ extended: false }));
+};
+
+export { setBody };