handler.go 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298
  1. // Package handler academic 域 HTTP 接入层(架构规格 §3.2 三层之 Handler,AC-12/AC-13)。
  2. //
  3. // 分层职责(与 identity/org handler 同款,不另起一套):
  4. // - 本包:绑定/校验请求(`validator.Validate` → 2001)→ 从 `scope.FromFiber` 取作用域(取不到 → 1001)
  5. // → **按作用域装配 Service**(academic 的 Service 在构造时绑定 scope)→ 把 `*AppError`
  6. // 映射为统一信封(`response.Fail` / `response.OK` / `response.Page`)。
  7. // **不写业务逻辑、不直接碰 DB**。
  8. // - Service(academic/service):资金 / 退费 / 账单 / 工单编排(事务边界只在这一层,§10.3)。
  9. // - Repository(academic/repository):Scoping 强制过滤 + 只读聚合。
  10. //
  11. // ---------------------------------------------------------------------------
  12. // 路径口径(设计 §4 口径表 v0.1.24,**已冻结**)
  13. // ---------------------------------------------------------------------------
  14. //
  15. // 本包所有路径常量**不含 `/api`**。`/api` 只是**全站外部前缀**(vite `rewrite` / nginx 尾斜杠去掉),
  16. // 不进后端路由表:
  17. //
  18. // 对外请求:/api/admin/finance/recharges
  19. // 后端路由: /admin/finance/recharges ← 本包 Path* 常量就是这一层
  20. //
  21. // academic 只占 3 个一级段:`/admin`、`/student`、`/pay`(`/auth` 属 identity、`/org` 属 org,
  22. // **不得**在此重复注册;AC-14 有一条"一级段白名单"运行期断言专门守这条)。
  23. //
  24. // ---------------------------------------------------------------------------
  25. // 六条接入层纪律(AC-12 验收项,逐条对应实现位置)
  26. // ---------------------------------------------------------------------------
  27. //
  28. // ① 端点覆盖:端点 1~17 + 21 → fund_handler.go(1~16)、bill_handler.go(17、21)。
  29. // ② `validateReq` 失败 → **2001**;金额字符串非法 / 枚举非法 → **2002**(两者不串):
  30. // `validator.Validate` 负责 2001(缺参/格式),`parseMoney`/`parseTypeFilter` 负责 2002。
  31. // ③ `scope.FromFiber` 取不到 → **1001**:`mustScope`。
  32. // ④ 金额入参**一律字符串**(DTO 里是 `string`)→ 走 `money.Parse`;**不接受 float64**。
  33. // 这条不是风格问题:JSON number 解码进 `money.Amount` 会经过 float64(精度陷阱),
  34. // 所以 DTO 用 string + 显式 Parse,**连"宽松接受数字"都不做**(见 `parseMoney` 注释)。
  35. // ⑤ 分页钳制**唯一实现点**:`parsePage`(内部只调 `response.ParsePage`),
  36. // handler 里**禁止**再出现 `if pageSize > 200` 这类分支(一处改、处处生效)。
  37. // ⑥ 响应体不含敏感字段:视图 DTO 逐字段声明(`RequestView` 无 `imgs`、
  38. // `LogView` 无 `pay_return_data`),**不直接序列化 model**(model 的 `json:"-"` 是最后一道,
  39. // 不是唯一一道)。
  40. package handler
  41. import (
  42. "strings"
  43. "time"
  44. "github.com/gofiber/fiber/v2"
  45. "go.uber.org/zap"
  46. "gorm.io/gorm"
  47. "yuansiwei/unified-backend/internal/academic/money"
  48. "yuansiwei/unified-backend/internal/academic/port"
  49. "yuansiwei/unified-backend/internal/academic/service"
  50. infraerrors "yuansiwei/unified-backend/internal/infra/errors"
  51. "yuansiwei/unified-backend/internal/infra/response"
  52. appscope "yuansiwei/unified-backend/internal/infra/scope"
  53. "yuansiwei/unified-backend/internal/infra/validator"
  54. )
  55. // ---------------------------------------------------------------- 路径常量(**不含 `/api`**)
  56. // 财务域路径常量(端点 1~16、21;对外 = `/api` + 这些值)。
  57. const (
  58. // PathFinanceAccounts 端点 1:账户快照(`GET /admin/finance/accounts/:userId`)。
  59. PathFinanceAccounts = "/admin/finance/accounts/:userId"
  60. // PathFinanceRefundable 端点 2:可退金额(`GET /admin/finance/accounts/:userId/refundable`)。
  61. PathFinanceRefundable = "/admin/finance/accounts/:userId/refundable"
  62. // PathFinanceRecharges 端点 3:充值(`POST /admin/finance/recharges`)。
  63. PathFinanceRecharges = "/admin/finance/recharges"
  64. // PathFinanceExpenditures 端点 4:消费(`POST /admin/finance/expenditures`)。
  65. PathFinanceExpenditures = "/admin/finance/expenditures"
  66. // PathFinanceRefunds 端点 5:退费(`POST /admin/finance/refunds`)。
  67. PathFinanceRefunds = "/admin/finance/refunds"
  68. // PathFinanceRefundsCustom 端点 6:自定义退费(双 log 坏账)(`POST /admin/finance/refunds/custom`)。
  69. PathFinanceRefundsCustom = "/admin/finance/refunds/custom"
  70. // PathFinanceTransfers 端点 7:课费转结(`POST /admin/finance/transfers`)。
  71. PathFinanceTransfers = "/admin/finance/transfers"
  72. // PathFinanceBadDebts 端点 8:坏账(`POST /admin/finance/bad-debts`)。
  73. PathFinanceBadDebts = "/admin/finance/bad-debts"
  74. // PathFinanceClearedBalances 端点 9:余额清零(`POST /admin/finance/cleared-balances`)。
  75. PathFinanceClearedBalances = "/admin/finance/cleared-balances"
  76. // PathFinanceSpends 端点 10:累计消费(`POST /admin/finance/spends`)。
  77. PathFinanceSpends = "/admin/finance/spends"
  78. // PathFinanceLogs 端点 11:流水列表(`GET /admin/finance/logs`)。
  79. PathFinanceLogs = "/admin/finance/logs"
  80. // PathFinanceRequests 端点 12/13:工单列表 / 创建(`/admin/finance/requests`)。
  81. PathFinanceRequests = "/admin/finance/requests"
  82. // PathFinanceRequestApprove 端点 14:工单通过(`POST /admin/finance/requests/:id/approve`)。
  83. PathFinanceRequestApprove = "/admin/finance/requests/:id/approve"
  84. // PathFinanceRequestReject 端点 15:工单驳回(`POST /admin/finance/requests/:id/reject`)。
  85. PathFinanceRequestReject = "/admin/finance/requests/:id/reject"
  86. // PathFinanceRequestCancel 端点 16:工单撤销(`POST /admin/finance/requests/:id/cancel`)。
  87. PathFinanceRequestCancel = "/admin/finance/requests/:id/cancel"
  88. // PathFinanceDashboard 端点 21:仪表盘(`GET /admin/finance/dashboard`,P2)。
  89. PathFinanceDashboard = "/admin/finance/dashboard"
  90. )
  91. // PathStudentBill 端点 17:学生账单(`GET /student/bill`)。
  92. const PathStudentBill = "/student/bill"
  93. // ---------------------------------------------------------------- 处理器装配
  94. // Config Handler 装配参数(AC-14 在 `cmd/api/main.go` 按此构造)。
  95. //
  96. // 字段:
  97. // - DB *gorm.DB:数据库句柄(**必填**:academic 的 Service 在构造时需要 scope,无法预装配,
  98. // 故 Handler 持 DB、按请求作用域现场装配 Service);
  99. // - Member port.MembershipChecker:成员校验器(可 nil:nil 时服务层跳过对象级越权断言,
  100. // 仅限双跑/回填脚本;生产装配**必须**注入);
  101. // - Log *zap.Logger:结构化日志器(可 nil)。
  102. type Config struct {
  103. // DB 数据库句柄(必填)。
  104. DB *gorm.DB
  105. // Member 成员校验器(可 nil)。
  106. Member port.MembershipChecker
  107. // Log 日志器(可 nil)。
  108. Log *zap.Logger
  109. }
  110. // Handler academic 域 HTTP 处理器(启动装配一次,全进程共享)。
  111. //
  112. // 语义说明(**为什么按请求装配 Service**):academic 的 Service 构造函数签名是
  113. // `NewXxxService(db, sc, member)`——作用域是**构造期**绑定到 Repository 的(见 infra/scope 包注释
  114. // "构造 Repository 即绑定本次请求的租户")。因此本 Handler 只持有不可变的 `db`/`member`,
  115. // 每个请求经 `servicesFor(sc)` 现场装配一套服务;`db` 是并发安全的连接池,装配开销只是几个 struct。
  116. type Handler struct {
  117. db *gorm.DB
  118. member port.MembershipChecker
  119. log *zap.Logger
  120. }
  121. // New 构造 academic 域 HTTP 处理器。
  122. //
  123. // 入参:cfg Config。
  124. // 出参:
  125. // - *Handler:就绪处理器;
  126. // - error:DB 未注入(fail-fast——没有 DB 无法装配任何服务,挂载端点只会 5001)。
  127. func New(cfg Config) (*Handler, error) {
  128. if cfg.DB == nil {
  129. return nil, infraerrors.New(infraerrors.CodeInternal, "academic handler: DB 未注入")
  130. }
  131. return &Handler{db: cfg.DB, member: cfg.Member, log: cfg.Log}, nil
  132. }
  133. // scopedServices 一次请求内装配的服务集合(按作用域现场构造,请求结束即丢弃)。
  134. type scopedServices struct {
  135. // fund 资金服务(端点 2~5、7、8、10)。
  136. fund *service.FundService
  137. // refund 退费服务(端点 6、9)。
  138. refund *service.RefundService
  139. // bill 账单服务(端点 17)。
  140. bill *service.BillService
  141. // query 财务只读查询(端点 1、11、12、21)。
  142. query *service.FinanceQueryService
  143. // requests 工单服务(端点 13~16)。
  144. requests *service.BalanceRequestService
  145. }
  146. // servicesFor 按请求作用域装配一套服务。
  147. //
  148. // 入参:sc 作用域(**非 nil**——调用方已用 mustScope 判定)。
  149. // 出参:*scopedServices(字段全部非 nil)。
  150. func (h *Handler) servicesFor(sc *appscope.Scope) *scopedServices {
  151. campus := port.NewOrgCampusReader(h.db)
  152. return &scopedServices{
  153. fund: service.NewFundService(h.db, sc, h.member),
  154. refund: service.NewRefundService(h.db, sc, campus, h.member),
  155. bill: service.NewBillService(h.db, sc).WithMembershipChecker(h.member),
  156. query: service.NewFinanceQueryService(h.db, sc, h.member),
  157. requests: service.NewBalanceRequestService(h.db, sc, h.member),
  158. }
  159. }
  160. // ---------------------------------------------------------------- 公共助手(四件事:作用域 / 校验 / 金额 / 分页)
  161. // mustScope 取中间件注入的多租户作用域;取不到 → **1001**(AC-12 验收第 ③ 条)。
  162. //
  163. // 入参:c *fiber.Ctx。
  164. // 出参:
  165. // - *appscope.Scope:非 nil 作用域;
  166. // - error:`infraerrors.ErrUnauth`(1001)——受保护路由未注入作用域 = 未登录/中间件链配置错误。
  167. //
  168. // 为什么返回 error 而不是直接写响应:让调用方 `return response.Fail(c, err)` 统一出口,
  169. // 避免本函数既写响应又返回值(双重写出是 Fiber 里最难查的一类 bug)。
  170. func mustScope(c *fiber.Ctx) (*appscope.Scope, error) {
  171. sc := appscope.FromFiber(c)
  172. if sc == nil {
  173. return nil, infraerrors.ErrUnauth
  174. }
  175. return sc, nil
  176. }
  177. // validateReq 绑定并校验 JSON 请求体;失败时响应已写出(2001),调用方 `return nil`(AC-12 第 ② 条)。
  178. //
  179. // 入参:c;dst 目标结构体指针。
  180. // 出参:true 通过;false 失败(**body code=2001 已写出**)。
  181. //
  182. // 这是 `infra/validator.Validate` 的本地别名,存在意义只有一条:把"academic 的 Handler 一律经此函数
  183. // 校验"变成可 grep 的纪律(评审时 `grep -c validateReq` 应等于非 GET 端点数)。
  184. func validateReq(c *fiber.Ctx, dst any) bool {
  185. return validator.Validate(c, dst)
  186. }
  187. // parseMoney 解析**字符串**金额入参(AC-12 第 ④ 条:金额一律字符串,走 money.Parse)。
  188. //
  189. // 入参:
  190. // - c *fiber.Ctx:请求上下文(仅用于写失败响应);
  191. // - raw string:DTO 里的金额字段(`"100.00"`);
  192. // - field string:字段名(错误文案定位,如 "money"/"spendMoney")。
  193. //
  194. // 出参:
  195. // - money.Amount:定点金额;
  196. // - bool:false 表示解析失败,**body code=2002 已写出**,调用方 `return nil`。
  197. //
  198. // 红线(**为什么必须是 2002 而不是 2001**):值传了但格式非法属"填错"(2002),
  199. // 字段没传属"漏填"(2001,由 validator 负责)。两者在前端提示语与埋点上是不同分支,
  200. // 合并会让"漏填金额"被提示成"金额格式错误",排查成本直接翻倍。
  201. //
  202. // 另一个红线:**不接受 JSON number**。DTO 字段声明为 `string`,`{"money": 100}` 会在
  203. // `validator.Validate` 的 JSON 解码阶段就失败(按 infra/validator 既有约定归 **2002**,
  204. // 而不是被静默接受成 100.00)——
  205. // 这是有意的:让"前端传了数字"在联调第一天就暴露,而不是等上了生产才发现
  206. // float64 → 分 的舍入把 0.1+0.2 级的差额带进对账。
  207. func parseMoney(c *fiber.Ctx, raw, field string) (money.Amount, bool) {
  208. amount, err := money.Parse(strings.TrimSpace(raw))
  209. if err != nil {
  210. if ferr := response.Fail(c, infraerrors.WithCause(infraerrors.ErrBadFormat,
  211. errString("金额字段 "+field+" 格式非法(必须是两位小数的字符串)"))); ferr != nil {
  212. return 0, false
  213. }
  214. return 0, false
  215. }
  216. return amount, true
  217. }
  218. // parsePage 解析分页参数(AC-12 第 ⑤ 条:**唯一钳制实现点**)。
  219. //
  220. // 入参:c *fiber.Ctx(读 `page`/`pageSize` query)。
  221. // 出参:(page, pageSize):page ≥ 1;pageSize ∈ [1, 200](>200 → 200,缺省 10)。
  222. //
  223. // 实现只转调 `response.ParsePage`——全仓唯一的分页钳制实现。
  224. // **禁止**在任何 handler 里自写 `if pageSize > 200 { pageSize = 200 }`:
  225. // 那样一旦产品把上限改成 500,改了一处漏了五处,症状是"某个页面能拉 500 条、另一个只能 200"。
  226. func parsePage(c *fiber.Ctx) (page, pageSize int) {
  227. return response.ParsePage(c)
  228. }
  229. // parseTimeParam 解析时间 query 参数(`from`/`to`)。
  230. //
  231. // 入参:raw 原始字符串;field 字段名(错误文案定位)。
  232. // 出参:(时间, 是否传了, error);空串 → (零值, false, nil);格式非法 → ErrBadFormat(2002)。
  233. //
  234. // 接受两种格式(前端的两种真实用法):
  235. // 1. `2006-01-02`(纯日期,最常用;按 UTC 当日 00:00:00 解释);
  236. // 2. RFC3339(`2006-01-02T15:04:05Z07:00`,带时分秒与时区)。
  237. //
  238. // ⚠ 端点 17(账单)的 `to` 语义是**不含上界**(见 service.GetBillInput 注释):
  239. // 传 `to=2026-04-01` 表示"到 3 月底为止",当日流水不计入——这与"余额/期初期末"口径一致。
  240. func parseTimeParam(raw, field string) (time.Time, bool, error) {
  241. trimmed := strings.TrimSpace(raw)
  242. if trimmed == "" {
  243. return time.Time{}, false, nil
  244. }
  245. if t, err := time.Parse(time.RFC3339, trimmed); err == nil {
  246. return t, true, nil
  247. }
  248. if t, err := time.Parse("2006-01-02", trimmed); err == nil {
  249. return t, true, nil
  250. }
  251. return time.Time{}, false, infraerrors.WithCause(infraerrors.ErrBadFormat,
  252. errString("时间字段 "+field+" 格式非法(支持 2006-01-02 或 RFC3339)"))
  253. }
  254. // parseIDParam 解析路径/查询里的 int64 ID(空串或非法 → 0,交由下游 2001/3001 判)。
  255. //
  256. // 入参:raw 原始字符串。出参:int64(解析失败为 0)。
  257. //
  258. // 为什么不在 Handler 直接报 2002:ID 为 0 时下游(Service/Repo)会给出更精确的语义
  259. // (2001 缺参 or 3001 不存在),Handler 抢先判定只会让错误码与真实原因脱节。
  260. func parseIDParam(raw string) int64 {
  261. trimmed := strings.TrimSpace(raw)
  262. if trimmed == "" {
  263. return 0
  264. }
  265. var out int64
  266. for _, ch := range trimmed {
  267. if ch < '0' || ch > '9' {
  268. return 0
  269. }
  270. out = out*10 + int64(ch-'0')
  271. }
  272. return out
  273. }
  274. // errString 实现 error 的最小字符串类型(本包不引入额外依赖,语义同 repository.errString)。
  275. type errString string
  276. // Error 实现 error 接口。
  277. func (e errString) Error() string { return string(e) }