feat: OpenAPI 契约对齐与框架优化
All checks were successful
构建并部署到测试环境(无 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 个主规范文件

破坏性变更:无
向后兼容:是
This commit is contained in:
2026-01-30 11:40:36 +08:00
parent 1290160728
commit 409a68d60b
88 changed files with 27358 additions and 990 deletions

View File

@@ -10,6 +10,7 @@ import (
"github.com/break/junhong_cmp_fiber/pkg/config"
"github.com/break/junhong_cmp_fiber/pkg/constants"
"github.com/break/junhong_cmp_fiber/pkg/errors"
"github.com/break/junhong_cmp_fiber/pkg/sms"
"github.com/redis/go-redis/v9"
"go.uber.org/zap"
@@ -33,6 +34,12 @@ func NewService(redisClient *redis.Client, smsClient *sms.Client, logger *zap.Lo
// SendCode 发送验证码
func (s *Service) SendCode(ctx context.Context, phone string) error {
// 检查短信服务是否可用
if s.smsClient == nil {
s.logger.Error("短信服务未配置", zap.String("phone", phone))
return errors.New(errors.CodeServiceUnavailable)
}
// 检查发送频率限制
limitKey := constants.RedisVerificationCodeLimitKey(phone)
exists, err := s.redisClient.Exists(ctx, limitKey).Result()
@@ -41,14 +48,14 @@ func (s *Service) SendCode(ctx context.Context, phone string) error {
zap.String("phone", phone),
zap.Error(err),
)
return fmt.Errorf("检查验证码发送频率限制失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "检查验证码发送频率限制失败")
}
if exists > 0 {
s.logger.Warn("验证码发送过于频繁",
zap.String("phone", phone),
)
return fmt.Errorf("验证码发送过于频繁,请稍后再试")
return errors.New(errors.CodeTooManyRequests, "验证码发送过于频繁,请稍后再试")
}
// 生成随机验证码
@@ -58,7 +65,7 @@ func (s *Service) SendCode(ctx context.Context, phone string) error {
zap.String("phone", phone),
zap.Error(err),
)
return fmt.Errorf("生成验证码失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "生成验证码失败")
}
// 构造短信内容
@@ -72,7 +79,7 @@ func (s *Service) SendCode(ctx context.Context, phone string) error {
zap.String("phone", phone),
zap.Error(err),
)
return fmt.Errorf("发送验证码短信失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "发送验证码短信失败")
}
// 存储验证码到 Redis
@@ -83,7 +90,7 @@ func (s *Service) SendCode(ctx context.Context, phone string) error {
zap.String("phone", phone),
zap.Error(err),
)
return fmt.Errorf("存储验证码失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "存储验证码失败")
}
// 设置发送频率限制
@@ -121,14 +128,14 @@ func (s *Service) VerifyCode(ctx context.Context, phone string, code string) err
s.logger.Warn("验证码不存在或已过期",
zap.String("phone", phone),
)
return fmt.Errorf("验证码不存在或已过期")
return errors.New(errors.CodeInvalidParam, "验证码不存在或已过期")
}
if err != nil {
s.logger.Error("获取验证码失败",
zap.String("phone", phone),
zap.Error(err),
)
return fmt.Errorf("获取验证码失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "获取验证码失败")
}
// 验证码比对
@@ -136,7 +143,7 @@ func (s *Service) VerifyCode(ctx context.Context, phone string, code string) err
s.logger.Warn("验证码错误",
zap.String("phone", phone),
)
return fmt.Errorf("验证码错误")
return errors.New(errors.CodeInvalidParam, "验证码错误")
}
// 验证成功,删除验证码(防止重复使用)