main.go 7.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211
  1. // 命令 api:统一 Go 后端单二进制入口(ADR-011 模块化单体,ADR-015 单机双实例)。
  2. //
  3. // 职责(架构规格 §2.1 HTTP 接入层 + §7.3 部署形态):
  4. // 1. 解析 -env(dev/prod)加载配置(internal/infra/config,12-factor:
  5. // config/{env}.json + CONFIG_* 环境变量覆盖;敏感字段必须走环境变量);
  6. // 2. 幂等创建运行目录(log/{instanceId}/、tmp/{instanceId}/,双实例同机隔离);
  7. // 3. 装配 zap 结构化日志(trace_id 贯穿,§3.3);
  8. // 4. 装配 Fiber app + 中间件链(Recover→RequestID→...,§2.2);
  9. // 5. 注册 /healthz 存活探针(ADR-015:nginx upstream 健康检查 + systemd Watchdog);
  10. // 6. 各业务域路由挂载(org/academic/teaching/ai 域就绪后在此注册,
  11. // 公开路由须在 Auth Group 之前——铁律 8 路由纪律);
  12. // 7. 任务工作池启动与优雅退出(task 域,GracePeriodSec 内排空在途任务,§3.7)。
  13. //
  14. // 当前状态:域模块尚未实现(internal/{org,academic,teaching,ai} 为空),
  15. // 本入口提供"配置加载 + 健康检查 + 优雅退出"骨架,保证 go build ./... 全绿、
  16. // 部署链路(systemd/nginx/Dockerfile)可先演练。
  17. //
  18. // 启动方式(dev):
  19. //
  20. // cp config/dev.example.json config/dev.json # 填入 DSN 等(或走环境变量)
  21. // go run ./cmd/api -env=dev
  22. package main
  23. import (
  24. "crypto/rand"
  25. "encoding/hex"
  26. "flag"
  27. "fmt"
  28. "os"
  29. "os/signal"
  30. "syscall"
  31. "time"
  32. "github.com/gofiber/fiber/v2"
  33. "github.com/gofiber/fiber/v2/middleware/requestid"
  34. "go.uber.org/zap"
  35. "go.uber.org/zap/zapcore"
  36. "yuansiwei/unified-backend/internal/infra/config"
  37. )
  38. // main 进程入口:装配 → 监听 → 信号驱动优雅退出。
  39. //
  40. // 入参(命令行 flag):
  41. // - env string:环境名("dev"/"prod"),决定加载 config/{env}.json;默认 "dev"。
  42. //
  43. // 出参:进程退出码(0 正常;1 装配/运行失败)。
  44. //
  45. // 异常场景:
  46. // - 配置缺失/必填字段未填:fail-fast 退出(config.Load 返回错误,输出到 stderr 后 exit 1);
  47. // - SIGTERM/SIGINT:在 GracePeriodSec 内排空存量请求后退出(ADR-015 滚动重启语义)。
  48. func main() {
  49. env := flag.String("env", "dev", "运行环境(dev/prod),决定读取 config/{env}.json")
  50. flag.Parse()
  51. cfg, err := config.Load(*env)
  52. if err != nil {
  53. fmt.Fprintf(os.Stderr, "fatal: 配置加载失败: %v\n(提示:可复制 config/%s.example.json 为 config/%s.json 并填敏感字段)\n",
  54. err, *env, *env)
  55. os.Exit(1)
  56. }
  57. if err := config.EnsureRuntimeDirs(cfg.Server.InstanceID); err != nil {
  58. fmt.Fprintf(os.Stderr, "fatal: %v\n", err)
  59. os.Exit(1)
  60. }
  61. logger, err := newLogger(cfg.Log.Level)
  62. if err != nil {
  63. fmt.Fprintf(os.Stderr, "fatal: 初始化日志失败: %v\n", err)
  64. os.Exit(1)
  65. }
  66. defer func() { _ = logger.Sync() }()
  67. logger.Info("统一 Go 后端启动",
  68. zap.String("env", *env),
  69. zap.String("instance", cfg.Server.InstanceID),
  70. zap.String("addr", cfg.Server.Addr))
  71. app := fiber.New(fiber.Config{
  72. AppName: "yuansiwei-unified-backend",
  73. ReadTimeout: time.Duration(cfg.Server.ReadTimeoutSec) * time.Second,
  74. DisableStartupMessage: true,
  75. // 请求体上限 10MB:费用凭证/作业图片走 OSS 直传,接口侧只收元数据
  76. BodyLimit: 10 << 20,
  77. })
  78. // 中间件链(§2.2 顺序铁律:Recover 最前兜底 panic → RequestID 生成/透传 trace_id)
  79. app.Use(recoverMiddleware(logger))
  80. app.Use(requestid.New(requestid.Config{Generator: newTraceID}))
  81. // 存活探针(ADR-015:nginx upstream healthcheck + K8s 预留 liveness)
  82. app.Get("/healthz", func(c *fiber.Ctx) error {
  83. return c.JSON(fiber.Map{
  84. "status": "ok",
  85. "instance": cfg.Server.InstanceID,
  86. "time": time.Now().Format(time.RFC3339),
  87. })
  88. })
  89. // 业务域路由挂载点(域模块实现后在此注册;公开路由须在 Auth Group 之前——铁律 8):
  90. //
  91. // app.Get("/auth/jwks", identityHandler.JWKS) // 公开
  92. // auth := app.Group("/", middleware.Auth(logger)) // 以下全部需登录
  93. // auth.Get("/auth/me", identityHandler.Me)
  94. // auth.Get("/admin/courses/:id", academicHandler.Get) // PC 端
  95. // auth.Get("/student/homeworks", teachingHandler.List) // 移动端
  96. // 优雅退出(SIGTERM/SIGINT;GracePeriodSec 内排空存量请求,§7.3)
  97. grace := time.Duration(cfg.Server.GracePeriodSec) * time.Second
  98. if grace <= 0 {
  99. grace = 30 * time.Second
  100. }
  101. done := make(chan struct{})
  102. go func() {
  103. sig := make(chan os.Signal, 1)
  104. signal.Notify(sig, syscall.SIGINT, syscall.SIGTERM)
  105. s := <-sig
  106. logger.Info("收到退出信号,开始优雅停机", zap.String("signal", s.String()), zap.Duration("grace", grace))
  107. close(done)
  108. }()
  109. errCh := make(chan error, 1)
  110. go func() { errCh <- app.Listen(cfg.Server.Addr) }()
  111. select {
  112. case err := <-errCh:
  113. if err != nil {
  114. logger.Error("HTTP 服务异常退出", zap.Error(err))
  115. os.Exit(1)
  116. }
  117. case <-done:
  118. if err := app.ShutdownWithTimeout(grace); err != nil {
  119. logger.Warn("优雅退出超时,强制关闭", zap.Error(err))
  120. } else {
  121. logger.Info("服务已优雅退出")
  122. }
  123. }
  124. }
  125. // recoverMiddleware 全局 panic 兜底(§3.2 规则 4):未捕获 panic 统一降级为
  126. // body code=5001(HTTP 仍 200,铁律 6)+ 结构化日志(带堆栈 + trace_id),
  127. // **绝不**把 panic 信息/堆栈透传给前端。
  128. //
  129. // 入参:
  130. // - logger *zap.Logger:进程级结构化日志器。
  131. //
  132. // 出参:
  133. // - fiber.Handler:Fiber 中间件(返回后继续 c.Next() 链)。
  134. //
  135. // 说明:骨架期直接写 5001 信封(不引入 infra/response 依赖,避免 main 包耦合具体域);
  136. // 域模块就绪后切换为 response.Fail 统一出口。
  137. func recoverMiddleware(logger *zap.Logger) fiber.Handler {
  138. return func(c *fiber.Ctx) (err error) {
  139. defer func() {
  140. if p := recover(); p != nil {
  141. logger.Error("panic 已兜底",
  142. zap.String("trace_id", c.Get("X-Request-ID")),
  143. zap.String("path", c.Path()),
  144. zap.Any("panic", p))
  145. err = c.Status(fiber.StatusOK).JSON(fiber.Map{
  146. "code": 5001,
  147. "message": "系统繁忙",
  148. "success": false,
  149. })
  150. }
  151. }()
  152. return c.Next()
  153. }
  154. }
  155. // newTraceID 生成请求 trace_id(§3.3:nginx 透传 X-Request-ID 时 requestid 中间件不再生成,
  156. // 缺失时以 crypto/rand 32 字节 hex 兜底;跨 Python Agent 调用时透传同一值)。
  157. //
  158. // 入参:无。
  159. // 出参:
  160. // - string:64 字符 hex;crypto/rand 故障(概率≈0)时以时间戳兜底,不阻断请求。
  161. func newTraceID() string {
  162. b := make([]byte, 32)
  163. if _, err := rand.Read(b); err != nil {
  164. return fmt.Sprintf("%064x", uint64(time.Now().UnixNano()))
  165. }
  166. return hex.EncodeToString(b)
  167. }
  168. // newLogger 按级别构造 zap 生产级 logger(JSON 编码,ts 用 RFC3339——访问日志与 trace 对齐,§3.3)。
  169. //
  170. // 入参:
  171. // - level string:"debug"/"info"/"warn"/"error"(大小写不敏感;空/非法值按 info 处理)。
  172. //
  173. // 出参:
  174. // - *zap.Logger:就绪日志器(NewDevelopment 风格控制台可读 + 生产字段结构)。
  175. // - error:仅当 zap 构造失败时非 nil。
  176. func newLogger(level string) (*zap.Logger, error) {
  177. var l zapcore.Level
  178. switch level {
  179. case "debug":
  180. l = zapcore.DebugLevel
  181. case "warn":
  182. l = zapcore.WarnLevel
  183. case "error":
  184. l = zapcore.ErrorLevel
  185. case "info", "":
  186. l = zapcore.InfoLevel
  187. default:
  188. l = zapcore.InfoLevel // 非法级别不阻断启动,按 info 兜底(配置错误由部署期自检发现)
  189. }
  190. cfg := zap.NewProductionConfig()
  191. cfg.Level = zap.NewAtomicLevelAt(l)
  192. cfg.EncoderConfig.TimeKey = "ts"
  193. cfg.EncoderConfig.EncodeTime = zapcore.RFC3339TimeEncoder
  194. return cfg.Build()
  195. }