main.go 17 KB

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