Documentation
¶
Overview ¶
Package app 提供应用引导层: 把配置加载、日志初始化、资源初始化、路由注册、 HTTP 服务启动与优雅停机收敛为一个入口, 业务 main 只保留配置结构体与少量钩子。
配置以约定方式加载: 默认扫描 ./ 下 config 前缀的 yaml 文件(如 config-database.yaml), 配置结构体内嵌 app.Base 获得 server / log 两个约定配置节, 其余业务节自行声明。 Run 按固定顺序完成启动并阻塞至优雅停机:
扫描加载配置 -> 日志初始化 -> Init 钩子 -> 路由注册 -> HTTP 服务阻塞运行 -> (收到退出信号, HTTP 优雅停机) -> Close 钩子 -> 日志刷盘 -> 停止热更新监听
关停顺序先停 HTTP 再释放资源, 保证处理中的请求不会访问到已关闭的连接。
与 lifecycle 的分工: HTTP 服务自身的信号处理与优雅停机已内聚在 ginx.Run 中, web 应用经 Run 启动时无需再套 lifecycle(两套信号监听会相互竞争); lifecycle 适用于非 HTTP 长驻组件(后台消费协程、定时任务等), 在 Init 钩子中启动、Close 钩子中停止, 即可与主流程共用同一关停时序。
使用示例:
type Conf struct {
app.Base // server / log 配置节
Database mysql.MySQL `yaml:"database"`
}
func main() {
app.MustRun(&app.Boot[Conf]{
Watch: true,
Init: func(c *Conf) error { return c.Database.Connect() },
Close: func() { database.Close() },
})
}
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Base ¶
type Base struct {
Server ginx.Gin `yaml:"server" toml:"server" json:"server" mapstructure:"server"` // HTTP 服务配置
Log logger.LogConfig `yaml:"log" toml:"log" json:"log" mapstructure:"log"` // 日志配置
}
Base 应用配置约定段的默认实现, 业务配置结构体内嵌后获得 server / log 两个配置节。
type Boot ¶
type Boot[C any] struct { // ---- 配置加载约定 ---- Suffix string // 配置文件后缀, 默认 yaml Dir string // 扫描目录, 默认 ./ FilePrefix string // 配置文件名前缀, 默认 config(如 config-database.yaml) EnvPrefix string // 环境变量前缀, 为空时不启用环境变量覆盖 Watch bool // 是否开启配置热更新; 开启后文件改动自动回填并触发 OnChange // ---- 业务钩子(按执行顺序) ---- // Init 资源初始化, 在日志就绪后、路由注册与服务启动前执行, 返回错误会中断启动。 Init func(cfg *C) error // Close 资源释放, 在 HTTP 服务优雅停机后执行, 数据库/缓存等连接在此关闭。 Close func() // OnChange 配置热更新回调: 新配置回填 cfg 后调用(需 Watch 开启)。 // 回调在监听协程中执行, panic 不会杀死进程; 与其他 goroutine 读写配置的同步由业务负责。 OnChange func(cfg *C) // Routes 待注册的路由模块, 在 Init 之后统一注册; 也可在 Run 之前用 ginx.NewGroup 直接注册 Routes []ginx.Router }
Boot 应用引导配置: 以约定方式加载配置并组织启动流程, 未设置的字段自动使用默认值。
Click to show internal directories.
Click to hide internal directories.