befly 3.8.30 → 3.8.32

package/README.md

@@ -196,6 +196,89 @@ DB_NAME=/path/to/database.sqlite
 DB_NAME=:memory:
 ```
 
+## ⚙️ 项目配置文件
+
+Befly 使用 `befly.config.ts` 作为统一配置文件：
+
+```typescript
+// befly.config.ts
+export const beflyConfig = {
+    appName: '我的应用',
+    appPort: 3000,
+    appHost: '0.0.0.0',
+
+    // 数据库配置（优先使用环境变量）
+    db: {
+        type: 'mysql',
+        host: '127.0.0.1',
+        port: 3306,
+        username: 'root',
+        password: 'password',
+        database: 'my_database'
+    },
+
+    // Redis 配置
+    redis: {
+        host: '127.0.0.1',
+        port: 6379,
+        prefix: 'befly:'
+    },
+
+    // CORS 跨域配置
+    cors: {
+        origin: ['http://localhost:5173'],
+        methods: ['GET', 'POST', 'PUT', 'DELETE']
+    },
+
+    // Addon 插件配置
+    addons: {
+        admin: {
+            email: { host: 'smtp.qq.com' }
+        }
+    }
+};
+```
+
+### 数据库连接
+
+框架会自动从 `beflyConfig` 获取配置并建立连接，无需手动传参：
+
+```typescript
+import { Connect } from 'befly/lib/connect';
+
+// 连接 SQL 数据库（配置自动从 beflyConfig.db 获取）
+await Connect.connectSql();
+
+// 连接 Redis（配置自动从 beflyConfig.redis 获取）
+await Connect.connectRedis();
+
+// 同时连接 SQL 和 Redis
+await Connect.connect();
+
+// 获取连接状态
+const status = Connect.getStatus();
+console.log(status.sql.connected); // true/false
+console.log(status.redis.connected); // true/false
+
+// 断开连接
+await Connect.disconnect();
+```
+
+### 配置文件迁移指南
+
+如果你的项目之前使用 `app.config.ts`，请按以下步骤迁移：
+
+1. **重命名文件**：`app.config.ts` → `befly.config.ts`
+2. **更新导出名**：`config` → `beflyConfig`
+
+```typescript
+// 旧写法
+export const config = { ... };
+
+// 新写法
+export const beflyConfig = { ... };
+```
+
 ## 📖 文档
 
 完整文档请访问 [`/docs` 目录](./docs/)：

package/{config.ts → befly.config.ts}

@@ -1,10 +1,14 @@
 /**
- * Befly 默认配置
- * 包含所有配置项的默认值
+ * Befly 配置模块
+ * 自动加载 configs 目录下的配置文件并与默认配置合并
+ * 支持环境分离：befly.common.json + befly.dev/prod.json + befly.local.json
  */
+import { scanConfig } from 'befly-shared/scanConfig';
+
 import type { BeflyOptions } from './types/befly.js';
 
-export const defaultOptions: Required<Omit<BeflyOptions, 'devPassword'>> = {
+/** 默认配置 */
+const defaultOptions: BeflyOptions = {
     // ========== 核心参数 ==========
     nodeEnv: (process.env.NODE_ENV as any) || 'development',
     appName: '野蜂飞舞',
@@ -63,8 +67,24 @@ export const defaultOptions: Required<Omit<BeflyOptions, 'devPassword'>> = {
     },
 
     // ========== 禁用配置 ==========
-    /** 禁用的钩子列表 */
     disableHooks: [],
-    /** 禁用的插件列表 */
-    disablePlugins: []
+    disablePlugins: [],
+    hiddenMenus: [],
+
+    // ========== Addon 配置 ==========
+    addons: {}
 };
+
+// 确定环境
+const nodeEnv = process.env.NODE_ENV || 'development';
+const envSuffix = nodeEnv === 'production' ? 'prod' : 'dev';
+
+// 使用 scanConfig 一次性加载并合并所有配置文件
+// 合并顺序：defaultOptions ← befly.common.json ← befly.dev/prod.json ← befly.local.json
+export const beflyConfig = (await scanConfig({
+    dirs: ['configs'],
+    files: ['befly.common', `befly.${envSuffix}`, 'befly.local'],
+    extensions: ['.json'],
+    mode: 'merge',
+    defaults: defaultOptions
+})) as BeflyOptions;

package/checks/checkApp.ts

@@ -1,6 +1,6 @@
 // 内部依赖
 import { join } from 'node:path';
-import { existsSync, mkdirSync } from 'node:fs';
+import { existsSync, mkdirSync, writeFileSync } from 'node:fs';
 
 // 相对导入
 import { Logger } from '../lib/logger.js';
@@ -24,6 +24,36 @@ export async function checkApp(): Promise<void> {
         if (!existsSync(logsDir)) {
             mkdirSync(logsDir, { recursive: true });
         }
+
+        // 检查并创建 configs 目录和配置文件
+        const configsDir = join(projectDir, 'configs');
+        if (!existsSync(configsDir)) {
+            mkdirSync(configsDir, { recursive: true });
+        }
+
+        // 检查并创建 befly.common.json
+        const beflyJsonPath = join(configsDir, 'befly.common.json');
+        if (!existsSync(beflyJsonPath)) {
+            writeFileSync(beflyJsonPath, '{}', 'utf-8');
+        }
+
+        // 检查并创建 befly.dev.json
+        const beflyDevJsonPath = join(configsDir, 'befly.dev.json');
+        if (!existsSync(beflyDevJsonPath)) {
+            writeFileSync(beflyDevJsonPath, '{}', 'utf-8');
+        }
+
+        // 检查并创建 befly.prod.json
+        const beflyProdJsonPath = join(configsDir, 'befly.prod.json');
+        if (!existsSync(beflyProdJsonPath)) {
+            writeFileSync(beflyProdJsonPath, '{}', 'utf-8');
+        }
+
+        // 检查并创建 befly.local.json
+        const beflyLocalJsonPath = join(configsDir, 'befly.local.json');
+        if (!existsSync(beflyLocalJsonPath)) {
+            writeFileSync(beflyLocalJsonPath, '{}', 'utf-8');
+        }
     } catch (error: any) {
         Logger.error('项目结构检查过程中出错', error);
         throw error;

package/hooks/cors.ts

@@ -1,5 +1,6 @@
 // 相对导入
 import { setCorsOptions } from '../util.js';
+import { beflyConfig } from '../befly.config.js';
 
 // 类型导入
 import type { Hook } from '../types/hook.js';
@@ -24,11 +25,10 @@ const hook: Hook = {
             credentials: 'true'
         };
 
-        const userConfig = (hook as any).config || {};
-        const config = { ...defaultConfig, ...userConfig };
+        const corsConfig = { ...defaultConfig, ...(beflyConfig.cors || {}) };
 
         // 设置 CORS 响应头
-        const headers = setCorsOptions(req, config);
+        const headers = setCorsOptions(req, corsConfig);
 
         ctx.corsHeaders = headers;
 

package/hooks/parser.ts

@@ -53,12 +53,12 @@ const hook: Hook = {
                     }
                 } else {
                     // 不支持的 Content-Type
-                    ctx.response = ErrorResponse(ctx, '无效的请求参数格式');
+                    ctx.response = ErrorResponse(ctx, '无效的请求参数格式', 1, null, { location: 'content-type', value: contentType });
                     return;
                 }
-            } catch (e) {
+            } catch (e: any) {
                 // 解析失败
-                ctx.response = ErrorResponse(ctx, '无效的请求参数格式');
+                ctx.response = ErrorResponse(ctx, '无效的请求参数格式', 1, null, { location: 'body', error: e.message });
                 return;
             }
         }

package/hooks/validator.ts

@@ -23,7 +23,7 @@ const hook: Hook = {
         const result = Validator.validate(ctx.body, ctx.api.fields, ctx.api.required || []);
 
         if (result.code !== 0) {
-            ctx.response = ErrorResponse(ctx, '无效的请求参数格式', 1, result.fields);
+            ctx.response = ErrorResponse(ctx, result.firstError || '参数验证失败', 1, null, result.fieldErrors);
             return;
         }
     }

package/lib/cacheHelper.ts

@@ -46,8 +46,6 @@ export class CacheHelper {
 
             if (result === null) {
                 Logger.warn('⚠️ 接口缓存失败');
-            } else {
-                Logger.info(`✅ 已缓存 ${apiList.length} 个接口到 Redis (Key: ${RedisKeys.apisAll()})`);
             }
         } catch (error: any) {
             Logger.error({ err: error }, '⚠️ 接口缓存异常');
@@ -78,8 +76,6 @@ export class CacheHelper {
 
             if (result === null) {
                 Logger.warn('⚠️ 菜单缓存失败');
-            } else {
-                Logger.info(`✅ 已缓存 ${menus.length} 个菜单到 Redis (Key: ${RedisKeys.menusAll()})`);
             }
         } catch (error: any) {
             Logger.warn({ err: error }, '⚠️ 菜单缓存异常');
@@ -159,8 +155,6 @@ export class CacheHelper {
 
             // 统计成功缓存的角色数
             const cachedRoles = results.filter((r) => r > 0).length;
-
-            Logger.info(`✅ 已缓存 ${cachedRoles} 个角色的接口权限（共 ${cacheOperations.reduce((sum, op) => sum + op.apiPaths.length, 0)} 个接口）`);
         } catch (error: any) {
             Logger.warn({ err: error }, '⚠️ 角色权限缓存异常');
         }

package/lib/cipher.ts

@@ -4,7 +4,8 @@
  */
 
 import { createSign } from 'node:crypto';
-import type { EncodingType, HashAlgorithm, PasswordHashOptions } from '../types/crypto';
+
+import type { EncodingType, HashAlgorithm, PasswordHashOptions } from 'befly-shared/types';
 
 /**
  * 加密工具类

package/lib/connect.ts

@@ -1,18 +1,18 @@
 /**
  * 数据库连接管理器
  * 统一管理 SQL 和 Redis 连接
+ * 配置从 beflyConfig 全局对象获取
  */
 
 import { SQL, RedisClient } from 'bun';
 
+import { beflyConfig } from '../befly.config.js';
 import { Logger } from './logger.js';
 
-import type { BeflyOptions, DatabaseConfig, RedisConfig } from '../types/befly.js';
-import type { SqlClientOptions } from '../types/database.js';
-
 /**
  * 数据库连接管理器
  * 使用静态方法管理全局单例连接
+ * 所有配置从 beflyConfig 自动获取
  */
 export class Connect {
     private static sqlClient: SQL | null = null;
@@ -29,10 +29,12 @@ export class Connect {
 
     /**
      * 连接 SQL 数据库
-     * @param config - 数据库配置
+     * 配置从 beflyConfig.db 获取
      * @returns SQL 客户端实例
      */
-    static async connectSql(config: DatabaseConfig): Promise<SQL> {
+    static async connectSql(): Promise<SQL> {
+        const config = beflyConfig.db || {};
+
         // 构建数据库连接字符串
         const type = config.type || 'mysql';
         const host = config.host || '127.0.0.1';
@@ -135,10 +137,12 @@ export class Connect {
 
     /**
      * 连接 Redis
-     * @param config - Redis 配置
+     * 配置从 beflyConfig.redis 获取
      * @returns Redis 客户端实例
      */
-    static async connectRedis(config: RedisConfig = {}): Promise<RedisClient> {
+    static async connectRedis(): Promise<RedisClient> {
+        const config = beflyConfig.redis || {};
+
         try {
             // 构建 Redis URL
             const host = config.host || '127.0.0.1';
@@ -208,21 +212,15 @@ export class Connect {
 
     /**
      * 连接所有数据库（SQL + Redis）
-     * @param config - Befly 配置对象（可选）
-     * @param options - 连接选项
+     * 配置从 beflyConfig 自动获取
      */
-    static async connect(config?: BeflyOptions, options?: { sql?: SqlClientOptions; redis?: boolean }): Promise<void> {
+    static async connect(): Promise<void> {
         try {
-            // 如果 sql 参数不是 false，则连接 SQL
-            // 优先级：options.sql > config.db > 跳过
-            const sqlConfig = options?.db || {};
-            if (sqlConfig) {
-                await this.connectSql(sqlConfig);
-            }
+            // 连接 SQL
+            await this.connectSql();
 
-            // 如果 redis 参数不是 false，则连接 Redis
-            const redisConfig = config?.redis || {};
-            await this.connectRedis(redisConfig);
+            // 连接 Redis
+            await this.connectRedis();
         } catch (error: any) {
             Logger.error({ err: error }, '数据库初始化失败');
             await this.disconnect();

package/lib/jwt.ts

@@ -5,7 +5,7 @@
 import { createSigner, createVerifier, createDecoder } from 'fast-jwt';
 
 import type { AuthConfig } from '../types/befly.js';
-import type { JwtPayload, JwtSignOptions, JwtVerifyOptions, JwtDecoded, JwtHeader } from '../types/jwt.js';
+import type { JwtPayload, JwtSignOptions, JwtVerifyOptions, JwtDecoded, JwtHeader } from 'befly-shared/types';
 
 interface FastJwtComplete {
     header: JwtHeader;

package/lib/logger.ts

@@ -5,7 +5,7 @@
 import pino from 'pino';
 import { join } from 'pathe';
 
-import type { LoggerConfig } from '../types/logger.js';
+import type { LoggerConfig } from 'befly-shared/types';
 
 let instance: pino.Logger | null = null;
 let mockInstance: pino.Logger | null = null;