befly 3.10.0 → 3.10.1

package/docs/reference/logger.md

@@ -98,8 +98,8 @@ Logger.info("用户登录成功");
 Logger.info({ userId: 123 }, "用户登录成功");
 
 // 警告日志
-Logger.warn("配置项已弃用");
-Logger.warn({ config: "oldOption" }, "配置项已弃用");
+Logger.warn("配置项不合法");
+Logger.warn({ config: "oldOption" }, "配置项不合法");
 
 // 错误日志
 Logger.error("数据库连接失败");
@@ -393,7 +393,7 @@ Logger.debug({ sql: query, params: params }, "SQL 查询");
 Logger.info({ userId: 123 }, "用户登录成功");
 
 // warn: 潜在问题，但不影响功能
-Logger.warn({ config: "deprecated" }, "配置项已弃用");
+Logger.warn({ config: "invalidOption" }, "配置项不合法");
 
 // error: 操作失败
 Logger.error({ err: error }, "数据库连接失败");

package/docs/reference/sync.md

@@ -5,10 +5,12 @@
 ## 目录
 
 - [概述](#概述)
+- [强约束清单](#强约束清单)
 - [syncTable 数据库同步](#synctable-数据库同步)
 - [syncApi 接口同步](#syncapi-接口同步)
 - [syncMenu 菜单同步](#syncmenu-菜单同步)
 - [syncDev 开发账户同步](#syncdev-开发账户同步)
+- [syncCache 缓存同步](#synccache-缓存同步)
 - [表名规则](#表名规则)
 - [注意事项](#注意事项)
 - [FAQ](#faq)
@@ -25,8 +27,18 @@ Sync 同步系统用于将代码定义同步到数据库，包括：
 | `syncApi`   | 同步 API 路由信息 | `addon_admin_api`                       |
 | `syncMenu`  | 同步菜单配置      | `addon_admin_menu`                      |
 | `syncDev`   | 创建开发者账户    | `addon_admin_role`, `addon_admin_admin` |
+| `syncCache` | 同步缓存          | Redis（apis/menu/role-permissions）     |
 
-**执行顺序**：`syncTable` → `syncApi` → `syncMenu` → `syncDev`
+**执行顺序**：`syncTable` → `syncApi` → `syncMenu` → `syncDev` → `syncCache`
+
+---
+
+## 强约束清单
+
+- **API routePath 必须是 pathname**：`syncApi` 写入数据库的 `routePath` 仅允许 `url.pathname`（例如 `/api/user/login`），禁止出现 method 前缀（`POST/api/...`、`POST /api/...`）。
+- **角色权限 apis 仅允许 pathname 字符串数组**：`syncDev` 写入角色表的 `apis` 必须是 pathname 字符串数组（严格模式不允许 numeric id）。
+- **权限缓存 Set member 仅允许 pathname**：角色接口权限缓存的 Set 成员为 pathname，与 method 无关。
+- **Redis prefix 不允许包含冒号**：配置 `redis.prefix` 不要包含 `:`（系统会自动拼接分隔符）。例如写 `befly`，不要写 `befly:`。
 
 > 说明：当前版本不提供 CLI 同步命令；同步逻辑在服务启动时由主进程自动执行（见 `packages/core/main.ts`）。
 
@@ -44,7 +56,7 @@ Sync 同步系统用于将代码定义同步到数据库，包括：
 import { syncTable } from "../sync/syncTable.js";
 import { scanSources } from "../utils/scanSources.js";
 
-// ctx：BeflyContext（需已具备 ctx.db / ctx.redis / ctx.config）
+// ctx：BeflyContext（需已具备 ctx.db / ctx.redis / ctx.cache / ctx.config）
 const sources = await scanSources();
 await syncTable(ctx, sources.tables);
 ```
@@ -103,14 +115,16 @@ await syncTable(ctx, sources.tables);
 
 ### 基本用法
 
-通常无需单独调用：`syncData()` 会按顺序执行 `syncApi` → `syncMenu` → `syncDev`。
+通常无需单独调用：服务启动流程会按顺序执行 `syncTable` → `syncApi` → `syncMenu` → `syncDev` → `syncCache`。
 
-如需在代码中手动触发整套数据同步：
+如需在代码中手动调用：
 
 ```typescript
-import { syncData } from "../sync/syncData.js";
+import { syncApi } from "../sync/syncApi.js";
+import { scanSources } from "../utils/scanSources.js";
 
-await syncData();
+const sources = await scanSources();
+await syncApi(ctx, sources.apis as any);
 ```
 
 ### 同步逻辑
@@ -137,20 +151,15 @@ await syncData();
 └─────────────────────────────────────────────────────┘
 ```
 
-### API 信息提取
+### 存储字段（重要）
 
-从 API 文件中提取以下信息：
+`syncApi` 会把扫描到的 API 信息同步到 `addon_admin_api` 表，核心字段为：
 
-```typescript
-interface ApiInfo {
-    name: string; // 接口名称（name 属性）
-    path: string; // 路由路径（由文件路径生成）
-    method: string; // 请求方法（method 属性，默认 POST）
-    description: string; // 接口描述（desc 属性）
-    addonName: string; // 所属 Addon 名称
-    addonTitle: string; // Addon 标题
-}
-```
+- `routePath`：只存 `url.pathname`（例如 `/api/user/login`），与 method 无关
+- `name`：接口名称
+- `addonName`：所属 addon（无 addon 时为空字符串）
+
+> 注意：`routePath` 必须是 pathname（以 `/` 开头），不允许写成 `POST /api/...` 或 `POST/api/...`。
 
 ### 统计信息
 
@@ -171,7 +180,19 @@ interface SyncApiStats {
 
 ### 基本用法
 
-同 `syncApi`，通常由 `syncData()` 统一触发。
+同 `syncApi`，通常由启动流程统一触发。
+
+如需手动调用，需要先对菜单配置做校验/过滤（例如 disableMenus）：
+
+```typescript
+import { checkMenu } from "../checks/checkMenu.js";
+import { syncMenu } from "../sync/syncMenu.js";
+import { scanSources } from "../utils/scanSources.js";
+
+const sources = await scanSources();
+const checkedMenus = await checkMenu(sources.addons, { disableMenus: ctx.config.disableMenus || [] });
+await syncMenu(ctx, checkedMenus);
+```
 
 ### 菜单配置文件
 
@@ -256,49 +277,56 @@ interface SyncMenuStats {
 
 ### 基本用法
 
-同 `syncApi`，通常由 `syncData()` 统一触发。
+同 `syncApi`，通常由启动流程统一触发。
 
 ### 同步逻辑
 
 ```
 ┌─────────────────────────────────────────────────────┐
-│                   syncDev                           │
+│ syncDev │
 ├─────────────────────────────────────────────────────┤
-│  1. 创建/更新开发角色：                              │
-│     - 角色名称：开发者                              │
-│     - 角色标识：dev                                 │
-│     - 权限：所有菜单 + 所有 API                     │
-│         ↓                                           │
-│  2. 获取所有菜单 ID 列表                            │
-│         ↓                                           │
-│  3. 获取所有 API ID 列表                            │
-│         ↓                                           │
-│  4. 更新角色权限：                                   │
-│     - menus: 所有菜单 ID                           │
-│     - apis: 所有 API ID                            │
-│         ↓                                           │
-│  5. 创建/更新开发管理员：                            │
-│     - 用户名：dev                                   │
-│     - 密码：从配置读取                              │
-│     - 角色：开发者角色                              │
+│ 1. 创建/更新开发角色： │
+│ - 角色名称：开发者 │
+│ - 角色标识：dev │
+│ - 权限：所有菜单 + 所有 API │
+│ ↓ │
+│ 2. 获取所有菜单 path 列表 │
+│ ↓ │
+│ 3. 获取所有 API routePath 列表 │
+│ ↓ │
+│ 4. 更新角色权限： │
+│ - menus: 所有菜单 path（字符串数组） │
+│ - apis: 所有 API routePath（pathname 字符串数组）│
+│ ↓ │
+│ 5. 创建/更新开发管理员： │
+│ - 用户名：dev │
+│ - 密码：从配置读取 │
+│ - 角色：开发者角色 │
 └─────────────────────────────────────────────────────┘
 ```
 
 ### 配置说明
 
-开发账户配置在 `befly.config.ts` 或环境配置文件中：
+开发账户配置在 `befly.config.ts` 或环境配置文件中（仅当 `devPassword` 有值时才会创建 dev 账号）：
 
-```typescript
-// befly.config.ts
-export default {
-    dev: {
-        username: "dev", // 开发账户用户名
-        password: "dev123456" // 开发账户密码
-    }
-};
+```json
+{
+    "devEmail": "dev@qq.com",
+    "devPassword": "beflydev123456"
+}
 ```
 
-await syncTable(ctx, sources.tables);
+> 注意：`syncDev` 会把 `menus/apis` 写入角色表，并且 `apis` 必须是 pathname 字符串数组（严格模式下不允许 numeric id）。
+
+---
+
+## syncCache 缓存同步
+
+同步缓存（统一收敛到启动流程末尾执行）：
+
+- `cacheApis()`：缓存接口列表
+- `cacheMenus()`：缓存菜单列表
+- `rebuildRoleApiPermissions()`：重建角色接口权限 Set（member 为 pathname，与 method 无关）
 
 ---
 
@@ -306,16 +334,23 @@ await syncTable(ctx, sources.tables);
 
 ```typescript
 import { syncTable } from "./sync/syncTable.js";
+import { syncApi } from "./sync/syncApi.js";
+import { syncCache } from "./sync/syncCache.js";
+import { syncDev } from "./sync/syncDev.js";
+import { syncMenu } from "./sync/syncMenu.js";
 import { scanSources } from "./utils/scanSources.js";
-import { syncData } from "./sync/syncData";
+import { checkMenu } from "./checks/checkMenu.js";
 
 // 启动前/启动中手动触发同步
-// ctx：BeflyContext（需已具备 ctx.db / ctx.redis / ctx.config）
+// ctx：BeflyContext（需已具备 ctx.db / ctx.redis / ctx.cache / ctx.config）
 const sources = await scanSources();
-await syncTable(ctx, sources.tables);
-await syncData();
+const checkedMenus = await checkMenu(sources.addons, { disableMenus: ctx.config.disableMenus || [] });
 
-// 说明：syncData 内部会固定顺序执行：syncApi → syncMenu → syncDev
+await syncTable(ctx, sources.tables);
+await syncApi(ctx, sources.apis as any);
+await syncMenu(ctx, checkedMenus);
+await syncDev(ctx, { devEmail: ctx.config.devEmail, devPassword: ctx.config.devPassword });
+await syncCache(ctx);
 ```
 
 ---
@@ -357,7 +392,7 @@ addons/demo/tables/article.json   → addon_demo_article
 
 ### 1. 执行顺序
 
-**必须按顺序执行**：`syncTable` → `syncApi` → `syncMenu` → `syncDev`
+**必须按顺序执行**：`syncTable` → `syncApi` → `syncMenu` → `syncDev` → `syncCache`
 
 - `syncApi` 依赖 `addon_admin_api` 表（由 `syncTable` 创建）
 - `syncMenu` 依赖 `addon_admin_menu` 表（由 `syncTable` 创建）
@@ -386,11 +421,10 @@ CacheKeys.tableColumns(tableName); // table:columns:{tableName}
 
 ### 4. 连接管理
 
-Sync 命令会自动管理数据库和 Redis 连接：
+`sync*` 函数本身不会负责建立连接/加载插件：
 
-- 执行前建立连接
-- 执行后关闭连接
-- 出错时正确清理资源
+- 你需要在调用前确保 `Connect.connect(...)` 已执行，并且 `Db/Redis/cache` 插件已注入到 `ctx`。
+- 服务启动流程已内置这套顺序（见 `packages/core/main.ts`）。
 
 ---
 
@@ -425,28 +459,20 @@ A: Addon 表名格式为 `addon_{addonName}_{tableName}`，建议：
 
 A:
 
-1. 检查错误日志确定失败原因
-   A: `syncTable()` 会跳过长度收缩并告警；请手动评估并处理（例如先清理/截断数据，再手动执行 DDL），再重新启动服务或再次调用 `syncTable()`。
+1. 检查错误日志确定失败原因（例如表不存在、字段变更被跳过等）
 2. sync 命令是幂等的，可以安全地多次执行
 
 ### Q: 如何只同步某个 Addon 的表？
 
-await syncTable(ctx, sources.tables);
 A: 当前不支持按 Addon 或单表筛选；会同步项目与所有 Addon 的表定义。
 
 ### Q: 开发账户密码在哪里配置？
 
-A: 在配置文件中设置：
+A: 在配置文件中设置（仅当 `devPassword` 有值时才会创建 dev 账号）：
 
-```typescript
-// befly.config.ts
-export default {
-    dev: {
-        username: "dev",
-        password: "your_password"
-    }
-};
+```json
+{
+    "devEmail": "dev@qq.com",
+    "devPassword": "beflydev123456"
+}
 ```
-
-（不再提供 CLI 参数/命令；按配置文件机制设置即可。）
-await syncTable(ctx, sources.tables);

package/docs/reference/table.md

@@ -567,7 +567,7 @@ await syncTable(ctx, sources.tables);
 
 ### 安全机制
 
-1. **禁止危险类型变更**：不允许从 `BIGINT` 改为 `VARCHAR` 等不兼容变更
+1. **禁止危险类型变更**：不允许从 `BIGINT` 改为 `VARCHAR` 等高风险变更
 2. **长度收缩保护**：默认跳过长度收缩，避免数据截断
 3. **保留字段保护**：不允许定义系统保留字段
 

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "befly",
-    "version": "3.10.0",
-    "gitHead": "faa8189c7d23cf45885c03d1425cba8f5bf45df9",
+    "version": "3.10.1",
+    "gitHead": "123125b9d7a6c26879a5b5c9d3ac05e2082141c6",
     "private": false,
     "description": "Befly - 为 Bun 专属打造的 TypeScript API 接口框架核心引擎",
     "keywords": [
@@ -63,7 +63,7 @@
         "typecheck": "bunx tsgo --noEmit"
     },
     "dependencies": {
-        "befly-shared": "1.0.0",
+        "befly-shared": "1.3.0",
         "chalk": "^5.6.2",
         "es-toolkit": "^1.43.0",
         "fast-jwt": "^6.1.0",