handler.go 18 KB

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