跳到主要内容

VEF Framework Go

资源驱动的 Go API 框架,端到端就绪。

围绕显式资源、类型化处理器和源码可见的默认行为来构建 Go 服务,而不是依赖隐藏在脚手架后的黑盒约定。

RPC 入口/api
默认版本v1
默认超时30s
默认限流100 / 5m
main.goGO
  • 资源通过显式注册进入容器,再由 API 引擎统一分发。
  • CRUD builder、结果对象和参数注入会替你去掉重复样板代码。
  • 默认值来自源码本身:版本 `v1`、超时 `30s`、限流 `100 / 5m`。

心智模型

先理解组合方式,再理解路由

顺着运行时的形状来理解 VEF 最容易:组合模块、注册资源,然后交给 API 引擎去分发操作。

  1. 01

    组合模块

    从 `vef.Run(...)` 开始,让 FX 组装配置、数据库、ORM、中间件、安全、存储、MCP 与应用服务。

  2. 02

    注册资源

    通过 `api.NewRPCResource(...)` 或 `api.NewRESTResource(...)` 定义接口,再用 `vef.ProvideAPIResource(...)` 注册。

  3. 03

    保持处理器精简

    把 `fiber.Ctx`、`orm.DB`、Principal、Logger、Params、Meta、Storage、Event、Cron 直接注入处理器,而不是手写胶水层。

核心能力

最值得优先掌握的框架表面

这些能力会最早出现在真实项目里,而且都能直接在当前源码树中找到对应实现。

  • API

    统一资源模型

    RPC 和 REST 都是一级资源类型;每个操作都显式携带认证、超时、限流、审计和版本控制。

  • CRUD

    泛型 CRUD Builder

    创建、更新、删除、分页、树查询、导入导出、批量操作与 Hook 都能通过类型化 builder 组合出来。

  • ORM

    模型驱动数据层

    基于 Bun,提供审计模型、事务辅助、搜索标签、分页能力,以及面向企业场景的默认行为。

  • AUTH

    安全与数据范围

    支持 Bearer、Signature 与公开接口,并能配合 RBAC 权限检查与请求级数据权限解析。

  • SYS

    内置系统资源

    认证、存储、Schema 检查、监控与 MCP 都能以内置资源和中间件的形式直接使用。

  • FX

    模块化运行时

    扩展点按 FX group 显式组织:API 资源、应用中间件、CQRS 行为、参数解析器与 MCP provider。

建议入口

沿最短路径进入有效上下文

这些页面是理解 VEF 应用结构以及核心 API 用法的最快路径。