feat: 技术债务清理(支付配置动态化、API文档补全、轮询常量提取、废弃代码清理)
All checks were successful
构建并部署到测试环境(无 SSH) / build-and-deploy (push) Successful in 7m13s

This commit is contained in:
2026-04-14 11:11:15 +08:00
parent c0b64c9e30
commit 42c5ec912f
63 changed files with 1979 additions and 775 deletions

View File

@@ -0,0 +1,2 @@
schema: spec-driven
created: 2026-04-13

View File

@@ -0,0 +1,340 @@
## Context
项目于 2024 年初启动,经过一年多的功能迭代,业务模块逐步完善(支付、轮询、分佣、多租户等),但代码库中积累了分散的废弃代码、硬编码常量、规范缺陷和设计遗留问题。这些问题目前不影响功能,但随着新功能增加,维护成本快速上升:
1. **API 文档覆盖率仅 18.75%**docs.go/gendocs 只注册了 9 个 Handler实际路由 48 个,导致 39 个接口无法在 OpenAPI 文档中查阅
2. **支付配置硬编码**order/service 和 recharge/service 中 3 处 TODO直接使用全局 `s.wechatPayment`,多商户场景下无法正确验签
3. **硬编码魔法字符串**:轮询系统中 10+ 处状态字符串未提取常量,无法被 IDE 重构工具识别,变更风险高
4. **废弃代码散布各处**15 个常量别名、3 个 DTO、2 个方法标注废弃但仍保留,新开发者易误用
5. **Model 数据冗余**IotCard 和 Device 模型中 4 个字段已被替代但仍保留在数据库,造成数据不一致风险
6. **DTO 规范缺口**122 个 Response DTO 缺少 `_name` 文字字段,违反项目规范
7. **迁移文件堆积,无法支撑生产部署**:开发阶段逐步积累 114 个迁移000000~000113包含大量中间过渡状态重命名表、删除旧表、修复字段类型等问题具体为
- `000104_polling_config_data` 仅有 `.up.sql`,缺少 `.down.sql`
- `backfill_order_purchase_role.sql` 游离在外,不符合 golang-migrate 命名规范,不会被自动执行
- 新环境部署需顺序执行 114 个迁移,任何一步失败即卡住
## Goals / Non-Goals
**Goals:**
1. **文档完整性**:补全 API 文档生成器,达到 100% 覆盖率,确保前端/对接方能通过 OpenAPI 文档查阅所有接口
2. **系统可靠性**:实现支付配置动态加载,支持多商户场景,消除验签失败隐患
3. **代码规范化**:清理所有硬编码常量、废弃代码、重复 DTO统一提取到 `pkg/constants/`,降低维护成本和新手上手难度
4. **数据库一致性**:删除废弃 Model 字段和对应数据库列,防止新/旧逻辑产生的数据不一致
5. **规范落实**:补全 DTO `_name` 字段和 Service 层赋值逻辑,确保规范 100% 贯彻
6. **生产就绪的迁移基线**:将 114 个开发期迁移合并为 2 个生产基线文件,新环境一条命令完成全量建库,彻底消除中间过渡状态
**Non-Goals:**
- 重构现有业务逻辑(支付、轮询、分佣等),仅清理代码结构
- 修改 API 契约或响应格式(除了补充 `_name` 字段)
- 优化性能(无性能变更)
- 新增功能
## Decisions
### 决策 1API 文档生成器补全
**选择**:修改 `cmd/api/docs.go``cmd/gendocs/main.go`,在 `bootstrap.Handlers` 结构体中注册缺失的 39 个 HandlerAccount、AdminOrder、Asset、Authorization 等)
**理由**
- 这两个文件是唯一的 API 文档入口,所有接口都需在此注册才能出现在 OpenAPI 文档中
- 注册逻辑简单且低风险(仅字段赋值,无业务逻辑变更)
- 满足项目规范:"新增 Handler 时必须同步更新文档生成器"
**替代方案考虑**
- ❌ 自动扫描所有 Handler增加框架复杂性不符合 Go 惯用模式(显式优于隐式)
- ❌ 分阶段补全:低优先级接口仍可能被遗漏,最终还是需要一次性全部补全
---
### 决策 2支付配置动态加载架构
**选择**:在 Service 层新增 `PaymentConfigLoader` 接口和实现,`order/service.go``recharge/service.go` 中调用此接口从 `payment_config_id` 动态获取对应的支付配置实例
```go
// pkg/payment/loader.go新增
type PaymentConfigLoader interface {
LoadConfig(ctx context.Context, configID uint) (Payment, error)
}
// internal/service/order/service.go修改
func (s *OrderService) PayOrder(ctx context.Context, orderID uint) error {
order := s.store.GetOrder(orderID)
cfg, err := s.paymentLoader.LoadConfig(ctx, order.PaymentConfigID) // 动态加载
return cfg.Verify(order.PaymentData)
}
```
**理由**
- 解耦支付配置与订单逻辑,支持多商户多配置场景
- 缓存在 Redis 中key: `payment:config:{configID}`),减少数据库查询
- 若配置不存在或无权限,返回 `errors.New(errors.CodePaymentConfigNotFound)`
**替代方案考虑**
- ❌ 在 Store 层加载:支付验签是业务逻辑,应在 Service 层处理
- ❌ 继续使用全局单例:无法支持多商户,前期配置可行但长期不可扩展
---
### 决策 3轮询状态常量提取
**选择**:在 `pkg/constants/polling.go` 中新增轮询日志状态常量,替换 `polling_manual_trigger.go``manual_trigger_service.go``polling_manual_trigger_store.go``alert_service.go` 中的硬编码字符串
```go
// pkg/constants/polling.go新增
const (
// 轮询手动触发日志状态
PollingManualTriggerStatusPending = "pending" // 待处理
PollingManualTriggerStatusProcessing = "processing" // 处理中
PollingManualTriggerStatusCompleted = "completed" // 已完成
PollingManualTriggerStatusCancelled = "cancelled" // 已取消
)
```
**理由**
- 集中管理状态值,便于全局修改和 IDE 重构
- 保持与轮询系统其他常量(`PollingStatusEnabled` 等)的命名一致性
- 消除硬编码减少代码行数 ~10 行
**替代方案考虑**
- ❌ 定义 enum 类型Go 中无原生 enum定义 type+const 更符合惯用模式
- ❌ 分散定义在各模块:违反"集中在 pkg/constants/"规范
**已知遗留问题(不在本次范围内)**
轮询手动触发日志的状态字段(`status`)在数据库和代码中均为 `string` 类型,而项目规范要求"状态类(生命周期)用 `int`"。本次清理**仅提取常量,不修改字段类型**,原因:
1. 修改字段类型需要数据库迁移,会产生 API 破坏性变更(现有 JSON 字段值改变)
2. 当前没有并行业务需求推动这个改动
本次提案将此作为已知技术债务记录,待后续版本统一规划。
---
### 决策 4废弃代码清理
**选择**
1. **同步模板代码**`internal/task/sync.go`):删除整个文件,轮询系统已实现真正的 SIM 卡状态/实名状态/流量同步逻辑
2. **废弃常量别名**`pkg/constants/wallet.go`):全局搜索并替换 15 个 `Deprecated` 别名为新常量,然后删除别名定义
3. **废弃 DTO 类型**3 个):确认无引用后删除 `DeviceBundle``DeviceBundleCard``AllocatedDevice`
4. **废弃方法**2 个):确认无引用后删除 `CreateLegacy()``CheckAndStopCard()`
**理由**
- 废弃代码继续存在会增加代码认知负担,新开发者易误用
- 同步任务虽然是模板,但从未被入队使用,保留无意义
- 这些清理是一次性工作,越早做越好(后续修改越多,冲突风险越大)
**替代方案考虑**
- ❌ 标注但保留:会持续占用代码审查注意力,推迟问题不是解决方案
- ❌ 分批清理:逐个清理会产生多个 PR合并前后的重构冲突难以管理
---
### 决策 5Model 废弃字段清理
**选择**
1.`iot_card.go``device.go` 中删除 `FirstCommissionPaid``AccumulatedRecharge` 字段定义
2. 创建数据库迁移脚本(`000XXX_remove_legacy_commission_fields.up.sql`),删除对应列
**理由**
- 这两个字段已被 `AccumulatedRechargeBySeriesJSON``FirstRechargeTriggeredBySeriesJSON` 替代,新逻辑不再维护它们
- 保留在数据库中造成数据冗余和不一致风险(新逻辑更新 BySeriesJSON旧字段不更新
- GORM 对比迁移后Model 与数据库结构保持一致
**替代方案考虑**
- ❌ 仅删除 Model 定义不删除数据库列GORM 迁移时会警告字段缺失,容易引发混淆
- ❌ 只删除数据库列不删除 Model 定义:运行时可能触发 scanning 错误
---
### 决策 6DTO `_name` 字段补全
**选择**
1. 遍历 `internal/model/dto/` 下所有 DTO 文件,找出所有 int 类型状态字段
2. 为每个状态字段补充 `_name``_text` 文字字段(命名规则:字段名+`_name`
3. 在 Service 层使用中间件或钩子函数,自动赋值这些文字字段
示例:
```go
// internal/model/dto/account_dto.go修改
type AccountResponse struct {
ID uint `json:"id"`
Status int `json:"status" description:"状态 (0:禁用, 1:启用)"`
StatusName string `json:"status_name" description:"状态名称"` // 新增
// ...
}
// internal/service/account/service.go修改
func (s *Service) GetAccount(ctx context.Context, id uint) (*dto.AccountResponse, error) {
account, err := s.store.Get(ctx, id)
resp := s.toAccountResponse(account)
resp.StatusName = constants.GetAccountStatusName(resp.Status) // 赋值
return resp, nil
}
```
**理由**
- 规范要求:项目 AGENTS.md 明确规定 "Response DTO 的 int 状态字段必须有 `_name` 字段"
- 无需前端维护枚举映射表,直接使用后端返回的中文文本显示
- 规范 100% 贯彻,新接口强制遵守,存量接口逐步补全
**替代方案考虑**
- ❌ 统一使用 string 类型状态字段:破坏现有 API 契约,多个客户端需升级
- ❌ 前端维护枚举映射表:维护成本高,易不同步
---
### 决策 7未使用常量清理
**选择**
1. 删除 `pkg/errors/codes.go` 中的 `CodeExceedLimit` 错误码及其消息映射
2.`pkg/constants/iot.go` 中 ~22 个未引用的预留常量Replacement/Merchant/Approval 系列)添加注释说明预留用途,暂不删除
**理由**
- `CodeExceedLimit` 完全未使用,删除无损失
- iot.go 中的常量可能是为未来功能预留(如设备更换流程、商家管理等),贸然删除可能影响后续规划
- 保留预留常量并标注其用途,便于未来实现相应功能时快速找到
**替代方案考虑**
- ❌ 全部删除:若未来需要这些常量,重新定义会遇到 Git 历史问题
- ❌ 全部保留不标注:占用代码空间,不清楚预留目的
---
## Risks / Trade-offs
### 风险 1支付配置动态加载的缓存策略
**风险**支付配置改变后Redis 缓存不会立即更新,旧订单可能使用过期配置验签
**缓解**
- 缓存 TTL 设置为 1 小时(`JUNHONG_PAYMENT_CONFIG_CACHE_TTL=3600`
- 支付配置变更时主动清除 Redis 缓存(`DELETE payment:config:{configID}`
- 监控日志记录每次加载的配置 ID 和来源(缓存/DB
---
### 风险 2废弃代码全量删除的合并冲突
**风险**:若有并行开发的分支引用被删除的废弃 DTO 或方法,合并时会产生编译错误
**缓解**
- 清理前通知团队成员,检查是否有进行中的 Feature 分支
- 先提交清理 PR所有进行中的 Feature 分支在合并前需 rebase main
- 提前进行代码搜索确认零引用,避免删除有隐式依赖的代码
---
### 风险 3Model 废弃字段删除的数据丢失
**风险**:若有代码仍在写入这些字段(虽已确认无引用),删除数据库列后无法回滚
**缓解**
- 迁移前导出这些列的数据备份(`SELECT id, first_commission_paid, accumulated_recharge FROM tb_iot_card`
- 迁移脚本提供回滚版本(.down.sql
- 在测试环境验证迁移逻辑和回滚步骤
---
### 权衡API 文档生成器的手动注册 vs 自动扫描
**当前选择**:手动注册(在 docs.go 中列出所有 Handler
**权衡**
- ✅ 显式、可控、符合 Go 惯用模式
- ✅ 可灵活控制哪些 Handler 出现在文档中(如隐藏内部接口)
- ❌ 新增 Handler 时需同步更新,易遗漏
**为什么不自动扫描**
- Go 反射在编译期无法获知(需运行时),不符合项目"显式优于隐式"原则
- 增加框架复杂性,维护成本高
---
### 决策 8数据库迁移文件合并策略
**选择**:将 000000~000113 归档生成新的生产基线迁移000114、000115编号接续现有序列
**执行步骤**
```
Step 1: pg_dump --schema-only 生成当前 schema
→ migrations/000114_squash_baseline.up.sql建表 DDL
→ migrations/000114_squash_baseline.down.sqlDROP 所有表)
Step 2: 整合数据初始化
→ migrations/000115_init_data.up.sql
内容:轮询系统初始配置(原 000104 内容)+
历史订单 purchase_role 回填(原 backfill 脚本,已幂等)
→ migrations/000115_init_data.down.sql
内容DELETE 插入的轮询配置行purchase_role 回填不需要 rollback
Step 3: Model 废弃字段删除迁移
→ migrations/000116_remove_legacy_commission_fields.up.sql
DROP COLUMN first_commission_paid, accumulated_rechargetb_iot_card, tb_device
→ migrations/000116_remove_legacy_commission_fields.down.sql
Step 4: 归档旧迁移
→ 将 000000~000113 全部移入 migrations/archive/
Step 5: 提供重置脚本
→ scripts/reset_db.shDROP DATABASE → CREATE DATABASE → migrate up
```
**生产部署流程**(首次):
```bash
migrate -path migrations -database "$DB_DSN" up
# 执行 000114 → 000115 → 000116完成建库 + 数据初始化
```
**测试环境重置**
```bash
./scripts/reset_db.sh # 清空后重建,等价于全新生产部署
```
**理由**
- 无生产历史数据squash 没有历史包袱
- 000114 + 000115 完全等价于顺序执行 000000~000113 的最终结果
- 消除 114 步执行链的失败风险,部署过程更可控
- `backfill_order_purchase_role.sql` 已确认执行过(测试环境 5 条记录有 purchase_role合并进 000115 后幂等安全
**替代方案考虑**
- ❌ 保留全部 114 个迁移:生产首次部署需顺序执行 114 步,中途失败难以排查
- ❌ 从编号 000001 重新开始:测试环境会产生混淆(历史 PR 记录编号冲突)
---
## Migration Plan
### 第一阶段:准备(半天)
1. 通知团队成员,清理方案确认
2. 备份测试环境数据库(快照或 pg_dump
3. 确认所有功能分支代码已 merge 或暂存
### 第二阶段实现4-5 天)
1. **第 1 天**迁移文件合并000114 + 000115 + 000116+ 测试环境重置验证
2. **第 2 天**API 文档补全 + 支付配置动态加载
3. **第 3 天**:轮询状态常量提取 + 废弃代码清理别名、DTO、方法、空文件
4. **第 4 天**Model 废弃字段清理 + DTO `_name` 字段批量补全
5. **第 5 天**:未使用常量清理 + 全量编译测试 + 代码审查
### 第三阶段上线准备1 天)
1. 在纯净环境验证 `migrate up` 从 0 跑到底000114 → 000115 → 000116
2. 验证所有接口正常(特别是支付、轮询、账号管理)
3. 部署到生产环境
### 回滚策略
- **代码**git revert无 API 破坏性变更)
- **数据库 000114**:执行 `.down.sql` 删除所有表(仅在新环境适用,旧数据无法恢复)
- **数据库 000116**:执行 `.down.sql` 恢复废弃列(列结构恢复,历史数据值已备份)
---
## Open Questions
1. **支付配置 Redis 缓存 TTL**:现拟设置为 1 小时,是否有其他考虑?
2. **DTO `_name` 字段赋值时机**:是否需要在 Service 层统一处理,还是允许各模块自行处理?
3. **轮询日志状态是否需要 API 端点查询**:当前只在日志中记录,是否需要开放查询接口?
4. **实名认证检查的业务意图**`client_order/service.go:141`):注释掉的原因是什么,是暂时关闭还是永久删除?

View File

@@ -0,0 +1,46 @@
## Why
项目经过持续迭代积累了一批历史技术债务API 文档覆盖率仅 18.75%9/48 Handler、废弃代码和常量散布各处、DTO 规范缺口近 122 处、支付配置硬编码导致多商户场景下验签会失败。**数据库迁移文件在开发阶段逐步累积至 114 个,包含 1 个缺失 `.down.sql` 的数据迁移和 1 个游离的 backfill 脚本**,无法支撑生产环境干净、可重复的部署。现阶段业务功能趋于稳定,是集中清理的最佳时机,不解决这些问题将持续拖累新功能开发效率和系统可靠性。
## What Changes
- **补全 API 文档生成器**`cmd/api/docs.go``cmd/gendocs/main.go` 注册缺失的 39 个 Handler使文档覆盖率达到 100%
- **实现支付动态配置加载**`order/service.go``recharge/service.go` 中 3 处 TODO`payment_config_id` 动态加载支付配置,替代全局单例 `s.wechatPayment`
- **提取轮询状态常量**:将 `polling_manual_trigger``manual_trigger_service``polling_manual_trigger_store``alert_service` 等文件中 10+ 处硬编码字符串(`"pending"``"completed"``"cancelled"` 等)提取到 `pkg/constants/`
- **删除废弃模板代码**`internal/task/sync.go` 是从未被入队的模板代码(轮询系统已实现真正的同步逻辑),连同 `pkg/constants/constants.go` 中的 `TaskTypeDataSync` 常量一并删除
- **清理废弃常量别名**`pkg/constants/wallet.go` 中 15 个已标注 `Deprecated` 的常量别名(`WalletTypeMain``WalletResourceType*``Card*` 前缀等),全局替换引用后删除
- **删除废弃 DTO 和方法**:确认无引用后删除 `DeviceBundle``DeviceBundleCard``AllocatedDevice` 三个 DTO 类型,以及 `CreateLegacy()``CheckAndStopCard()` 两个废弃方法
- **删除 Model 废弃字段并迁移**`iot_card.go``device.go` 中的 `FirstCommissionPaid``AccumulatedRecharge` 字段(已被 `*BySeriesJSON` 替代),删除 Model 定义并创建数据库迁移删除对应列
- **清理空文件和注释代码**:删除 `internal/routes/recharge.go` 空文件;删除 `pkg/database/postgres.go` 中注释掉的 `AutoMigrate()` 代码块;保留 `client_order/service.go` 中的实名认证检查注释(业务意图未确定)
- **批量补全 DTO `_name` 字段**122 个 Response DTO 中 int 类型状态字段缺少对应的 `_name`/`_text` 文字字段,补全字段定义和 Service 层赋值逻辑
- **清理未使用常量和错误码**:删除 `CodeExceedLimit` 错误码;为 `pkg/constants/iot.go` 中约 22 个未引用的预留常量添加"预留用于未来功能"注释
- **数据库迁移文件合并为生产基线**:将开发阶段积累的 114 个迁移文件000000~000113归档到 `migrations/archive/`,生成两个生产就绪的迁移文件:
- `000114_squash_baseline`:从当前数据库 schema 导出的完整建表 SQL一条命令完成全量建库
- `000115_init_data`:初始化数据(轮询系统预置配置 + 历史订单 `purchase_role` 回填,均幂等)
- 配套测试环境重置脚本 `scripts/reset_db.sh`
## Capabilities
### New Capabilities
- `payment-dynamic-config`:支付配置动态加载能力——订单和充值流程从 `payment_config_id` 动态加载对应的微信支付配置,支持多商户场景
- `polling-status-constants`:轮询触发日志状态常量——将分散的魔法字符串统一到 `pkg/constants/` 中,消除硬编码
- `migration-baseline`:生产就绪数据库迁移基线——将 114 个开发期迁移合并为 2 个生产基线迁移,支持一条命令完成全量建库与数据初始化
### Modified Capabilities
- `api-doc-coverage`API 文档完整性——docs.go/gendocs 补全所有 Handler 注册,规范要求接口必须出现在 OpenAPI 文档中
- `dto-name-fields`Response DTO 规范——补全 int 状态字段对应的 `_name`/`_text` 文字字段,满足项目 DTO 规范
## Impact
- **影响文件**`cmd/api/docs.go``cmd/gendocs/main.go``internal/service/order/service.go``internal/service/recharge/service.go``pkg/constants/`wallet.go、constants.go、iot.go 等)、`pkg/errors/codes.go``internal/model/iot_card.go``internal/model/device.go``internal/model/dto/` 下多个文件、`internal/task/sync.go``internal/routes/recharge.go``pkg/database/postgres.go``pkg/queue/handler.go`
- **数据库变更**
- 新增 `000114_squash_baseline.up/down.sql`(完整 schema 基线)
- 新增 `000115_init_data.up/down.sql`(初始化数据)
- 新增 `000116_remove_legacy_commission_fields.up/down.sql`(删除 `first_commission_paid``accumulated_recharge` 列)
- 归档 000000~000113 至 `migrations/archive/`
- **API 变更**:无(均为内部清理,不影响 API 契约)
- **破坏性变更**:无(生产环境首次部署,不存在历史数据迁移问题)
- **依赖变更**:无新增依赖
- **环境影响**:测试环境需执行 `./scripts/reset_db.sh` 重置为新基线(旧的 000000~000113 迁移历史将被清空)

View File

@@ -0,0 +1,45 @@
# API 文档完整性规范
## MODIFIED Requirements
### Requirement: OpenAPI 文档 100% 覆盖所有路由接口
系统的 OpenAPI 文档应包含所有已注册的 HTTP 路由接口,覆盖率达到 100%。
#### Scenario: 文档注册所有 Handler
- **WHEN** 系统启动或生成 OpenAPI 文档
- **THEN** `cmd/api/docs.go` 中的 `bootstrap.Handlers` 结构体包含全部 48 个 Handler包括 Account、AdminOrder、AgentRecharge、Asset、AssetWallet 等)
- **THEN** 每个 Handler 对应一个已注册的路由组(如 `/api/admin/accounts``handlers.Account`
- **THEN** 生成的 OpenAPI 文档包含这 48 个 Handler 对应的全部接口
#### Scenario: 新增 Handler 时同步文档生成器
- **WHEN** 开发者在 `internal/router/` 中新增一个 Handler 并注册到路由
- **THEN** 开发者必须同时在 `cmd/api/docs.go``cmd/gendocs/main.go` 中的 `bootstrap.Handlers` 结构体添加该 Handler 字段
- **THEN** 若遗漏,代码审查应拒绝合并(检查清单项:**新增 Handler 时是否同步更新 docs.go/gendocs/main.go**
#### Scenario: OpenAPI 文档校验完整性
- **WHEN** 执行 `go run cmd/gendocs/main.go` 生成 OpenAPI 文档
- **THEN** 文档应包含所有已注册的接口路由
- **THEN** 无"缺失文档"的警告或错误信息
### Requirement: 文档生成器不遗漏 Handler
文档生成器的 `bootstrap.Handlers` 结构体应显式列出所有 Handler避免新增后遗漏。
#### Scenario: 完整的 Handler 清单
- **WHEN** 审阅 `cmd/api/docs.go``bootstrap.Handlers` 结构体定义
- **THEN** 该结构体包含以下字段(至少 48 个,按模块分组):
```go
Account *admin.AccountHandler
AdminOrder *admin.OrderHandler
AgentRecharge *agent.RechargeHandler
Asset *admin.AssetHandler
AssetWallet *admin.AssetWalletHandler
Authorization *admin.AuthorizationHandler
// ... 共 48 个
```
- **THEN** 注释中标注每个 Handler 对应的路由前缀和功能模块

View File

@@ -0,0 +1,83 @@
# Response DTO 规范规范
## MODIFIED Requirements
### Requirement: Response DTO 必须包含状态文字字段
项目所有 Response DTO 中,若包含 int 类型状态字段,必须同时包含对应的 `_name``_text` 文字字段,用于显示该状态的中文描述。
#### Scenario: 账号列表 Response DTO
- **WHEN** API 返回账号列表(`GET /api/admin/accounts`
- **THEN** 响应中每个账号对象包含 `status` 字段int0=禁用1=启用)
- **THEN** 响应中同时包含 `status_name` 字段string"禁用"或"启用"
- **THEN** 前端可直接使用 `status_name` 显示在 UI 上,无需维护单独的状态枚举映射表
#### Scenario: 资产详情 Response DTO
- **WHEN** API 返回单个资产信息(`GET /api/admin/assets/:id`
- **THEN** 响应包含 `status`int`status_name`string
- **WHEN** 资产包含多个状态字段(如 `network_status``activation_status``online_status`
- **THEN** 每个状态字段对应一个文字字段:`network_status_name``activation_status_name``online_status_name`
#### Scenario: 订单详情中的多重状态
- **WHEN** API 返回订单详情(`GET /api/admin/orders/:id`
- **THEN** 订单对象包含 `payment_status`int`payment_status_name`string
- **THEN** 订单对象包含 `commission_status`int`commission_status_name`string
- **THEN** 若订单还有其他 int 类型状态字段,均配有对应的 `_name` 字段
### Requirement: DTO 文字字段命名规则
状态文字字段的命名应遵循统一规则:`{状态字段名}_name``{状态字段名}_text`
#### Scenario: 标准命名
- **WHEN** 定义 DTO 时,状态字段为 `Status`
- **THEN** 文字字段命名为 `StatusName`(推荐)或 `StatusText`
- **WHEN** 状态字段为 `PaymentStatus`
- **THEN** 文字字段命名为 `PaymentStatusName``PaymentStatusText`
#### Scenario: JSON 序列化一致性
- **WHEN** DTO 序列化为 JSON 返回给客户端
- **THEN** 字段名使用 snake_case符合项目 API 规范)
- Go 字段 `Status` → JSON `status`
- Go 字段 `StatusName` → JSON `status_name`
### Requirement: Service 层自动赋值 `_name` 字段
Service 层在构建 Response DTO 时,应自动赋值 `_name`/`_text` 字段,映射状态常量到中文描述。
#### Scenario: 获取账号详情自动赋值
- **WHEN** `AccountService.GetAccount(ctx, accountID)` 被调用
- **THEN** Service 查询数据库获取账号信息
- **THEN** Service 构建 Response DTO自动设置 `StatusName = constants.GetAccountStatusName(account.Status)`
- **THEN** 返回完整的 DTO 给 HandlerHandler 直接序列化响应
#### Scenario: 列表查询批量赋值
- **WHEN** `AccountService.ListAccounts(ctx, query)` 被调用
- **THEN** Service 查询数据库获取账号列表
- **THEN** Service 遍历每个账号,批量赋值 `StatusName` 字段
- **THEN** 返回完整列表
### Requirement: 常量映射函数
`pkg/constants/` 中为每个业务模块定义 `Get{Module}StatusName(status int) string` 函数,用于映射状态值到中文描述。
#### Scenario: 账号状态映射函数
- **WHEN** Service 层需要获取账号状态的中文描述
- **THEN** 调用 `constants.GetAccountStatusName(status)`
- **THEN** 函数返回:
-`status == 0`,返回 `"禁用"`
-`status == 1`,返回 `"启用"`
- 若状态值未知,返回 `"未知"`(不返回空字符串)
#### Scenario: 订单支付状态映射函数
- **WHEN** Service 层需要获取订单支付状态描述
- **THEN** 调用 `constants.GetOrderPaymentStatusName(status)`
- **THEN** 函数返回对应的中文(如 "待支付"、"已支付"、"已完成" 等)

View File

@@ -0,0 +1,69 @@
# 支付配置动态加载能力规范
## ADDED Requirements
### Requirement: 从支付配置 ID 动态加载支付实例
系统在处理支付验签(订单支付回调、充值确认等)时,应根据订单/充值记录中的 `payment_config_id` 字段动态加载对应的支付配置,而不是使用全局单例 `s.wechatPayment`
#### Scenario: 订单支付回调验签
- **WHEN** 微信支付回调到达 `/api/callback/wechat`,系统解析回调中的商户号和订单数据
- **THEN** 系统根据订单表中的 `payment_config_id` 从 RedisTTL 1h或数据库加载对应的支付配置
- **THEN** 系统使用该配置的私钥和证书验签回调数据
- **THEN** 若配置不存在或当前用户无权限访问该配置,返回 `{code: 1103, msg: "支付配置不存在或无权限"}`
#### Scenario: 充值订单确认支付
- **WHEN** 代理用户在充值页面点击"确认支付",提交 `recharge_order_id``amount`
- **THEN** 系统根据充值订单表中的 `payment_config_id` 动态加载支付配置
- **THEN** 系统调用该配置对应的支付 SDK 创建预支付单(微信 JSAPI 或 H5
- **THEN** 若配置无效或超配额,返回 `{code: 1103, msg: "支付配置无效,请联系商户"}`
### Requirement: 支付配置 Redis 缓存
系统应缓存支付配置到 Redis减少数据库查询。
#### Scenario: 首次加载配置
- **WHEN** 调用 `PaymentConfigLoader.LoadConfig(ctx, configID)` 且 Redis 中不存在该配置
- **THEN** 系统从数据库查询配置,存入 Rediskey: `payment:config:{configID}`TTL: 1 小时)
- **THEN** 返回加载的配置对象
#### Scenario: 配置缓存命中
- **WHEN** 调用 `PaymentConfigLoader.LoadConfig(ctx, configID)` 且 Redis 中存在该配置
- **THEN** 系统直接返回 Redis 中缓存的配置
- **THEN** 不查询数据库
#### Scenario: 配置变更后清除缓存
- **WHEN** 支付配置被修改(通过管理后台)
- **THEN** 系统主动删除 Redis 中的该配置缓存(`DEL payment:config:{configID}`
- **THEN** 下次加载时重新从数据库读取最新配置
### Requirement: 支付配置访问控制
系统在加载支付配置时,根据调用场景采用不同的校验策略:
> **场景分类说明**
> - **回调场景**:微信支付回调到达 `/api/callback/wechat`,请求来自微信服务器,无登录态,无用户身份上下文
> - **用户操作场景**:代理用户在前端主动发起的支付相关操作(如创建充值单、查询支付配置等),有完整的登录态和用户上下文
#### Scenario: 回调场景 — 商户号一致性校验
- **WHEN** 微信支付回调到达,系统解析回调中的商户号(`mchid`
- **THEN** 系统根据订单的 `payment_config_id` 加载配置,比较配置中存储的商户号与回调携带的商户号是否一致
- **THEN** 若不一致,记录告警日志并拒绝处理,返回非 2xx 状态码(微信会重试)
- **NOTE** 此场景**不做用户身份鉴权**,无"代理 A/B"概念,只做商户号匹配验证
#### Scenario: 用户操作场景 — 归属权限校验
- **WHEN** 代理用户在前端主动操作(如创建充值单)需加载支付配置
- **THEN** 系统检查该配置的归属(`shop_id``enterprise_id`)与当前登录用户是否匹配
- **THEN** 若当前用户无权访问该配置,返回 `{code: 403, msg: "无权限访问该支付配置"}`
#### Scenario: 平台用户无限制访问
- **WHEN** 平台管理员的操作需要加载任意支付配置
- **THEN** 系统跳过归属权限检查,允许访问所有配置(仅限用户操作场景)

View File

@@ -0,0 +1,44 @@
# 轮询触发日志状态常量规范
## ADDED Requirements
### Requirement: 轮询手动触发日志状态常量
系统应在 `pkg/constants/polling.go` 中定义轮询手动触发日志的四种状态常量,避免硬编码字符串。
**常量定义**
- `PollingManualTriggerStatusPending = "pending"`
- `PollingManualTriggerStatusProcessing = "processing"`
- `PollingManualTriggerStatusCompleted = "completed"`
- `PollingManualTriggerStatusCancelled = "cancelled"`
#### Scenario: 轮询触发日志记录使用常量
- **WHEN** 系统记录轮询手动触发日志(插入、更新状态)
- **THEN** 系统使用 `constants.PollingManualTriggerStatusPending` 等常量,而不是直接写字符串 `"pending"`
#### Scenario: 轮询触发日志查询使用常量
- **WHEN** 系统查询轮询日志(按状态筛选、状态转移判断等)
- **THEN** 系统使用常量进行比较,而不是硬编码 `status == "pending"`
#### Scenario: 常量修改时自动重构
- **WHEN** 业务要求修改某个状态值(如 `"pending"``"awaiting"`
- **THEN** 开发者修改 `pkg/constants/polling.go` 中的常量定义
- **THEN** IDE 自动检测所有使用该常量的代码,支持一键重构替换
- **THEN** 无需手动搜索和替换散落在各文件中的硬编码字符串
### Requirement: 轮询触发日志字段描述
轮询手动触发日志模型(`tb_polling_manual_trigger_log`)应包含 `status` 字段,并在 DTO 中加入 `status_name` 文字字段。
#### Scenario: 查询轮询触发日志返回状态文本
- **WHEN** API 返回轮询手动触发日志列表(`GET /api/admin/polling/manual-triggers`
- **THEN** 响应中的 `status` 字段int对应状态常量值
- **THEN** 响应中的 `status_name` 字段string显示该状态的中文描述
- `"pending"``"待处理"`
- `"processing"``"处理中"`
- `"completed"``"已完成"`
- `"cancelled"``"已取消"`

View File

@@ -0,0 +1,435 @@
# 技术债务清理实现任务清单
## 0. 数据库迁移文件合并为生产基线(优先执行)
- [ ] 0.1 确认当前数据库 schema 完整可用
- 在本地执行 `go run cmd/api/main.go`,确认所有接口正常启动
- 验证:服务启动无错误
- [ ] 0.2 使用 `pg_dump` 生成当前完整 schema仅 DDL不含数据
- 命令:`pg_dump --schema-only --no-owner --no-acl -d junhong_cmp $DB_DSN > migrations/000114_squash_baseline.up.sql`
- 检查生成的 SQL确认包含所有表tb_account、tb_iot_card、tb_device、tb_order 等)、所有索引
- 确认 SQL 中无外键约束(项目禁止)、无 GORM 关联标签
- 为每张表添加 `CREATE TABLE IF NOT EXISTS` 保护(替换 `CREATE TABLE`
- 验证SQL 文件语法正确,能在全新数据库上执行成功
- [ ] 0.3 编写 `migrations/000114_squash_baseline.down.sql`DROP 所有表)
- 按依赖顺序(子表先删、主表后删)逐一 DROP TABLE
- 使用 `DROP TABLE IF EXISTS` 保护
- 验证:`.down.sql` 在已建库的数据库上能完整回滚(所有表被删除)
- [ ] 0.4 创建 `migrations/000115_init_data.up.sql`(初始化数据)
- 合并以下内容:
1. **轮询配置初始数据**(原 `000104_polling_config_data.up.sql` 内容)
2. **历史订单 purchase_role 回填**(原 `backfill_order_purchase_role.sql` 内容)
- 确认所有 INSERT 使用 `ON CONFLICT DO NOTHING` 保护(幂等性)
- 确认 UPDATE 语句带 `WHERE xxx IS NULL` 条件(幂等性)
- 验证:在空数据库(已跑完 000114上执行 000115 无报错,数据正确
- [ ] 0.5 创建 `migrations/000115_init_data.down.sql`(回滚初始数据)
- DELETE 轮询配置中由 000115 插入的行(按 `config_name``description` 标识)
- purchase_role 回填不需要 rollbackDOWN 时留空注释说明原因即可)
- 验证:执行后轮询初始配置被清除
- [ ] 0.6 归档旧迁移文件
- 创建 `migrations/archive/` 目录
-`000000` ~ `000113` 全部移入 `migrations/archive/`(包含 `.up.sql``.down.sql`
- 将游离文件 `backfill_order_purchase_role.sql` 也移入 `migrations/archive/`
- 验证:`migrations/` 目录下只剩 `000114``000115`(以及后续 `000116` 废弃字段迁移)
- [ ] 0.7 编写测试环境重置脚本 `scripts/reset_db.sh`
```bash
#!/bin/bash
# 重置数据库到干净状态(仅用于开发/测试环境)
DB_NAME="${JUNHONG_DATABASE_DBNAME:-junhong_cmp}"
DB_DSN="postgres://..."
echo "警告:即将清空数据库 $DB_NAME5 秒后继续..."
sleep 5
psql -c "DROP DATABASE IF EXISTS $DB_NAME;"
psql -c "CREATE DATABASE $DB_NAME;"
migrate -path migrations -database "$DB_DSN" up
echo "数据库重置完成"
```
- 验证:脚本可执行,在测试环境运行后数据库从 0 恢复到完整状态
- [ ] 0.8 在全新数据库上验证 migrate up 完整链路
- 创建临时空数据库
- 执行 `migrate -path migrations -database "$DB_DSN" up`
- 确认顺序执行 000114 → 000115→ 000116 在任务 5 完成后)全部成功
- 检查表结构与旧测试环境一致关键表tb_order、tb_iot_card、tb_device、tb_agent_wallet 等)
- 验证migrate up 无报错,表结构正确
- [ ] 0.9 重置测试环境数据库,切换到新基线
- 与团队确认测试环境可以重置
- 执行 `./scripts/reset_db.sh`
- 确认服务重新启动后所有接口正常
- 验证测试环境运行正常migrate status 显示 `000115` 为最新已应用迁移
---
## 1. 支付配置动态加载(三个 TODO 点)
- [ ] 1.1 在 `pkg/constants/redis.go` 中新增支付配置 Redis Key 生成函数
- 新增函数:`RedisPaymentConfigKey(configID uint) string`,返回格式 `payment:config:{configID}`
- 遵循项目规范:所有 Redis Key 必须通过函数生成,禁止硬编码字符串
- 验证:编译通过,函数签名符合项目现有 `Redis*Key` 命名规范
- [ ] 1.2 确认现有 `pkg/payment/` 包中的 `Payment` 接口/类型定义
- 查阅 `pkg/payment/` 目录,确认是否已存在支付接口(如 `WechatPayment` 等)
- 若已存在统一接口,`LoadConfig` 返回该接口类型;若不存在,在此步骤新建 `Payment` 接口
- 验证:`LoadConfig` 的返回类型有明确的定义来源,无模糊引用
- [ ] 1.3 创建 `pkg/payment/loader.go` 文件,定义 `PaymentConfigLoader` 接口和实现
- 接口包含 `LoadConfig(ctx context.Context, configID uint) (Payment, error)` 方法
- 实现中使用 `constants.RedisPaymentConfigKey(configID)` 作为缓存 key禁止硬编码
- 实现包含 Redis 缓存逻辑TTL 1h
- **权限检查说明**:仅在用户主动操作(创建充值单等)时做权限校验;支付回调场景(`/api/callback/wechat`)无登录态,校验逻辑为"回调商户号与配置商户号一致",不做用户身份鉴权
- 验证:编译通过,无语法错误
- [ ] 1.4 修改 `internal/service/order/service.go`,在两处 TODO行 2254、2310实现动态加载
- 注入 `paymentLoader` 依赖
- 替换 `s.wechatPayment` 为 `s.paymentLoader.LoadConfig(ctx, order.PaymentConfigID)`
- 添加错误处理:若配置不存在返回 `errors.New(errors.CodePaymentConfigNotFound)`
- 验证:编译通过,`go vet` 无报告
- [ ] 1.5 修改 `internal/service/recharge/service.go`,在 TODO行 271实现动态加载
- 注入 `paymentLoader` 依赖
- 替换硬编码为 `s.paymentLoader.LoadConfig(ctx, rechargeOrder.PaymentConfigID)`
- 验证:编译通过,`go vet` 无报告
- [ ] 1.7 运行 `go build ./cmd/api ./cmd/worker` 确认编译通过,并通过 PostgreSQL MCP 手动验证支付逻辑
- 执行 `go vet ./internal/service/order/ ./internal/service/recharge/` 静态分析
- 使用 curl 或 Postman 手动触发支付回调,确认验签逻辑正常
- 验证编译通过vet 无报告,手动验签流程无报错
---
## 2. API 文档生成器补全39 个缺失 Handler
- [ ] 2.1 修改 `cmd/api/docs.go`,在 `bootstrap.Handlers` 结构体中注册所有 48 个 Handler
- 按模块分组注册admin、agent、h5 等)
- 每个 Handler 字段添加注释说明对应的路由前缀
- 完整列表Account、AdminOrder、AgentRecharge、Asset、AssetAllocationRecord、AssetWallet、Auth、Authorization、Carrier、CommissionWithdrawal、CommissionWithdrawalSetting、Device、DeviceImport、Enterprise、EnterpriseCard、EnterpriseDevice、IotCard、IotCardImport、Package、PackageSeries、PackageUsage、PaymentCallback、Permission、PersonalCustomer、PollingAlert、PollingCleanup、PollingConcurrency、PollingConfig、PollingManualTrigger、PollingMonitoring、Refund、Role、Shop、ShopCommission、ShopPackageBatchAllocation、ShopPackageBatchPricing、ShopRole、ShopSeriesGrant、Storage、WechatConfig
- 验证:代码可编译
- [ ] 2.2 修改 `cmd/gendocs/main.go`,在 `bootstrap.Handlers` 结构体中同样注册所有 48 个 Handler
- 保持与 docs.go 中的结构一致
- 验证:代码可编译
- [ ] 2.3 运行 `go run cmd/gendocs/main.go` 生成 OpenAPI 文档,验证包含所有 48 个接口路由
- 检查生成的文档中是否有所有接口的 path、method、parameters、responses
- 验证:无"缺失 Handler"的警告
- [ ] 2.4 人工核查生成的 OpenAPI 文档中接口数量与路由注册数量一致
- 统计 `internal/router/` 下实际注册的路由数,与文档中的 path 条目数对比
- 验证:文档中接口数量 ≥ 48无缺失路由
---
## 3. 轮询状态常量提取10+ 处硬编码)
- [ ] 3.1 在 `pkg/constants/polling.go` 中新增轮询手动触发日志状态常量
```go
const (
PollingManualTriggerStatusPending = "pending"
PollingManualTriggerStatusProcessing = "processing"
PollingManualTriggerStatusCompleted = "completed"
PollingManualTriggerStatusCancelled = "cancelled"
)
```
- 验证:编译通过
- [ ] 3.2 修改 `internal/handler/admin/polling_manual_trigger.go`,将硬编码状态字符串替换为常量
- 搜索并替换所有 `"pending"`、`"completed"`、`"cancelled"` 为对应常量
- 验证:编译通过,`go vet ./internal/handler/admin/...` 无报告
- [ ] 3.3 修改 `internal/service/polling/manual_trigger_service.go`,替换硬编码状态字符串
- 替换所有 `"pending"`、`"processing"`、`"completed"`、`"cancelled"` 为常量
- 验证:编译通过,`go vet ./internal/service/polling/...` 无报告
- [ ] 3.4 修改 `internal/store/postgres/polling_manual_trigger_store.go`,替换硬编码字符串
- 替换状态比较和更新操作中的硬编码
- 验证:编译通过
- [ ] 3.5 修改 `internal/service/polling/alert_service.go`,替换 `NotificationStatus` 中的硬编码
- 将 `"pending"` 替换为常量
- 验证:编译通过,`go vet ./internal/service/polling/...` 无报告,通过 PostgreSQL MCP 查询告警日志确认状态值正确
- [ ] 3.6 运行 `grep -r '"pending"\|"completed"\|"cancelled"' internal/` 确认轮询相关文件中无剩余硬编码
- 验证:无轮询相关的硬编码字符串
---
## 4. 废弃代码清理15 个别名 + 3 个 DTO + 2 个方法)
- [ ] 4.1 删除 `internal/task/sync.go` 整个文件
- 在 `pkg/queue/handler.go` 中删除 `syncHandler` 的注册代码(行 61-67
- 在 `pkg/constants/constants.go` 中删除 `TaskTypeDataSync` 常量定义
- 验证:`grep -r "TaskTypeDataSync\|SyncHandler\|HandleDataSync" internal/ pkg/` 无结果
- [ ] 4.2 全局搜索 `pkg/constants/wallet.go` 中的 15 个废弃别名,确认引用情况
```
WalletTypeMain, WalletTypeCommission,
WalletResourceType*,
WalletStatus*,
TransactionType*,
RechargeOrderPrefix, RechargeMinAmount, RechargeMaxAmount,
Card* 前缀别名9 个)
```
- 运行 `grep -r "WalletTypeMain\|WalletTypeCommission\|WalletResourceType" internal/ pkg/` 统计引用次数
- 验证:若有引用则记录文件和行号,后续逐个替换
- [ ] 4.3 对于每个有引用的废弃别名,替换为新常量
- 使用 IDE 的重构工具或 `sed` 批量替换
- 示例:`WalletTypeMain` → `AgentWalletTypeMain`
- 验证:编译通过,无引用残留
- [ ] 4.4 删除 `pkg/constants/wallet.go` 中所有 Deprecated 别名定义(共 15 个)
- 删除注释块和别名定义
- 验证:编译通过,运行 `grep -c "Deprecated" pkg/constants/wallet.go` 返回 0
- [ ] 4.5 删除 `internal/model/dto/enterprise_card_authorization_dto.go` 中的 3 个废弃 DTO 类型
- `DeviceBundle`、`DeviceBundleCard`、`AllocatedDevice`
- 验证:全局搜索确认无引用,编译通过
- [ ] 4.6 删除 `internal/service/order/service.go` 中的 `CreateLegacy()` 方法(行 113 及方法体)
- 全局搜索确认无调用点
- 验证:编译通过
- [ ] 4.7 删除 `internal/service/iot_card/stop_resume_service.go` 中的 `CheckAndStopCard()` 方法(行 330
- 全局搜索确认无调用点
- 验证:编译通过
- [ ] 4.8 运行 `go build ./cmd/api ./cmd/worker` 确认删除未引入编译错误
- 执行 `go vet ./internal/model/dto/ ./internal/service/order/ ./internal/service/iot_card/` 静态分析
- 验证编译通过vet 无报告
---
## 5. Model 废弃字段删除与数据库迁移
- [ ] 5.1 从 `internal/model/iot_card.go` 中删除 `FirstCommissionPaid` 和 `AccumulatedRecharge` 字段定义
- 验证:编译通过
- [ ] 5.2 从 `internal/model/device.go` 中删除 `FirstCommissionPaid` 和 `AccumulatedRecharge` 字段定义
- 验证:编译通过
- [ ] 5.3 创建数据库迁移文件 `migrations/000116_remove_legacy_commission_fields.up.sql`
```sql
ALTER TABLE tb_iot_card DROP COLUMN IF EXISTS first_commission_paid;
ALTER TABLE tb_iot_card DROP COLUMN IF EXISTS accumulated_recharge;
ALTER TABLE tb_device DROP COLUMN IF EXISTS first_commission_paid;
ALTER TABLE tb_device DROP COLUMN IF EXISTS accumulated_recharge;
```
- 验证:语法正确,在测试数据库上运行成功
- [ ] 5.4 创建回滚迁移文件 `migrations/000116_remove_legacy_commission_fields.down.sql`
- 添加这四个列回来,使用原始类型(确认类型后填入)
- 验证:语法正确
- [ ] 5.5 在测试环境执行迁移,确认字段被删除,表结构正确
- 运行 `migrate -path migrations -database "postgres://..." up`
- 通过 PostgreSQL MCP 执行以下 SQL 确认字段已不存在:
```sql
SELECT column_name FROM information_schema.columns
WHERE table_name IN ('tb_iot_card', 'tb_device')
AND column_name IN ('first_commission_paid', 'accumulated_recharge');
-- 期望0 行返回
```
- 验证:迁移成功,查询结果为空
- [ ] 5.6 通过 PostgreSQL MCP 查询 `tb_iot_card` 和 `tb_device` 表结构确认字段已删除
- 执行 `go build ./cmd/api ./cmd/worker` 确认编译通过
- 验证:`information_schema.columns` 查询结果中不含 `first_commission_paid`、`accumulated_recharge`
---
## 6. DTO `_name` 字段补全122 处)
> **分批说明**122 处分布在多个模块建议按模块分批提交每批独立编译验证避免大批量修改产生难以排查的冲突。推荐顺序Account → Asset → Order → Commission → IotCard/Device → 其他模块。
- [ ] 6.1 遍历 `internal/model/dto/` 中的所有 DTO 文件,统计所有 int 类型状态字段
- 使用 `grep -rn "int.*\`json:" internal/model/dto/` 列出候选字段
- 过滤出缺少配套 `_name`/`_text` 字段的条目,生成模块维度的清单
- 验证:清单按模块分组,总计不少于 122 条
- [ ] 6.2 **Account 模块**:补全 DTO `_name` 字段 + 常量映射函数 + Service 层赋值
- 在 `internal/model/dto/account_dto.go` 中为每个 int 状态字段新增 `_name` 字符串字段
- 在 `pkg/constants/account.go`(或对应文件)中新增 `GetAccountStatusName(status int) string`
- 在 `internal/service/account/service.go` 中所有构建 Response DTO 的地方赋值 `_name` 字段
- 验证:`go build ./cmd/api` 通过;`curl /api/admin/accounts/1` 响应包含 `status_name`
- [ ] 6.3 **Asset 模块**:补全 DTO `_name` 字段 + 常量映射函数 + Service 层赋值
- 涉及文件:`internal/model/dto/asset_dto.go`、`internal/service/asset/service.go`
- 为 `status`、`network_status`、`activation_status`、`online_status` 等多状态字段各自补全
- 验证:编译通过;手动调用资产详情接口确认返回 `*_name` 字段
- [ ] 6.4 **Order 模块**:补全 DTO `_name` 字段 + 常量映射函数 + Service 层赋值
- 涉及文件:`internal/model/dto/order_dto.go`、`internal/service/order/service.go`
- 覆盖 `payment_status`、`commission_status`、`order_status` 等字段
- 验证:编译通过;手动调用订单详情接口确认返回 `*_name` 字段
- [ ] 6.5 **Commission 模块**:补全 DTO `_name` 字段 + 常量映射函数 + Service 层赋值
- 涉及文件commission 相关 DTO 和 Service
- 验证:编译通过,手动验证分佣列表接口响应
- [ ] 6.6 **IotCard / Device 模块**:补全 DTO `_name` 字段 + 常量映射函数 + Service 层赋值
- 涉及文件:`internal/model/dto/iot_card_dto.go`、`internal/model/dto/device_dto.go` 等
- 验证:编译通过,手动验证相关接口响应
- [ ] 6.7 **剩余模块**Recharge、Wallet、Package、Shop 等):按同样模式批量补全
- 以 6.1 生成的清单为依据,逐模块完成,每模块补完即编译验证一次
- 验证:所有模块编译通过
- [ ] 6.8 全量编译与静态分析
- 运行 `go build ./cmd/api ./cmd/worker` 和 `go vet ./internal/service/ ./internal/handler/`
- 验证编译通过vet 无报告
- [ ] 6.9 使用 curl/Postman 抽查各模块代表性接口,确认 `_name` 字段有值且内容正确
- 示例:`GET /api/admin/accounts/1` 返回 `status_name``GET /api/admin/orders/1` 返回 `payment_status_name`
- 验证:响应符合规范,`_name` 字段非空且为正确中文描述
---
## 7. 未使用常量和错误码清理
- [ ] 7.1 删除 `pkg/errors/codes.go` 中的 `CodeExceedLimit` 常量和对应的错误消息映射
- 搜索确认 `CodeExceedLimit` 无任何引用
- 验证:编译通过
- [ ] 7.2 为 `pkg/constants/iot.go` 中约 22 个未引用的预留常量添加注释
- Replacement/Merchant/Approval/Ladder/CardType 系列
- 在每个常量上方添加:`// [预留] 用于未来 XXX 功能,见需求文档 YYY`
- 示例:`// [预留] 用于设备换卡功能,见产品规划 2025Q2`
- 验证:注释清晰,预留用途明确
- [ ] 7.3 运行 `go build ./cmd/api ./cmd/worker` 和 `go vet ./pkg/errors/ ./pkg/constants/` 确认清理无破坏
- 验证编译通过vet 无报告
---
## 8. 删除空文件和注释代码
- [ ] 8.1 删除 `internal/routes/recharge.go` 空文件
- 验证:`ls -la internal/routes/recharge.go` 返回 File not found
- [ ] 8.2 删除 `pkg/database/postgres.go` 中的 AutoMigrate 注释块(行 90-95
- 验证:编译通过
- [ ] 8.3 保留 `internal/service/client_order/service.go` 中的实名认证检查注释(行 141-142
- 在注释上方添加:`// [待确认] 业务需要实名认证检查吗?见 ISSUE #XXX`
- 验证:编译通过
---
## 9. 空文件清理和编译验证
- [ ] 9.1 运行 `go mod tidy` 确认依赖无变化
- 验证:`git diff go.mod go.sum` 无内容变化
- [ ] 9.2 运行 `go build ./cmd/api` 和 `go build ./cmd/worker` 确认编译通过
- 验证:二进制文件生成成功
- [ ] 9.3 运行 `go vet ./...` 进行静态分析
- 验证:无 vet 错误
- [ ] 9.4 运行 `gofmt -l ./internal ./pkg` 检查代码格式
- 若有格式问题,运行 `gofmt -w ./internal ./pkg` 修复
- 验证:无格式问题
---
## 10. 全面测试与集成验证
- [ ] 10.1 运行 `go build ./...` 确认全量编译通过,运行 `go vet ./...` 全量静态分析
- 验证编译无错误vet 无报告
- [ ] 10.2 在测试环境启动 API 服务,运行完整的业务流程测试
- 测试支付流程(订单支付 → 回调 → 验签)
- 测试轮询系统(手动触发 → 日志记录 → 状态更新)
- 测试各模块的 API 响应中是否包含 `_name` 字段
- 验证:所有流程正常,无错误
- [ ] 10.3 运行 `go vet ./internal/... ./pkg/...` 确认无静态分析问题
- 验证vet 无报告,输出为空
- [ ] 10.4 验证数据库迁移(如使用 golang-migrate
- 在测试环境运行迁移:`migrate -path migrations -database "..." up`
- 验证所有迁移成功执行,表结构正确
- 验证:迁移完成,无错误
- [ ] 10.5 检查 Redis 缓存功能(支付配置加载)
- 启动 Redis验证支付配置加载时是否正确使用缓存
- 修改支付配置后验证缓存清除和重新加载
- 验证:缓存功能正常
- [ ] 10.6 生成最终的 OpenAPI 文档并审查
- 运行 `go run cmd/gendocs/main.go`
- 检查生成的文档是否包含全部 48 个接口
- 验证:文档完整无误
---
## 11. 代码审查与合并前检查
- [ ] 11.1 检查 commit 历史,确保每个 commit 的 message 清晰且符合规范
- commit message 格式:`[模块] 功能描述` 或 `fix: 修复内容`
- 验证commit 历史清晰
- [ ] 11.2 运行 `git diff main...HEAD` 审查所有代码变更
- 确认无意外的格式改动或无关的修改
- 验证diff 清晰,仅包含计划内的改动
- [ ] 11.3 向团队成员申请代码审查,处理审查意见
- 验证:至少一人 approve
- [ ] 11.4 确认所有 CI/CD 检查通过(若项目使用)
- 验证:绿色勾号
---
## 12. 部署与监控
- [ ] 12.1 在预发环境部署最新的代码和数据库迁移
- 验证:部署成功,服务正常启动
- [ ] 12.2 在预发环境执行烟测用例,验证关键功能
- 支付流程、轮询系统、账号管理
- 验证:功能正常
- [ ] 12.3 灰度发布到生产环境10% → 50% → 100%
- 逐步增加流量比例,监控错误率和性能指标
- 验证:无异常告警
- [ ] 12.4 监控生产环境,查看日志确认无错误
- 特别关注支付验签相关的日志
- 验证:`grep -i "error\|failed" logs/app.log` 无相关错误
---
## 13. 最终验收与文档更新
- [ ] 13.1 生成变更总结文档,列出所有删除、添加、修改的代码、文件、字段
- 验证:文档完整准确
- [ ] 13.2 更新项目 README 或 CHANGELOG标注此次技术债务清理的内容
- 验证:文档同步
- [ ] 13.3 向团队分享清理成果和改进点
- 验证:信息传达完整
---
## 完成标准
**所有上述任务完成后,技术债务清理工作才算完成。具体标准**
1. ✅ **编译通过**`go build ./cmd/api ./cmd/worker` 无错误
2. ✅ **测试全 PASS**`go test -v ./...` 所有测试通过
3.**文档完整**OpenAPI 文档覆盖 100%48/48 Handler所有接口可查阅
4.**代码规范**:无 vet 错误,代码格式统一
5.**功能正常**:支付、轮询、账号管理等核心模块功能无破坏
6.**数据一致**:数据库迁移成功,废弃字段已删除
7.**生产稳定**:灰度部署完成,无生产告警或错误