befly 3.8.19 → 3.8.21

package/main.ts

@@ -3,39 +3,34 @@
  * 提供简洁的框架接口，核心逻辑已提取到 loader 层
  */
 
-import { Env } from './env.js';
+// ========== 外部依赖 ==========
+import { calcPerfTime } from 'befly-util';
 
+// ========== 相对导入 ==========
 import { Logger } from './lib/logger.js';
 import { Cipher } from './lib/cipher.js';
 import { Jwt } from './lib/jwt.js';
 import { Database } from './lib/database.js';
+import { DbHelper } from './lib/dbHelper.js';
+import { RedisHelper } from './lib/redisHelper.js';
 import { loadPlugins } from './loader/loadPlugins.js';
+import { loadHooks } from './loader/loadHooks.js';
 import { loadApis } from './loader/loadApis.js';
 import { rootHandler } from './router/root.js';
 import { apiHandler } from './router/api.js';
 import { staticHandler } from './router/static.js';
+import { checkApp } from './checks/checkApp.js';
+import { checkTable } from './checks/checkTable.js';
+import { checkApi } from './checks/checkApi.js';
+import { syncAllCommand } from './sync/syncAll.js';
 import { coreDir } from './paths.js';
-import { DbHelper } from './lib/dbHelper.js';
-import { RedisHelper } from './lib/redisHelper.js';
-import { checkTable, checkApi, checkApp } from './check.js';
-import {
-    //
-    Yes,
-    No,
-    keysToSnake,
-    keysToCamel,
-    arrayKeysToCamel,
-    pickFields,
-    fieldClear,
-    calcPerfTime,
-    scanAddons,
-    getAddonDir,
-    addonDirExists
-} from './util.js';
+import { defaultOptions } from './config.js';
 
+// ========== 类型导入 ==========
 import type { Server } from 'bun';
-import type { BeflyContext } from './types/befly.js';
+import type { BeflyContext, BeflyOptions } from './types/befly.js';
 import type { Plugin } from './types/plugin.js';
+import type { Hook } from './types/hook.js';
 import type { ApiRoute } from './types/api.js';
 /**
  * Befly 框架核心类
@@ -48,142 +43,120 @@ export class Befly {
     /** 插件列表 */
     private pluginLists: Plugin[] = [];
 
+    /** 钩子列表 */
+    private hookLists: Hook[] = [];
+
     /** 应用上下文 */
     public appContext: BeflyContext;
 
-    constructor() {
+    /** 最终配置（合并默认值后） */
+    public config: BeflyOptions;
+
+    constructor(options: BeflyOptions = {}) {
         this.appContext = {};
+        // 合并配置：用户配置 > 默认配置（最多 2 级）
+        this.config = { ...defaultOptions };
+        for (const key in options) {
+            const value = options[key as keyof BeflyOptions];
+            if (value !== undefined && value !== null) {
+                if (typeof value === 'object' && !Array.isArray(value)) {
+                    this.config[key as keyof BeflyOptions] = { ...defaultOptions[key as keyof typeof defaultOptions], ...value } as any;
+                } else {
+                    this.config[key as keyof BeflyOptions] = value as any;
+                }
+            }
+        }
     }
 
     /**
      * 启动完整的生命周期流程
      * @returns HTTP 服务器实例
      */
-    private async start(): Promise<Server> {
-        const serverStartTime = Bun.nanoseconds();
-
-        // 1. 加载所有 API（动态导入必须在最前面，避免 Bun 1.3.2 的崩溃 bug）
-        await loadApis(this.apiRoutes);
-
-        // 2. 执行项目结构检查
-        const appCheckResult = await checkApp();
-        if (!appCheckResult) {
-            Logger.error('项目结构检查失败，程序退出');
+    public async start(): Promise<Server> {
+        try {
+            const serverStartTime = Bun.nanoseconds();
+
+            // 1. 执行启动检查
+            await checkApp();
+            await checkTable();
+            await checkApi();
+
+            // 4. 加载插件
+            await loadPlugins({
+                pluginLists: this.pluginLists,
+                appContext: this.appContext,
+                pluginsConfig: this.config as any
+            });
+
+            // 5. 加载钩子
+            await loadHooks({
+                hookLists: this.hookLists,
+                pluginsConfig: this.config as any
+            });
+
+            // 6. 加载所有 API
+            await loadApis(this.apiRoutes);
+
+            // 7. 自动同步 (默认开启)
+            await syncAllCommand(this.config);
+
+            // 8. 启动 HTTP 服务器
+            const server = Bun.serve({
+                port: this.config.appPort,
+                hostname: this.config.appHost,
+                routes: {
+                    '/': rootHandler,
+                    '/api/*': apiHandler(this.apiRoutes, this.hookLists, this.appContext),
+                    '/*': staticHandler(this.config.cors)
+                },
+                error: (error: Error) => {
+                    Logger.error('服务启动时发生错误', error);
+                    return Response.json({ code: 1, msg: '内部服务器错误' });
+                }
+            });
+
+            const finalStartupTime = calcPerfTime(serverStartTime);
+            Logger.info(`${this.config.appName} 启动成功! `);
+            Logger.info(`服务器启动耗时: ${finalStartupTime}`);
+            Logger.info(`服务器监听地址: http://${this.config.appHost}:${this.config.appPort}`);
+
+            // 9. 注册优雅关闭处理
+            const gracefulShutdown = async (signal: string) => {
+                // 停止接收新请求
+                server.stop(true);
+                Logger.info('HTTP 服务器已停止');
+
+                // 关闭数据库连接
+                try {
+                    await Database.disconnect();
+                    Logger.info('数据库连接已关闭');
+                } catch (error: any) {
+                    Logger.error('关闭数据库连接时出错:', error);
+                }
+
+                Logger.info('服务器已优雅关闭');
+                process.exit(0);
+            };
+
+            process.on('SIGTERM', () => gracefulShutdown('SIGTERM'));
+            process.on('SIGINT', () => gracefulShutdown('SIGINT'));
+
+            return server;
+        } catch (error: any) {
+            Logger.error('Befly 启动失败', error);
             process.exit(1);
         }
-
-        // 3. 执行表定义检查
-        const tableCheckResult = await checkTable();
-        if (!tableCheckResult) {
-            Logger.error('表定义检查失败，程序退出');
-            process.exit(1);
-        }
-
-        // 4. 执行 API 定义检查
-        const apiCheckResult = await checkApi();
-        if (!apiCheckResult) {
-            Logger.error('API 定义检查失败，程序退出');
-            process.exit(1);
-        }
-
-        // 5. 加载插件
-        await loadPlugins({
-            pluginLists: this.pluginLists,
-            appContext: this.appContext
-        });
-
-        // 4. 启动 HTTP 服务器
-        const totalStartupTime = calcPerfTime(serverStartTime);
-
-        return await this.startServer();
-    }
-
-    /**
-     * 启动 HTTP 服务器
-     * @returns HTTP 服务器实例
-     */
-    private async startServer(): Promise<Server> {
-        const startTime = Bun.nanoseconds();
-
-        const server = Bun.serve({
-            port: Env.APP_PORT,
-            hostname: Env.APP_HOST,
-            routes: {
-                '/': rootHandler,
-                '/api/*': apiHandler(this.apiRoutes, this.pluginLists, this.appContext),
-                '/*': staticHandler
-            },
-            error: (error: Error) => {
-                Logger.error('服务启动时发生错误', error);
-                return Response.json({ code: 1, msg: '内部服务器错误' });
-            }
-        });
-
-        const finalStartupTime = calcPerfTime(startTime);
-        Logger.info(`${Env.APP_NAME} 启动成功! `);
-        Logger.info(`服务器启动耗时: ${finalStartupTime}`);
-        Logger.info(`服务器监听地址: http://${Env.APP_HOST}:${Env.APP_PORT}`);
-
-        return server;
-    }
-
-    /**
-     * 启动服务器并注册优雅关闭处理
-     */
-    async listen(): Promise<Server> {
-        const server = await this.start();
-
-        const gracefulShutdown = async (signal: string) => {
-            // 1. 停止接收新请求
-            server.stop(true);
-            Logger.info('HTTP 服务器已停止');
-
-            // 2. 关闭数据库连接
-            try {
-                await Database.disconnect();
-                Logger.info('数据库连接已关闭');
-            } catch (error: any) {
-                Logger.err('关闭数据库连接时出错:', error);
-            }
-
-            Logger.info('服务器已优雅关闭');
-            process.exit(0);
-        };
-
-        process.on('SIGTERM', () => gracefulShutdown('SIGTERM'));
-        process.on('SIGINT', () => gracefulShutdown('SIGINT'));
-
-        return server;
     }
 }
 
 // 核心类和工具导出
 export {
     // 配置
-    Env,
     Logger,
     Cipher,
     Jwt,
-    Yes,
-    No,
     Database,
     DbHelper,
     RedisHelper,
-    coreDir,
-    checkTable,
-    checkApi,
-    checkApp
-};
-
-// 工具函数命名空间导出
-export const utils = {
-    keysToSnake: keysToSnake,
-    keysToCamel: keysToCamel,
-    arrayKeysToCamel: arrayKeysToCamel,
-    pickFields: pickFields,
-    fieldClear: fieldClear,
-    calcPerfTime: calcPerfTime,
-    scanAddons: scanAddons,
-    getAddonDir: getAddonDir,
-    addonDirExists: addonDirExists
+    coreDir
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "befly",
-    "version": "3.8.19",
+    "version": "3.8.21",
     "description": "Befly - 为 Bun 专属打造的 TypeScript API 接口框架核心引擎",
     "type": "module",
     "private": false,
@@ -9,14 +9,15 @@
         "registry": "https://registry.npmjs.org"
     },
     "main": "main.ts",
-    "types": "./types/index.d.ts",
+    "types": "main.ts",
     "exports": {
         ".": {
+            "types": "./main.ts",
             "default": "./main.ts"
         },
         "./types": {
-            "types": "./types/index.d.ts",
-            "default": "./types/index.d.ts"
+            "types": "./types/index.ts",
+            "default": "./types/index.ts"
         }
     },
     "scripts": {
@@ -38,32 +39,40 @@
     "homepage": "https://chensuiyi.me",
     "license": "Apache-2.0",
     "files": [
-        "lib/",
-        "loader/",
-        "plugins/",
-        "router/",
-        "types/",
+        "checks",
+        "dist",
+        "hooks",
+        "lib",
+        "loader",
+        "plugins",
+        "router",
+        "sync",
+        "tests",
+        "types",
         ".npmrc",
         ".prettierignore",
         ".prettierrc",
         "bunfig.toml",
-        "tsconfig.json",
+        "config.ts",
         "LICENSE",
         "main.ts",
-        "check.ts",
-        "env.ts",
         "paths.ts",
-        "util.ts",
         "package.json",
         "README.md",
+        "tsconfig.json",
         "LICENSE"
     ],
     "engines": {
         "bun": ">=1.3.0"
     },
     "dependencies": {
+        "befly-util": "1.0.0",
+        "chalk": "^5.6.2",
         "es-toolkit": "^1.41.0",
         "pathe": "^2.0.3"
     },
-    "gitHead": "0619a7cfdd889be9fdd1b187c3d6522288707df0"
+    "gitHead": "ac90b47c807b2c016ac2331b56814e335a82b291",
+    "devDependencies": {
+        "typescript": "^5.9.3"
+    }
 }

package/paths.ts

@@ -39,6 +39,16 @@ export const coreCheckDir = join(__dirname, 'checks');
  */
 export const corePluginDir = join(__dirname, 'plugins');
 
+/**
+ * Core 框架钩子目录
+ * @description packages/core/hooks/
+ * @usage 存放内置钩子（auth, cors, parser 等）
+ */
+export const coreHookDir = join(__dirname, 'hooks');
+
+/**
+ * Core 框架 API 目录
+
 /**
  * Core 框架 API 目录
  * @description packages/core/apis/
@@ -76,6 +86,16 @@ export const projectCheckDir = join(projectDir, 'checks');
  */
 export const projectPluginDir = join(projectDir, 'plugins');
 
+/**
+ * 项目钩子目录
+ * @description {projectDir}/hooks/
+ * @usage 存放用户自定义钩子
+ */
+export const projectHookDir = join(projectDir, 'hooks');
+
+/**
+ * 项目 API 目录
+
 /**
  * 项目 API 目录
  * @description {projectDir}/apis/

package/plugins/cache.ts

@@ -11,9 +11,7 @@ import type { BeflyContext } from '../types/befly.js';
  * 缓存插件
  */
 const cachePlugin: Plugin = {
-    name: '_cache',
-    after: ['_db', '_redis'],
-
+    after: ['db', 'redis'],
     async onInit(befly: BeflyContext): Promise<CacheHelper> {
         return new CacheHelper(befly);
     }

package/plugins/db.ts

@@ -3,7 +3,6 @@
  * 初始化数据库连接和 SQL 管理器
  */
 
-import { Env } from '../env.js';
 import { Logger } from '../lib/logger.js';
 import { Database } from '../lib/database.js';
 import { DbHelper } from '../lib/dbHelper.js';
@@ -14,21 +13,19 @@ import type { BeflyContext } from '../types/befly.js';
  * 数据库插件
  */
 const dbPlugin: Plugin = {
-    name: '_db',
-    after: ['_redis'],
-
-    async onInit(befly: BeflyContext): Promise<DbHelper | Record<string, never>> {
+    after: ['redis'],
+    async onInit(this: Plugin, befly: BeflyContext): Promise<DbHelper | Record<string, never>> {
         let sql: any = null;
+        const config = this.config || {};
 
         try {
-            if (Env.DATABASE_ENABLE === 1) {
+            // 默认启用，除非显式禁用
+            if (config.enable !== 0) {
                 // 创建 Bun SQL 客户端（内置连接池），并确保连接验证成功后再继续
-                // 从环境变量读取连接超时配置
-                const connectionTimeout = Env.DB_CONNECTION_TIMEOUT ? parseInt(Env.DB_CONNECTION_TIMEOUT) : 30000;
+                // 从配置读取连接超时配置
+                // const connectionTimeout = config.connectionTimeout ? parseInt(config.connectionTimeout) : 30000;
 
-                sql = await Database.connectSql({
-                    connectionTimeout
-                });
+                sql = await Database.connectSql(config);
 
                 // 创建数据库管理器实例，直接传入 sql 对象
                 const dbManager = new DbHelper(befly, sql);

package/plugins/logger.ts

@@ -11,11 +11,13 @@ import type { BeflyContext } from '../types/befly.js';
  * 日志插件
  */
 const loggerPlugin: Plugin = {
-    name: '_logger',
     after: [],
-
-    async onInit(befly: BeflyContext): Promise<typeof Logger> {
+    async onInit(this: Plugin, befly: BeflyContext): Promise<typeof Logger> {
         try {
+            // 配置 Logger
+            if (this.config) {
+                Logger.configure(this.config);
+            }
             return Logger;
         } catch (error: any) {
             // 插件内禁止直接退出进程，抛出异常交由主流程统一处理

package/plugins/redis.ts

@@ -3,7 +3,6 @@
  * 初始化 Redis 连接和助手工具
  */
 
-import { Env } from '../env.js';
 import { Logger } from '../lib/logger.js';
 import { RedisHelper } from '../lib/redisHelper.js';
 import { Database } from '../lib/database.js';
@@ -14,21 +13,18 @@ import type { BeflyContext } from '../types/befly.js';
  * Redis 插件
  */
 const redisPlugin: Plugin = {
-    name: '_redis',
-    after: ['_logger'],
-
-    async onInit(befly: BeflyContext): Promise<RedisHelper | Record<string, never>> {
+    after: ['logger'],
+    async onInit(this: Plugin, befly: BeflyContext): Promise<RedisHelper | Record<string, never>> {
+        const config = this.config || {};
         try {
-            if (Env.DATABASE_ENABLE === 1) {
-                // 初始化 Redis 客户端（统一使用 database.ts 的连接管理）
-                await Database.connectRedis();
+            // 默认启用，除非显式禁用 (这里假设只要配置了 redis 插件就启用，或者检查 enable 字段)
+            // 为了兼容性，如果 config 为空，可能意味着使用默认值连接本地 redis
+
+            // 初始化 Redis 客户端（统一使用 database.ts 的连接管理）
+            await Database.connectRedis(config);
 
-                // 返回 RedisHelper 实例
-                return new RedisHelper();
-            } else {
-                Logger.warn('Redis 未启用，跳过初始化');
-                return {};
-            }
+            // 返回 RedisHelper 实例
+            return new RedisHelper(config.prefix);
         } catch (error: any) {
             Logger.error('Redis 初始化失败', error);