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

@@ -4,12 +4,12 @@ package personal_customer
import (
"context"
"fmt"
"github.com/break/junhong_cmp_fiber/internal/model"
"github.com/break/junhong_cmp_fiber/internal/service/verification"
"github.com/break/junhong_cmp_fiber/internal/store/postgres"
"github.com/break/junhong_cmp_fiber/pkg/auth"
"github.com/break/junhong_cmp_fiber/pkg/errors"
"go.uber.org/zap"
"gorm.io/gorm"
)
@@ -60,7 +60,7 @@ func (s *Service) LoginByPhone(ctx context.Context, phone string, code string) (
zap.String("phone", phone),
zap.Error(err),
)
return "", nil, fmt.Errorf("验证码验证失败: %w", err)
return "", nil, err
}
// 查找或创建个人客户
@@ -79,7 +79,7 @@ func (s *Service) LoginByPhone(ctx context.Context, phone string, code string) (
zap.String("phone", phone),
zap.Error(err),
)
return "", nil, fmt.Errorf("创建个人客户失败: %w", err)
return "", nil, errors.Wrap(errors.CodeInternalError, err, "创建个人客户失败")
}
// 创建手机号绑定记录
@@ -95,7 +95,7 @@ func (s *Service) LoginByPhone(ctx context.Context, phone string, code string) (
zap.String("phone", phone),
zap.Error(err),
)
return "", nil, fmt.Errorf("查询个人客户失败: %w", err)
return "", nil, errors.Wrap(errors.CodeInternalError, err, "查询个人客户失败")
}
}
@@ -105,7 +105,7 @@ func (s *Service) LoginByPhone(ctx context.Context, phone string, code string) (
zap.Uint("customer_id", customer.ID),
zap.String("phone", phone),
)
return "", nil, fmt.Errorf("账号已被禁用")
return "", nil, errors.New(errors.CodeForbidden, "账号已被禁用")
}
// 生成 Token临时传递 phone后续应该从 Token 中移除 phone 字段)
@@ -116,7 +116,7 @@ func (s *Service) LoginByPhone(ctx context.Context, phone string, code string) (
zap.String("phone", phone),
zap.Error(err),
)
return "", nil, fmt.Errorf("生成 Token 失败: %w", err)
return "", nil, errors.Wrap(errors.CodeInternalError, err, "生成 Token 失败")
}
s.logger.Info("个人客户登录成功",
@@ -136,7 +136,7 @@ func (s *Service) BindWechat(ctx context.Context, customerID uint, wxOpenID, wxU
zap.Uint("customer_id", customerID),
zap.Error(err),
)
return fmt.Errorf("查询个人客户失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "查询个人客户失败")
}
// 更新微信信息
@@ -148,7 +148,7 @@ func (s *Service) BindWechat(ctx context.Context, customerID uint, wxOpenID, wxU
zap.Uint("customer_id", customerID),
zap.Error(err),
)
return fmt.Errorf("更新微信信息失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "更新微信信息失败")
}
s.logger.Info("绑定微信信息成功",
@@ -167,7 +167,7 @@ func (s *Service) UpdateProfile(ctx context.Context, customerID uint, nickname,
zap.Uint("customer_id", customerID),
zap.Error(err),
)
return fmt.Errorf("查询个人客户失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "查询个人客户失败")
}
// 更新资料
@@ -183,7 +183,7 @@ func (s *Service) UpdateProfile(ctx context.Context, customerID uint, nickname,
zap.Uint("customer_id", customerID),
zap.Error(err),
)
return fmt.Errorf("更新个人资料失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "更新个人资料失败")
}
s.logger.Info("更新个人资料成功",
@@ -201,7 +201,7 @@ func (s *Service) GetProfile(ctx context.Context, customerID uint) (*model.Perso
zap.Uint("customer_id", customerID),
zap.Error(err),
)
return nil, fmt.Errorf("查询个人客户失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "查询个人客户失败")
}
return customer, nil
@@ -216,7 +216,7 @@ func (s *Service) GetProfileWithPhone(ctx context.Context, customerID uint) (*mo
zap.Uint("customer_id", customerID),
zap.Error(err),
)
return nil, "", fmt.Errorf("查询个人客户失败: %w", err)
return nil, "", errors.Wrap(errors.CodeInternalError, err, "查询个人客户失败")
}
// 获取主手机号