Documentation
¶
Overview ¶
Package app 是 core、database、server 和 taskkit 的约定式集成层,提供应用运行时。 它统一读取默认配置、初始化数据库和可选 Redis、执行迁移和业务初始化、创建 Task Manager 和 gRPC/Gateway Server,并通过 lifex 管理完整生命周期。
最小入口只需在业务包的 init 中登记声明,然后调用 app.Main:
import (
"github.com/go-sdk/app"
_ "example/internal/model"
_ "example/internal/service"
_ "github.com/go-sdk/database/dbx/postgres"
)
func main() { app.Main() }
数据库驱动必须由具体项目按需空白导入,并与 database.driver 配置保持一致。
安装:
go get github.com/go-sdk/app
这个模块有意保持强耦合和较少配置,适合采用同一套技术栈的新项目。需要单独 替换配置、数据库或 Server 生命周期时,应直接组合底层 SDK,而不是在 app 中 增加兼容层。
Index ¶
- func DB() *dbx.DB
- func Main()
- func Redis() rdx.Client
- func RegisterBootstrap(functions ...BootstrapFunc)
- func RegisterGRPC(functions ...standard.GRPCRegisterFunc)
- func RegisterGateway(functions ...standard.GatewayRegisterFunc)
- func RegisterMigration(up, down func(*dbx.DB) error)
- func RegisterMigrationOptions(options ...migrate.Option)
- func RegisterRoute(method, path string, handler standard.HandlerFunc, ...)
- func RegisterServerOptionFactories(factories ...ServerOptionFactory)
- func RegisterServerOptions(options ...standard.Option)
- func RegisterTask(id string, schedule taskkit.Schedule, task taskkit.Task, ...)
- func RegisterTaskManagerOptionFactories(factories ...TaskManagerOptionFactory)
- func Run() error
- func Server() *standard.Server
- func TaskManager() *taskkit.Manager
- type BootstrapFunc
- type ServerOptionFactory
- type TaskManagerOptionFactory
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Redis ¶ added in v1.1.0
Redis 返回由 Run 初始化的进程级 Redis 客户端。 仅当 redis.enabled 为 true 时可用,且不得在包初始化期间访问。
func RegisterBootstrap ¶
func RegisterBootstrap(functions ...BootstrapFunc)
RegisterBootstrap 登记数据库迁移后的业务初始化函数。
func RegisterGRPC ¶
func RegisterGRPC(functions ...standard.GRPCRegisterFunc)
RegisterGRPC 登记业务 gRPC 服务。
func RegisterGateway ¶
func RegisterGateway(functions ...standard.GatewayRegisterFunc)
RegisterGateway 登记由 google.api.http 生成的 Gateway 路由。
func RegisterMigration ¶
RegisterMigration 从直接调用方的文件名生成迁移 ID 并登记数据库迁移。 文件名必须符合 YYYYMMDD_HHMMSS_NN_description.go,发布后不得重命名。
func RegisterMigrationOptions ¶
RegisterMigrationOptions 登记数据库迁移的全局执行选项。
func RegisterRoute ¶
func RegisterRoute(method, path string, handler standard.HandlerFunc, opts ...standard.RouteOption)
RegisterRoute 登记不适合 Proto JSON 映射的额外 HTTP 接口。
func RegisterServerOptionFactories ¶
func RegisterServerOptionFactories(factories ...ServerOptionFactory)
RegisterServerOptionFactories 登记需要在数据库初始化后构造的 Server Option。
func RegisterServerOptions ¶
RegisterServerOptions 登记不依赖运行时数据库的 Server Option。
func RegisterTask ¶ added in v1.2.0
func RegisterTask(id string, schedule taskkit.Schedule, task taskkit.Task, options ...taskkit.JobOption)
RegisterTask 登记在迁移和业务初始化完成后启动的定时任务。
func RegisterTaskManagerOptionFactories ¶ added in v1.2.0
func RegisterTaskManagerOptionFactories(factories ...TaskManagerOptionFactory)
RegisterTaskManagerOptionFactories 登记依赖运行时资源的 Task Manager Option 工厂。
func Run ¶
func Run() error
Run 按固定顺序初始化数据库、迁移、业务数据、Task Manager 和 Server,并等待应用退出。 每个进程只能调用一次;所有 Register 调用必须先于 Run 完成。
func TaskManager ¶ added in v1.2.0
TaskManager 返回由 Run 按需初始化的进程级任务管理器。
Types ¶
type BootstrapFunc ¶
BootstrapFunc 在数据库迁移完成后、Server 启动前执行一次业务初始化。
type ServerOptionFactory ¶
ServerOptionFactory 在数据库初始化后创建 Server Option。 需要访问 DB 的鉴权拦截器等组件应通过该工厂注册。
type TaskManagerOptionFactory ¶ added in v1.2.0
type TaskManagerOptionFactory func() (taskkit.ManagerOption, error)
TaskManagerOptionFactory 在 Redis 等运行时资源初始化后创建 Task Manager Option。