|
|
409a68d60b
|
feat: OpenAPI 契约对齐与框架优化
构建并部署到测试环境(无 SSH) / build-and-deploy (push) Successful in 5m45s
主要变更:
1. OpenAPI 文档契约对齐
- 统一错误响应字段名为 msg(非 message)
- 规范 envelope 响应结构(code, msg, data, timestamp)
- 个人客户路由纳入文档体系(使用 Register 机制)
- 新增 BuildDocHandlers() 统一管理 handler 构造
- 确保文档生成的幂等性
2. Service 层错误处理统一
- 全面替换 fmt.Errorf 为 errors.New/Wrap
- 统一错误码使用规范
- Handler 层参数校验不泄露底层细节
- 新增错误码验证集成测试
3. 代码质量提升
- 删除未使用的 Task handler 和路由
- 新增代码规范检查脚本(check-service-errors.sh)
- 新增注释路径一致性检查(check-comment-paths.sh)
- 更新 API 文档生成指南
4. OpenSpec 归档
- 归档 openapi-contract-alignment 变更(63 tasks)
- 归档 service-error-unify-core 变更
- 归档 service-error-unify-support 变更
- 归档 code-cleanup-docs-update 变更
- 归档 handler-validation-security 变更
- 同步 delta specs 到主规范文件
影响范围:
- pkg/openapi: 新增 handlers.go,优化 generator.go
- internal/service/*: 48 个 service 文件错误处理统一
- internal/handler/admin: 优化参数校验错误提示
- internal/routes: 个人客户路由改造,删除 task 路由
- scripts: 新增 3 个代码检查脚本
- docs: 更新 OpenAPI 文档(15750+ 行)
- openspec/specs: 同步 3 个主规范文件
破坏性变更:无
向后兼容:是
|
2026-01-30 11:40:36 +08:00 |
|
|
|
6821e5abcf
|
refactor: 统一错误消息数据源,优化错误码与映射表管理
构建并部署到测试环境(无 SSH) / build-and-deploy (push) Successful in 4m36s
主要改动:
- 改造 errors.New() 和 Wrap() 函数签名为可变参数,优先使用 errorMessages 映射表
- 添加 allErrorCodes 注册表和 init() 启动时校验,确保错误码与映射表一致
- 添加 TestAllCodesHaveMessages 和 TestNoOrphanMessages 测试防止映射表腐化
- 清理 109 处与映射表一致的冗余硬编码(service 层)
- 保留业务特定消息覆盖能力
新增 API 用法:
- errors.New(errors.CodeUnauthorized) // 使用映射表默认消息
- errors.New(errors.CodeNotFound, "提现申请不存在") // 覆盖为自定义消息
|
2026-01-22 18:27:42 +08:00 |
|
|
|
1f71741836
|
完成 Phase 10 质量保证,项目达到生产部署标准
主要变更:
- ✅ 完成所有文档任务(T092-T095a)
* 创建中文 README.md 和项目文档
* 添加限流器使用指南
* 更新快速入门文档
* 添加详细的中文代码注释
- ✅ 完成代码质量任务(T096-T103)
* 通过 gofmt、go vet、golangci-lint 检查
* 修复 17 个 errcheck 问题
* 验证无硬编码 Redis key
* 确保命名规范符合 Go 标准
- ✅ 完成测试任务(T104-T108)
* 58 个测试全部通过
* 总体覆盖率 75.1%(超过 70% 目标)
* 核心模块覆盖率 90%+
- ✅ 完成安全审计任务(T109-T113)
* 修复日志中令牌泄露问题
* 验证 Fail-closed 策略正确实现
* 审查 Redis 连接安全
* 完成依赖项漏洞扫描
- ✅ 完成性能验证任务(T114-T117)
* 令牌验证性能:17.5 μs/op(~58,954 ops/s)
* 响应序列化性能:1.1 μs/op(>1,000,000 ops/s)
* 配置访问性能:0.58 ns/op(接近 CPU 缓存速度)
- ✅ 完成质量关卡任务(T118-T126)
* 所有测试通过
* 代码格式和静态检查通过
* 无 TODO/FIXME 遗留
* 中间件集成验证
* 优雅关闭机制验证
新增文件:
- README.md(中文项目文档)
- docs/rate-limiting.md(限流器指南)
- docs/security-audit-report.md(安全审计报告)
- docs/performance-benchmark-report.md(性能基准报告)
- docs/quality-gate-report.md(质量关卡报告)
- docs/PROJECT-COMPLETION-SUMMARY.md(项目完成总结)
- 基准测试文件(config, response, validator)
安全修复:
- 移除 pkg/validator/token.go 中的敏感日志记录
质量评分:9.6/10(优秀)
项目状态:✅ 已完成,待部署
|
2025-11-11 16:53:05 +08:00 |
|