main.go 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379
  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. // 当前状态:identity 模块(两步登录 / me / refresh / logout)已装配(T4-6),
  15. // 含 DB 连接 + 核心表 AutoMigrate(guarded:仅 UNIFIED_AUTO_MIGRATE=1 时执行,生产幂等不漂移)、
  16. // Redis 连接 + token 存储 + RS256 签发器 + 仓储 + AuthService + Handler + 验签中间件 + /auth/* 路由。
  17. // 其余域(org/academic/teaching/ai)尚未实现,域模块就绪后在"业务域路由挂载点"注册。
  18. //
  19. // 启动方式(dev):
  20. //
  21. // cp config/dev.example.json config/dev.json # 填入 DSN/Redis/私钥(或走环境变量)
  22. // export UNIFIED_AUTO_MIGRATE=1 # 首次:建核心表(生产默认关,防 schema 漂移)
  23. // go run ./cmd/api -env=dev
  24. package main
  25. import (
  26. "crypto/rand"
  27. "encoding/hex"
  28. "flag"
  29. "fmt"
  30. "os"
  31. "os/signal"
  32. "syscall"
  33. "time"
  34. "github.com/gofiber/fiber/v2"
  35. "github.com/gofiber/fiber/v2/middleware/requestid"
  36. "go.uber.org/zap"
  37. "go.uber.org/zap/zapcore"
  38. "yuansiwei/unified-backend/internal/identity/handler"
  39. "yuansiwei/unified-backend/internal/identity/model"
  40. "yuansiwei/unified-backend/internal/identity/repository"
  41. "yuansiwei/unified-backend/internal/identity/service"
  42. "yuansiwei/unified-backend/internal/identity/token"
  43. "yuansiwei/unified-backend/internal/infra/config"
  44. "yuansiwei/unified-backend/internal/infra/db"
  45. "yuansiwei/unified-backend/internal/infra/redis"
  46. orghandler "yuansiwei/unified-backend/internal/org/handler"
  47. orgmodel "yuansiwei/unified-backend/internal/org/model"
  48. "yuansiwei/unified-backend/internal/org/rbac"
  49. orgrepo "yuansiwei/unified-backend/internal/org/repository"
  50. orgservice "yuansiwei/unified-backend/internal/org/service"
  51. )
  52. // 编译期断言:*rbac.Resolver 须满足 identity 的 MenuProvider 接口(签名漂移即编译失败,
  53. // 杜绝"装配注入了但方法签名不匹配"的隐蔽错误——生产注入点见 main() 内 service.Config.MenuProvider)。
  54. var _ service.MenuProvider = (*rbac.Resolver)(nil)
  55. // main 进程入口:装配 → 监听 → 信号驱动优雅退出。
  56. //
  57. // 入参(命令行 flag):
  58. // - env string:环境名("dev"/"prod"),决定加载 config/{env}.json;默认 "dev"。
  59. //
  60. // 出参:进程退出码(0 正常;1 装配/运行失败)。
  61. //
  62. // 异常场景:
  63. // - 配置缺失/必填字段未填:fail-fast 退出(config.Load 返回错误,输出到 stderr 后 exit 1);
  64. // - SIGTERM/SIGINT:在 GracePeriodSec 内排空存量请求后退出(ADR-015 滚动重启语义)。
  65. func main() {
  66. env := flag.String("env", "dev", "运行环境(dev/prod),决定读取 config/{env}.json")
  67. flag.Parse()
  68. cfg, err := config.Load(*env)
  69. if err != nil {
  70. fmt.Fprintf(os.Stderr, "fatal: 配置加载失败: %v\n(提示:可复制 config/%s.example.json 为 config/%s.json 并填敏感字段)\n",
  71. err, *env, *env)
  72. os.Exit(1)
  73. }
  74. if err := config.EnsureRuntimeDirs(cfg.Server.InstanceID); err != nil {
  75. fmt.Fprintf(os.Stderr, "fatal: %v\n", err)
  76. os.Exit(1)
  77. }
  78. logger, err := newLogger(cfg.Log.Level)
  79. if err != nil {
  80. fmt.Fprintf(os.Stderr, "fatal: 初始化日志失败: %v\n", err)
  81. os.Exit(1)
  82. }
  83. defer func() { _ = logger.Sync() }()
  84. logger.Info("统一 Go 后端启动",
  85. zap.String("env", *env),
  86. zap.String("instance", cfg.Server.InstanceID),
  87. zap.String("addr", cfg.Server.Addr))
  88. // ---- 基础设施装配(fail-fast:DB/Redis 连不上不允许启动)----
  89. gdb, err := db.NewDB(cfg.DB)
  90. if err != nil {
  91. logger.Error("数据库连接失败", zap.Error(err))
  92. os.Exit(1)
  93. }
  94. defer func() { _ = db.Close(gdb) }()
  95. // 核心表建表(guarded:UNIFIED_AUTO_MIGRATE=1 才执行)。
  96. // 生产默认关闭——schema 演进走受控迁移(W2 割接脚本 / DDL 变更评审),
  97. // 启动时 AutoMigrate 会按 GORM model 增列,与"目标态 DDL 先行"纪律冲突(ADR-013/D1)。
  98. if os.Getenv("UNIFIED_AUTO_MIGRATE") == "1" {
  99. // identity 域 4 表 + org 域核心表(t_membership/t_institution/t_campus 等)
  100. // ——登录链路引用 membership→institution,缺一即登录查不到作用域
  101. tables := append(model.AllTables(), orgmodel.AllTables()...)
  102. if err := db.Migrate(gdb, tables...); err != nil {
  103. logger.Error("核心表 AutoMigrate 失败", zap.Error(err))
  104. os.Exit(1)
  105. }
  106. logger.Info("核心表已 AutoMigrate(UNIFIED_AUTO_MIGRATE=1)")
  107. }
  108. rc, err := redis.NewClient(cfg.Redis)
  109. if err != nil {
  110. logger.Error("Redis 连接失败", zap.Error(err))
  111. os.Exit(1)
  112. }
  113. defer func() { _ = rc.Close() }()
  114. // ---- identity 模块装配(T4-6)----
  115. refreshStore := redis.NewRefreshStore(rc)
  116. revocation := redis.NewRevocationStore(rc, cfg.Auth.RevocationKeyPrefix)
  117. tickets := redis.NewLoginTicketStore(rc)
  118. accessTTL := time.Duration(cfg.Auth.AccessTokenTTLMin) * time.Minute
  119. if accessTTL <= 0 {
  120. accessTTL = 30 * time.Minute // 缺省兜底(架构规格 §7.2 固定 30min)
  121. }
  122. refreshTTL := time.Duration(cfg.Auth.RefreshTokenTTLDay) * 24 * time.Hour
  123. if refreshTTL <= 0 {
  124. refreshTTL = 30 * 24 * time.Hour
  125. }
  126. issuer, err := token.NewIssuer(cfg.Auth.PrivateKeyPEM, cfg.Auth.Issuer, accessTTL, refreshTTL, refreshStore, revocation)
  127. if err != nil {
  128. logger.Error("RS256 签发器装配失败(私钥解析?)", zap.Error(err))
  129. os.Exit(1)
  130. }
  131. // 验签公钥:未配置 PublicKeysPEM 时从私钥派生(单机双实例 ADR-015 共享同一密钥对)
  132. pubKeys := cfg.Auth.PublicKeysPEM
  133. if len(pubKeys) == 0 {
  134. derived, derr := token.PublicKeysFromPrivateKey(cfg.Auth.PrivateKeyPEM)
  135. if derr != nil {
  136. logger.Error("验签公钥派生失败", zap.Error(derr))
  137. os.Exit(1)
  138. }
  139. pubKeys = []string{derived}
  140. logger.Warn("Auth.PublicKeysPEM 未配置,已从 PrivateKeyPEM 派生公钥(生产建议显式配置以支持密钥轮换)")
  141. }
  142. // RBAC 解析器(T6.5:role→菜单树/权限码;平台级 PermissionRepo 直连 gdb,TTL 取 0 走缺省 30s)
  143. // 作为 identity 的 MenuProvider 注入:/auth/issue 与 /auth/me 据此下发 menuTree + permissions。
  144. rbacResolver := rbac.NewResolver(orgrepo.NewPermissionRepo(gdb), 0)
  145. authSvc, err := service.NewAuthService(service.Config{
  146. Users: repository.NewUserRepo(gdb),
  147. Identities: repository.NewIdentityRepo(gdb),
  148. Memberships: repository.NewMembershipRepo(gdb),
  149. Issuer: issuer,
  150. Tickets: tickets,
  151. AccessTTL: accessTTL,
  152. PublicKeys: pubKeys,
  153. IssuerStr: cfg.Auth.Issuer,
  154. Revocation: revocation,
  155. MenuProvider: rbacResolver,
  156. })
  157. if err != nil {
  158. logger.Error("AuthService 装配失败", zap.Error(err))
  159. os.Exit(1)
  160. }
  161. authH, err := handler.New(handler.Config{Svc: authSvc, Log: logger})
  162. if err != nil {
  163. logger.Error("Handler 装配失败", zap.Error(err))
  164. os.Exit(1)
  165. }
  166. authMw, err := handler.NewAuth(handler.AuthConfig{PublicKeys: pubKeys, Revocation: revocation, Issuer: cfg.Auth.Issuer})
  167. if err != nil {
  168. logger.Error("验签中间件装配失败", zap.Error(err))
  169. os.Exit(1)
  170. }
  171. // ---- org 模块装配(T6:机构/校区只读 + 作用域越权拦截)----
  172. orgSvc, err := orgservice.NewOrgService(gdb)
  173. if err != nil {
  174. logger.Error("OrgService 装配失败", zap.Error(err))
  175. os.Exit(1)
  176. }
  177. orgH, err := orghandler.New(orghandler.Config{Svc: orgSvc})
  178. if err != nil {
  179. logger.Error("org Handler 装配失败", zap.Error(err))
  180. os.Exit(1)
  181. }
  182. // RBAC 矩阵配置服务 + handler(T6.5-e 超管可配置后台;平台级,不走 scoping)
  183. // 保存成功后经 rbacResolver.Invalidate() 清本实例缓存(跨实例靠 TTL 30s 自然一致)。
  184. rbacSvc, err := orgservice.NewRolePermissionService(gdb, orgrepo.NewPermissionRepo(gdb), rbacResolver)
  185. if err != nil {
  186. logger.Error("RBAC 矩阵配置服务装配失败", zap.Error(err))
  187. os.Exit(1)
  188. }
  189. rbacH, err := orghandler.NewRBAC(orghandler.RBACConfig{Svc: rbacSvc})
  190. if err != nil {
  191. logger.Error("RBAC Handler 装配失败", zap.Error(err))
  192. os.Exit(1)
  193. }
  194. app := fiber.New(fiber.Config{
  195. AppName: "yuansiwei-unified-backend",
  196. ReadTimeout: time.Duration(cfg.Server.ReadTimeoutSec) * time.Second,
  197. DisableStartupMessage: true,
  198. // 请求体上限 10MB:费用凭证/作业图片走 OSS 直传,接口侧只收元数据
  199. BodyLimit: 10 << 20,
  200. })
  201. // 中间件链(§2.2 顺序铁律:Recover 最前兜底 panic → RequestID 生成/透传 trace_id)
  202. app.Use(recoverMiddleware(logger))
  203. app.Use(requestid.New(requestid.Config{Generator: newTraceID}))
  204. // 存活探针(ADR-015:nginx upstream healthcheck + K8s 预留 liveness)
  205. app.Get("/healthz", func(c *fiber.Ctx) error {
  206. return c.JSON(fiber.Map{
  207. "status": "ok",
  208. "instance": cfg.Server.InstanceID,
  209. "time": time.Now().Format(time.RFC3339),
  210. })
  211. })
  212. // ---- 业务域路由挂载(公开路由须在 Auth Group 之前——铁律 8)----
  213. // 公开(无需登录态):两步登录①② + refresh 轮换 + 微信扫码占位
  214. app.Post("/auth/login", authH.Login)
  215. app.Post("/auth/issue", authH.Issue)
  216. app.Post("/auth/refresh", authH.Refresh)
  217. app.Get("/auth/wechat/qrcode", authH.WechatQrcode)
  218. app.Get("/auth/wechat/status", authH.WechatStatus)
  219. // 受保护(前置验签中间件:验签 + 作用域注入)
  220. auth := app.Group("/auth")
  221. auth.Use(authMw)
  222. auth.Get("/me", authH.Me)
  223. auth.Post("/logout", authH.Logout)
  224. // org 域(机构/校区只读 + 作用域越权拦截,经同一验签中间件;作用域由中间件注入,
  225. // Repository Scoping 强制机构/校区过滤——跨校区越权防线,架构规格 §3.5)
  226. // 路由角色白名单(T6.5-d 接口强制层):机构/校区目录对 staff 角色开放
  227. // (academic 教务 / finance 财务 / teacher 老师),业务级 student/parent 拒绝(1003),
  228. // 超管经 SuperAdmin 恒放行。与 e2e TestOrgE2E_RouteRoleWhitelist 白名单一致。
  229. org := app.Group("/org")
  230. org.Use(authMw)
  231. org.Use(handler.RequireRole("academic", "finance", "teacher"))
  232. org.Get("/institutions", orgH.Institutions)
  233. org.Get("/institutions/:institutionId", orgH.Institution)
  234. org.Get("/campuses", orgH.Campuses)
  235. org.Get("/campuses/:campusId", orgH.Campus)
  236. // RBAC 矩阵配置(T6.5-e 超管可配置后台):平台级,不走 scoping;独立兄弟组,仅超管可读写。
  237. // 与上面的 /org 组并列(不继承其 staff 白名单),自带 authMw + RequireRole("super_admin"):
  238. // 超管经 SuperAdmin 恒放行;其他任何角色(含 academic/finance/teacher)在子组白名单处被 1003。
  239. rbacCfg := app.Group("/org/role-permissions")
  240. rbacCfg.Use(authMw)
  241. rbacCfg.Use(handler.RequireRole("super_admin"))
  242. rbacCfg.Get("/:roleCode", rbacH.RolePermissions)
  243. rbacCfg.Put("/:roleCode", rbacH.SaveRolePermissions)
  244. // 其余域(academic/teaching/ai)路由挂载点(域模块实现后在此注册):
  245. //
  246. // app.Get("/auth/jwks", identityHandler.JWKS) // 公开
  247. // auth := app.Group("/", middleware.Auth(logger)) // 以下全部需登录
  248. // auth.Get("/auth/me", identityHandler.Me)
  249. // auth.Get("/admin/courses/:id", academicHandler.Get) // PC 端
  250. // auth.Get("/student/homeworks", teachingHandler.List) // 移动端
  251. // 优雅退出(SIGTERM/SIGINT;GracePeriodSec 内排空存量请求,§7.3)
  252. grace := time.Duration(cfg.Server.GracePeriodSec) * time.Second
  253. if grace <= 0 {
  254. grace = 30 * time.Second
  255. }
  256. done := make(chan struct{})
  257. go func() {
  258. sig := make(chan os.Signal, 1)
  259. signal.Notify(sig, syscall.SIGINT, syscall.SIGTERM)
  260. s := <-sig
  261. logger.Info("收到退出信号,开始优雅停机", zap.String("signal", s.String()), zap.Duration("grace", grace))
  262. close(done)
  263. }()
  264. errCh := make(chan error, 1)
  265. go func() { errCh <- app.Listen(cfg.Server.Addr) }()
  266. select {
  267. case err := <-errCh:
  268. if err != nil {
  269. logger.Error("HTTP 服务异常退出", zap.Error(err))
  270. os.Exit(1)
  271. }
  272. case <-done:
  273. if err := app.ShutdownWithTimeout(grace); err != nil {
  274. logger.Warn("优雅退出超时,强制关闭", zap.Error(err))
  275. } else {
  276. logger.Info("服务已优雅退出")
  277. }
  278. }
  279. }
  280. // recoverMiddleware 全局 panic 兜底(§3.2 规则 4):未捕获 panic 统一降级为
  281. // body code=5001(HTTP 仍 200,铁律 6)+ 结构化日志(带堆栈 + trace_id),
  282. // **绝不**把 panic 信息/堆栈透传给前端。
  283. //
  284. // 入参:
  285. // - logger *zap.Logger:进程级结构化日志器。
  286. //
  287. // 出参:
  288. // - fiber.Handler:Fiber 中间件(返回后继续 c.Next() 链)。
  289. //
  290. // 说明:骨架期直接写 5001 信封(不引入 infra/response 依赖,避免 main 包耦合具体域);
  291. // 域模块就绪后切换为 response.Fail 统一出口。
  292. func recoverMiddleware(logger *zap.Logger) fiber.Handler {
  293. return func(c *fiber.Ctx) (err error) {
  294. defer func() {
  295. if p := recover(); p != nil {
  296. logger.Error("panic 已兜底",
  297. zap.String("trace_id", c.Get("X-Request-ID")),
  298. zap.String("path", c.Path()),
  299. zap.Any("panic", p))
  300. err = c.Status(fiber.StatusOK).JSON(fiber.Map{
  301. "code": 5001,
  302. "message": "系统繁忙",
  303. "success": false,
  304. })
  305. }
  306. }()
  307. return c.Next()
  308. }
  309. }
  310. // newTraceID 生成请求 trace_id(§3.3:nginx 透传 X-Request-ID 时 requestid 中间件不再生成,
  311. // 缺失时以 crypto/rand 32 字节 hex 兜底;跨 Python Agent 调用时透传同一值)。
  312. //
  313. // 入参:无。
  314. // 出参:
  315. // - string:64 字符 hex;crypto/rand 故障(概率≈0)时以时间戳兜底,不阻断请求。
  316. func newTraceID() string {
  317. b := make([]byte, 32)
  318. if _, err := rand.Read(b); err != nil {
  319. return fmt.Sprintf("%064x", uint64(time.Now().UnixNano()))
  320. }
  321. return hex.EncodeToString(b)
  322. }
  323. // newLogger 按级别构造 zap 生产级 logger(JSON 编码,ts 用 RFC3339——访问日志与 trace 对齐,§3.3)。
  324. //
  325. // 入参:
  326. // - level string:"debug"/"info"/"warn"/"error"(大小写不敏感;空/非法值按 info 处理)。
  327. //
  328. // 出参:
  329. // - *zap.Logger:就绪日志器(NewDevelopment 风格控制台可读 + 生产字段结构)。
  330. // - error:仅当 zap 构造失败时非 nil。
  331. func newLogger(level string) (*zap.Logger, error) {
  332. var l zapcore.Level
  333. switch level {
  334. case "debug":
  335. l = zapcore.DebugLevel
  336. case "warn":
  337. l = zapcore.WarnLevel
  338. case "error":
  339. l = zapcore.ErrorLevel
  340. case "info", "":
  341. l = zapcore.InfoLevel
  342. default:
  343. l = zapcore.InfoLevel // 非法级别不阻断启动,按 info 兜底(配置错误由部署期自检发现)
  344. }
  345. cfg := zap.NewProductionConfig()
  346. cfg.Level = zap.NewAtomicLevelAt(l)
  347. cfg.EncoderConfig.TimeKey = "ts"
  348. cfg.EncoderConfig.EncodeTime = zapcore.RFC3339TimeEncoder
  349. return cfg.Build()
  350. }