befly 3.76.1 → 3.76.3

package/Befly.js

@@ -0,0 +1,159 @@
+import { Logger } from "#befly/libs/logger/index.js";
+
+import { BEFLY_ADMIN_TABLE, BEFLY_API_TABLE, BEFLY_MENU_TABLE, BEFLY_ROLE_TABLE } from "./configs/constConfig.js";
+import { createCron, registerCorns } from "./libs/cron.js";
+import { tool } from "./libs/tool.js";
+import { apiHandler } from "./router/api.js";
+import { rootHandler } from "./router/root.js";
+import { staticHandler } from "./router/static.js";
+import { syncApi } from "./sync/api.js";
+import { syncCache } from "./sync/cache.js";
+import { syncDev } from "./sync/dev.js";
+import { syncMenu } from "./sync/menu.js";
+import { calcPerfTime } from "./utils/calcPerfTime.js";
+import { createError } from "./utils/error.js";
+import { isPrimaryProcess } from "./utils/is.js";
+import { waitFor } from "./utils/util.js";
+
+const SYNC_READY_KEY = "befly:syncReady";
+
+async function assertRuntimeReady(context) {
+    for (const key of ["redis", "mysql", "cache"]) {
+        if (!context[key]) throw createError(`启动失败：ctx.${key} 未初始化`, { code: "runtime", subsystem: "start", operation: "runtimeReady" });
+    }
+
+    const missingTables = [];
+    for (const table of [BEFLY_API_TABLE, BEFLY_MENU_TABLE, BEFLY_ADMIN_TABLE, BEFLY_ROLE_TABLE]) {
+        if (!(await context.mysql.tableExists(table)).data) missingTables.push(table);
+    }
+    if (missingTables.length > 0) throw createError(`同步依赖表缺失: ${missingTables.join("、")}`, { code: "runtime", subsystem: "start", operation: "tableExists", missingTables: missingTables });
+}
+
+export class Befly {
+    constructor(init = {}) {
+        this.context = {
+            config: init.config || {},
+            tables: init.tables || {},
+            logger: Logger,
+            tool: tool
+        };
+        this.menus = init.menus || [];
+        this.apis = init.apis || [];
+        this.hooks = init.hooks || [];
+        this.plugins = init.plugins || [];
+        this.corns = init.corns || [];
+        this.server = null;
+        this.started = false;
+    }
+
+    async start() {
+        if (this.started) throw createError("Befly 已启动", { code: "policy", subsystem: "start", operation: "duplicate" });
+
+        try {
+            const serverStartTime = Bun.nanoseconds();
+            const pluginsStartTime = Bun.nanoseconds();
+            for (const item of this.plugins.toSorted((a, b) => a.order - b.order)) {
+                const pluginStartTime = Bun.nanoseconds();
+                this.context[item.fileName] = await item.handler(this.context);
+                Logger.info(`启动 插件 ${item.fileName} 耗时 ${calcPerfTime(pluginStartTime)}`);
+            }
+            Logger.info(`启动 插件初始化完成，耗时 ${calcPerfTime(pluginsStartTime)}`);
+
+            const runtimeReadyStartTime = Bun.nanoseconds();
+            await assertRuntimeReady(this.context);
+            Logger.info(`启动 运行时依赖检查完成，耗时 ${calcPerfTime(runtimeReadyStartTime)}`);
+
+            if (isPrimaryProcess()) {
+                const syncApiStartTime = Bun.nanoseconds();
+                await syncApi(this.context, this.apis);
+                Logger.info(`启动 API 同步完成，耗时 ${calcPerfTime(syncApiStartTime)}`);
+
+                const syncMenuStartTime = Bun.nanoseconds();
+                await syncMenu(this.context, this.menus);
+                Logger.info(`启动 菜单同步完成，耗时 ${calcPerfTime(syncMenuStartTime)}`);
+
+                const syncDevStartTime = Bun.nanoseconds();
+                await syncDev(this.context);
+                Logger.info(`启动 开发者数据同步完成，耗时 ${calcPerfTime(syncDevStartTime)}`);
+
+                const syncCacheStartTime = Bun.nanoseconds();
+                await syncCache(this.context);
+                Logger.info(`启动 缓存同步完成，耗时 ${calcPerfTime(syncCacheStartTime)}`);
+
+                const syncReadyStartTime = Bun.nanoseconds();
+                await this.context.redis.setString(SYNC_READY_KEY, String(Date.now()), 300);
+                Logger.info(`启动 Redis 就绪标记完成，耗时 ${calcPerfTime(syncReadyStartTime)}`);
+            } else {
+                const syncWaitStartTime = Bun.nanoseconds();
+                const startAt = Date.now();
+                await waitFor({
+                    label: "主进程同步完成",
+                    check: async () => Number(await this.context.redis.getString(SYNC_READY_KEY)) > startAt
+                });
+                Logger.info(`启动 等待主进程同步完成，耗时 ${calcPerfTime(syncWaitStartTime)}`);
+            }
+
+            const routeStartTime = Bun.nanoseconds();
+            this.context.cron = createCron(this.context);
+            registerCorns(this.context, this.corns);
+            this.hooks = this.hooks.toSorted((a, b) => a.order - b.order);
+            const apiMap = Object.fromEntries(this.apis.map((api) => [api.apiPath, api]));
+
+            const apiFetch = apiHandler(apiMap, this.hooks, this.context);
+            const rootFetch = rootHandler(this.context.config);
+            const staticFetch = staticHandler(this.context.config.cors, this.context.config.upload);
+            Logger.info(`启动 路由构建完成，耗时 ${calcPerfTime(routeStartTime)}`);
+
+            const listenStartTime = Bun.nanoseconds();
+            this.server = Bun.serve({
+                port: this.context.config.appPort,
+                hostname: this.context.config.appHost,
+                development: this.context.config.runMode === "development",
+                maxRequestBodySize: Math.max(this.context.config.bodyLimit, this.context.config.upload.maxSize * 1024 * 1024),
+                fetch: async (req, server) => {
+                    const pathname = new URL(req.url).pathname;
+                    if (pathname.startsWith("/api/")) return apiFetch(req, server);
+                    if (pathname.startsWith("/public/")) return staticFetch(req);
+                    if (pathname === "/") return rootFetch();
+                    return Response.json({ code: 1, msg: "路径不存在" }, { status: 404 });
+                },
+                error: (error) => {
+                    Logger.error("服务运行错误", error);
+                    return Response.json(
+                        {
+                            code: 1,
+                            msg: "内部服务器错误",
+                            ...(this.context.config.runMode === "development" ? { error: error.message, stack: error.stack } : {})
+                        },
+                        { status: 500 }
+                    );
+                }
+            });
+
+            this.started = true;
+            Logger.info(`启动 Bun.serve 监听完成，耗时 ${calcPerfTime(listenStartTime)}`);
+            Logger.info(`启动总耗时 ${calcPerfTime(serverStartTime)}`);
+            Logger.info(`${this.context.config.appName} 启动成功`, { url: this.server.url, startupTime: calcPerfTime(serverStartTime) });
+            return this.server;
+        } catch (error) {
+            Logger.error("项目启动失败", error);
+            await this.stop();
+            throw createError("运行时错误", { cause: error, code: error?.code || "runtime", subsystem: "start", operation: "start" });
+        }
+    }
+
+    async stop() {
+        this.server?.stop();
+        this.server = null;
+        this.context.cron?.stopAll();
+
+        for (const item of this.plugins.toSorted((a, b) => b.order - a.order)) {
+            const resource = this.context[item.fileName];
+            if (resource?.close) await resource.close();
+            else if (resource?.stop) await resource.stop();
+        }
+
+        this.started = false;
+        await Logger.flush();
+    }
+}

package/README.md

@@ -1,18 +1,57 @@
-# Befly - 野蜂飞舞
+# Befly Core
 
-![野蜂飞舞](https://static.yicode.tech/befly.svg)
+Befly Core 是面向 Bun 的 API 框架内核，负责项目启动、源码扫描、结构检查、插件与 Hook 生命周期、API 路由、参数解析验证、权限、缓存、静态文件和内置管理能力。
 
-> 道生一，一生二，二生三，三生万物
+## 使用
 
 ```js
-"bundle": "bun build ./index.js --outfile ./befly.js --target bun --format esm --packages bundle",
-"bundle:min": "bun build ./index.js --outfile ./befly.min.js --target bun --format esm --packages bundle --minify",
-"build": "rimraf befly.js befly.min.js && bun run bundle && bun run bundle:min"
+import { createBefly } from "befly";
+
+const app = await createBefly(config, menus);
+await app.start();
+
+// 关闭 HTTP、Cron、MySQL、Redis 等运行时资源
+await app.stop();
+```
+
+接口 Handler 可直接使用上下文能力：
+
+```js
+export default {
+    name: "示例接口",
+    method: "POST",
+    body: "none",
+    auth: false,
+    fields: {},
+    required: [],
+    handler: async (befly) => {
+        return befly.tool.Yes("操作成功", {
+            appName: befly.config.appName
+        });
+    }
+};
 ```
 
-我们把要求和实现对齐一下，要符合如下规范：
+## 主要目录
+
+```text
+apis/       内置 API
+checks/     启动期结构检查
+configs/    默认配置与固定常量
+hooks/      请求生命周期 Hook
+lib/        内核运行时实现
+plugins/    有状态服务插件
+router/     API 与静态文件路由
+schemas/    启动检查 Schema
+tables/     内置 Table 定义
+utils/      Core 基础工具
+tests/      单元与运行时测试
+```
 
-1. 单表查询，不传fields或fields为空数组，表示查询所有字段。
-2. 单表查询，fields指定查询字段，表示明确只查询这些字段。
-3. 单表查询，fields用!感叹号开头，表示排除不查询这些字段。
-4. 单表查询，不存在明确查询字段又排除某些字段的混合情况。
+## 质量验证
+
+```bash
+bun run format -- opensource/core
+bun run lint -- opensource/core
+bun run test -- opensource/core
+```

package/apis/admin/delete.js

@@ -1,12 +1,10 @@
-import adminTable from "#befly/tables/admin.json";
-
 export default {
     name: "删除管理员",
     method: "POST",
     body: "none",
     auth: true,
     fields: {
-        id: adminTable.id
+        id: { name: "ID", paramType: "integer", minValue: 1 }
     },
     required: ["id"],
     handler: async (befly, ctx) => {

package/apis/admin/select.js

@@ -1,15 +1,10 @@
-import { queryFields } from "#befly/apis/_apis.js";
-import adminTable from "#befly/tables/admin.json";
-
 export default {
     name: "查询管理员列表",
+    category: "select",
     method: "POST",
     body: "none",
     auth: true,
-    fields: {
-        ...queryFields,
-        state: adminTable.state
-    },
+    fields: {},
     required: [],
     handler: async (befly, ctx) => {
         const result = await befly.mysql.getList({

package/apis/admin/update.js

@@ -7,14 +7,12 @@ export default {
     body: "none",
     auth: true,
     fields: {
-        id: { name: "ID", input: "integer", min: 1, max: null },
+        id: { name: "ID", paramType: "integer", minValue: 1 },
         username: adminTable.username,
         nickname: adminTable.nickname,
         roleCode: adminTable.roleCode,
         avatar: adminTable.avatar,
         email: adminTable.email,
-        lastLoginIp: adminTable.lastLoginIp,
-        lastLoginTime: adminTable.lastLoginTime,
         password: adminTable.password,
         phone: adminTable.phone
     },
@@ -72,8 +70,6 @@ export default {
 
         if (ctx.body.avatar !== undefined) updateData.avatar = ctx.body.avatar;
         if (ctx.body.email !== undefined) updateData.email = ctx.body.email;
-        if (ctx.body.lastLoginIp !== undefined) updateData.lastLoginIp = ctx.body.lastLoginIp;
-        if (ctx.body.lastLoginTime !== undefined) updateData.lastLoginTime = ctx.body.lastLoginTime;
         if (ctx.body.password !== undefined) {
             updateData.password = await hashPassword(ctx.body.password);
         }

package/apis/api/select.js

@@ -1,15 +1,10 @@
-import { queryFields } from "#befly/apis/_apis.js";
-import apiTable from "#befly/tables/api.json";
-
 export default {
     name: "获取接口列表",
+    category: "select",
     method: "POST",
     body: "none",
     auth: true,
-    fields: {
-        ...queryFields,
-        state: apiTable.state
-    },
+    fields: {},
     required: [],
     handler: async (befly, ctx) => {
         const result = await befly.mysql.getList({

package/apis/auth/login.js

@@ -11,17 +11,15 @@ export default {
     fields: {
         account: {
             name: "账号",
-            input: "string",
-            min: 1,
-            max: 100
+            paramType: "string",
+            minValue: 1,
+            maxValue: 100
         },
         password: adminTable.password,
         loginType: {
             name: "登录类型",
-            input: "enum",
-            check: "username|email|phone",
-            min: null,
-            max: null
+            paramType: "string",
+            enum: ["username", "email", "phone"]
         },
         clientType: loginLogTable.clientType,
         productName: loginLogTable.productName,
@@ -35,22 +33,20 @@ export default {
     },
     required: ["account", "password", "loginType"],
     handler: async (befly, ctx) => {
-        const body = ctx.body || {};
-
         const logData = {
             adminId: 0,
             username: ctx.body.account,
             nickname: "",
-            ip: ctx.ip || "",
-            clientType: body.clientType || "",
-            productName: body.productName || "",
-            productCode: body.productCode || "",
-            productVersion: body.productVersion || "",
-            clientVersion: body.clientVersion || "",
-            os: body.os || "",
-            system: body.system || "",
-            brand: body.brand || "",
-            model: body.model || "",
+            ip: ctx.ip,
+            clientType: ctx.body.clientType,
+            productName: ctx.body.productName,
+            productCode: ctx.body.productCode,
+            productVersion: ctx.body.productVersion,
+            clientVersion: ctx.body.clientVersion,
+            os: ctx.body.os,
+            system: ctx.body.system,
+            brand: ctx.body.brand,
+            model: ctx.body.model,
             loginTime: Date.now(),
             loginResult: 0,
             failReason: ""
@@ -95,7 +91,7 @@ export default {
         logData.loginResult = 1;
         await befly.mysql.insData({ table: "beflyLoginLog", data: logData });
 
-        const ttlSeconds = toSessionTtlSeconds(befly.config?.session?.expireDays);
+        const ttlSeconds = toSessionTtlSeconds(befly.config.session.expireDays);
         const sid = Bun.randomUUIDv7();
         const sessionKey = `session:${sid}`;
 

package/apis/dict/delete.js

@@ -4,7 +4,7 @@ export default {
     body: "none",
     auth: true,
     fields: {
-        id: { name: "ID", input: "integer", min: 1, max: null }
+        id: { name: "ID", paramType: "integer", minValue: 1 }
     },
     required: ["id"],
     handler: async (befly, ctx) => {

package/apis/dict/detail.js

@@ -1,5 +1,3 @@
-import dictTable from "#befly/tables/dict.json";
-
 import { dictReadFields, dictReadLeftJoin, dictReadTable } from "./_dict.js";
 
 export default {
@@ -8,7 +6,7 @@ export default {
     body: "none",
     auth: false,
     fields: {
-        id: dictTable.id
+        id: { name: "ID", paramType: "integer", minValue: 1 }
     },
     required: ["id"],
     handler: async (befly, ctx) => {

package/apis/dict/select.js

@@ -1,15 +1,14 @@
-import { queryFields } from "#befly/apis/_apis.js";
 import dictTable from "#befly/tables/dict.json";
 
 import { dictReadFields, dictReadLeftJoin, dictReadOrderBy, dictReadTable } from "./_dict.js";
 
 export default {
     name: "获取字典列表",
+    category: "select",
     method: "POST",
     body: "none",
     auth: false,
     fields: {
-        ...queryFields,
         typeCode: dictTable.typeCode
     },
     required: [],

package/apis/dict/update.js

@@ -8,7 +8,7 @@ export default {
     body: "none",
     auth: true,
     fields: {
-        id: dictTable.id,
+        id: { name: "ID", paramType: "integer", minValue: 1 },
         typeCode: dictTable.typeCode,
         key: dictTable.key,
         label: dictTable.label,

package/apis/dictType/delete.js

@@ -4,7 +4,7 @@ export default {
     body: "none",
     auth: true,
     fields: {
-        id: { name: "ID", input: "integer", min: 1, max: null }
+        id: { name: "ID", paramType: "integer", minValue: 1 }
     },
     required: ["id"],
     handler: async (befly, ctx) => {

package/apis/dictType/detail.js

@@ -3,7 +3,7 @@ export default {
     method: "POST",
     body: "none",
     auth: true,
-    fields: { id: { name: "ID", input: "integer", min: 1, max: null } },
+    fields: { id: { name: "ID", paramType: "integer", minValue: 1 } },
     required: ["id"],
     handler: async (befly, ctx) => {
         const detail = await befly.mysql.getOne({

package/apis/dictType/insert.js

@@ -10,7 +10,7 @@ export default {
         name: dictTypeTable.name,
         description: dictTypeTable.description,
         sort: dictTypeTable.sort,
-        state: dictTypeTable.state
+        state: { name: "状态", paramType: "integer" }
     },
     required: ["code", "name"],
     handler: async (befly, ctx) => {

package/apis/dictType/select.js

@@ -1,15 +1,10 @@
-import { queryFields } from "#befly/apis/_apis.js";
-import dictTypeTable from "#befly/tables/dictType.json";
-
 export default {
     name: "获取字典类型列表",
+    category: "select",
     method: "POST",
     body: "none",
     auth: true,
-    fields: {
-        ...queryFields,
-        state: dictTypeTable.state
-    },
+    fields: {},
     required: [],
     handler: async (befly, ctx) => {
         const result = await befly.mysql.getList({

package/apis/dictType/update.js

@@ -6,12 +6,12 @@ export default {
     body: "none",
     auth: true,
     fields: {
-        id: { name: "ID", input: "integer", min: 1, max: null },
+        id: { name: "ID", paramType: "integer", minValue: 1 },
         code: dictTypeTable.code,
         name: dictTypeTable.name,
         description: dictTypeTable.description,
         sort: dictTypeTable.sort,
-        state: dictTypeTable.state
+        state: { name: "状态", paramType: "integer" }
     },
     required: ["id"],
     handler: async (befly, ctx) => {

package/apis/email/config.js

@@ -1,5 +1,3 @@
-import { hasEmailConfig } from "#befly/utils/email.js";
-
 export default {
     name: "获取邮件配置",
     method: "POST",
@@ -8,16 +6,15 @@ export default {
     fields: {},
     required: [],
     handler: async (befly) => {
-        const config = befly?.config?.email || {};
+        const config = befly.config.email;
 
         return befly.tool.Yes("获取成功", {
             host: config.host || "",
             port: config.port || 0,
             secure: config.secure,
-            user: config.user || "",
-            pass: config.pass || "",
-            label: config.label || "",
-            configured: hasEmailConfig(config)
+            user: config.user,
+            label: config.label,
+            configured: !(!config.host || !config.user || !config.pass)
         });
     }
 };

package/apis/email/logList.js

@@ -1,15 +1,10 @@
-import { queryFields } from "#befly/apis/_apis.js";
-import emailLogTable from "#befly/tables/emailLog.json";
-
 export default {
     name: "邮件发送日志列表",
+    category: "select",
     method: "POST",
     body: "none",
     auth: true,
-    fields: {
-        ...queryFields,
-        state: emailLogTable.state
-    },
+    fields: {},
     required: [],
     handler: async (befly, ctx) => {
         const result = await befly.mysql.getList({

package/apis/email/send.js

@@ -1,5 +1,4 @@
 import emailLogTable from "#befly/tables/emailLog.json";
-import { hasEmailConfig } from "#befly/utils/email.js";
 
 export default {
     name: "发送邮件",
@@ -17,7 +16,7 @@ export default {
     handler: async (befly, ctx) => {
         const emailConfig = befly.config.email || {};
 
-        if (!hasEmailConfig(emailConfig)) {
+        if (!emailConfig.host || !emailConfig.user || !emailConfig.pass) {
             return befly.tool.No("邮件未配置，请检查 SMTP 配置");
         }
 

package/apis/email/verify.js

@@ -1,5 +1,3 @@
-import { hasEmailConfig } from "#befly/utils/email.js";
-
 export default {
     name: "验证邮件配置",
     method: "POST",
@@ -10,7 +8,7 @@ export default {
     handler: async (befly) => {
         const emailConfig = befly?.config?.email || {};
 
-        if (!hasEmailConfig(emailConfig)) {
+        if (!emailConfig.host || !emailConfig.user || !emailConfig.pass) {
             return befly.tool.No("邮件未配置，请检查 SMTP 配置");
         }
 

package/apis/loginLog/select.js

@@ -1,15 +1,10 @@
-import { queryFields } from "#befly/apis/_apis.js";
-import loginLogTable from "#befly/tables/loginLog.json";
-
 export default {
     name: "获取登录日志列表",
+    category: "select",
     method: "POST",
     body: "none",
     auth: true,
-    fields: {
-        ...queryFields,
-        state: loginLogTable.state
-    },
+    fields: {},
     required: [],
     handler: async (befly, ctx) => {
         const result = await befly.mysql.getList({

package/apis/menu/select.js

@@ -1,15 +1,10 @@
-import { queryFields } from "#befly/apis/_apis.js";
-import menuTable from "#befly/tables/menu.json";
-
 export default {
     name: "获取菜单列表",
+    category: "select",
     method: "POST",
     body: "none",
     auth: true,
-    fields: {
-        ...queryFields,
-        state: menuTable.state
-    },
+    fields: {},
     required: [],
     handler: async (befly, ctx) => {
         const menus = await befly.mysql.getList({

package/apis/operateLog/select.js

@@ -1,15 +1,10 @@
-import { queryFields } from "#befly/apis/_apis.js";
-import operateLogTable from "#befly/tables/operateLog.json";
-
 export default {
     name: "获取操作日志列表",
+    category: "select",
     method: "POST",
     body: "none",
     auth: true,
-    fields: {
-        ...queryFields,
-        state: operateLogTable.state
-    },
+    fields: {},
     required: [],
     handler: async (befly, ctx) => {
         const result = await befly.mysql.getList({

package/apis/role/apiSave.js

@@ -11,9 +11,9 @@ export default {
         roleCode: roleTable.code,
         apiPaths: roleTable.apis
     },
-    required: ["roleCode"],
+    required: ["roleCode", "apiPaths"],
     handler: async (befly, ctx) => {
-        const apiPaths = ctx.body.apiPaths || [];
+        const apiPaths = ctx.body.apiPaths;
 
         const role = await getRoleByCode(befly, ctx.body.roleCode);
 

package/apis/role/menuSave.js

@@ -11,9 +11,9 @@ export default {
         roleCode: roleTable.code,
         menuPaths: roleTable.menus
     },
-    required: ["roleCode"],
+    required: ["roleCode", "menuPaths"],
     handler: async (befly, ctx) => {
-        const menuPaths = ctx.body.menuPaths || [];
+        const menuPaths = ctx.body.menuPaths;
 
         const role = await getRoleByCode(befly, ctx.body.roleCode);