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

@@ -66,7 +66,7 @@ func (s *Service) Create(ctx context.Context, req *dto.CreateAccountRequest) (*m
// bcrypt 哈希密码
hashedPassword, err := bcrypt.GenerateFromPassword([]byte(req.Password), bcrypt.DefaultCost)
if err != nil {
return nil, fmt.Errorf("密码哈希失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "密码哈希失败")
}
// 创建账号
@@ -81,7 +81,7 @@ func (s *Service) Create(ctx context.Context, req *dto.CreateAccountRequest) (*m
}
if err := s.accountStore.Create(ctx, account); err != nil {
return nil, fmt.Errorf("创建账号失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "创建账号失败")
}
// TODO: 清除店铺的下级 ID 缓存(需要在 Service 层处理)
@@ -97,7 +97,7 @@ func (s *Service) Get(ctx context.Context, id uint) (*model.Account, error) {
if err == gorm.ErrRecordNotFound {
return nil, errors.New(errors.CodeAccountNotFound, "账号不存在")
}
return nil, fmt.Errorf("获取账号失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "获取账号失败")
}
return account, nil
}
@@ -116,7 +116,7 @@ func (s *Service) Update(ctx context.Context, id uint, req *dto.UpdateAccountReq
if err == gorm.ErrRecordNotFound {
return nil, errors.New(errors.CodeAccountNotFound, "账号不存在")
}
return nil, fmt.Errorf("获取账号失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "获取账号失败")
}
// 更新字段
@@ -141,7 +141,7 @@ func (s *Service) Update(ctx context.Context, id uint, req *dto.UpdateAccountReq
if req.Password != nil {
hashedPassword, err := bcrypt.GenerateFromPassword([]byte(*req.Password), bcrypt.DefaultCost)
if err != nil {
return nil, fmt.Errorf("密码哈希失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "密码哈希失败")
}
account.Password = string(hashedPassword)
}
@@ -153,7 +153,7 @@ func (s *Service) Update(ctx context.Context, id uint, req *dto.UpdateAccountReq
account.Updater = currentUserID
if err := s.accountStore.Update(ctx, account); err != nil {
return nil, fmt.Errorf("更新账号失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "更新账号失败")
}
return account, nil
@@ -167,11 +167,11 @@ func (s *Service) Delete(ctx context.Context, id uint) error {
if err == gorm.ErrRecordNotFound {
return errors.New(errors.CodeAccountNotFound, "账号不存在")
}
return fmt.Errorf("获取账号失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "获取账号失败")
}
if err := s.accountStore.Delete(ctx, id); err != nil {
return fmt.Errorf("删除账号失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "删除账号失败")
}
// 账号删除后不需要清理缓存
@@ -223,7 +223,7 @@ func (s *Service) AssignRoles(ctx context.Context, accountID uint, roleIDs []uin
if err == gorm.ErrRecordNotFound {
return nil, errors.New(errors.CodeAccountNotFound, "账号不存在")
}
return nil, fmt.Errorf("获取账号失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "获取账号失败")
}
// 超级管理员禁止分配角色
@@ -234,7 +234,7 @@ func (s *Service) AssignRoles(ctx context.Context, accountID uint, roleIDs []uin
// 空数组:清空所有角色
if len(roleIDs) == 0 {
if err := s.accountRoleStore.DeleteByAccountID(ctx, accountID); err != nil {
return nil, fmt.Errorf("清空账号角色失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "清空账号角色失败")
}
return []*model.AccountRole{}, nil
}
@@ -246,7 +246,7 @@ func (s *Service) AssignRoles(ctx context.Context, accountID uint, roleIDs []uin
existingCount, err := s.accountRoleStore.CountByAccountID(ctx, accountID)
if err != nil {
return nil, fmt.Errorf("统计现有角色数量失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "统计现有角色数量失败")
}
newRoleCount := 0
@@ -267,7 +267,7 @@ func (s *Service) AssignRoles(ctx context.Context, accountID uint, roleIDs []uin
if err == gorm.ErrRecordNotFound {
return nil, errors.New(errors.CodeRoleNotFound, fmt.Sprintf("角色 %d 不存在", roleID))
}
return nil, fmt.Errorf("获取角色失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "获取角色失败")
}
if !constants.IsRoleTypeMatchUserType(role.RoleType, account.UserType) {
@@ -290,7 +290,7 @@ func (s *Service) AssignRoles(ctx context.Context, accountID uint, roleIDs []uin
Updater: currentUserID,
}
if err := s.accountRoleStore.Create(ctx, ar); err != nil {
return nil, fmt.Errorf("创建账号-角色关联失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "创建账号-角色关联失败")
}
ars = append(ars, ar)
}
@@ -306,13 +306,13 @@ func (s *Service) GetRoles(ctx context.Context, accountID uint) ([]*model.Role,
if err == gorm.ErrRecordNotFound {
return nil, errors.New(errors.CodeAccountNotFound, "账号不存在")
}
return nil, fmt.Errorf("获取账号失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "获取账号失败")
}
// 获取角色 ID 列表
roleIDs, err := s.accountRoleStore.GetRoleIDsByAccountID(ctx, accountID)
if err != nil {
return nil, fmt.Errorf("获取账号角色 ID 失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "获取账号角色 ID 失败")
}
if len(roleIDs) == 0 {
@@ -331,12 +331,12 @@ func (s *Service) RemoveRole(ctx context.Context, accountID, roleID uint) error
if err == gorm.ErrRecordNotFound {
return errors.New(errors.CodeAccountNotFound, "账号不存在")
}
return fmt.Errorf("获取账号失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "获取账号失败")
}
// 删除关联
if err := s.accountRoleStore.Delete(ctx, accountID, roleID); err != nil {
return fmt.Errorf("删除账号-角色关联失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "删除账号-角色关联失败")
}
return nil
@@ -360,16 +360,16 @@ func (s *Service) UpdatePassword(ctx context.Context, accountID uint, newPasswor
if err == gorm.ErrRecordNotFound {
return errors.New(errors.CodeAccountNotFound, "账号不存在")
}
return fmt.Errorf("获取账号失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "获取账号失败")
}
hashedPassword, err := bcrypt.GenerateFromPassword([]byte(newPassword), bcrypt.DefaultCost)
if err != nil {
return fmt.Errorf("密码哈希失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "密码哈希失败")
}
if err := s.accountStore.UpdatePassword(ctx, accountID, string(hashedPassword), currentUserID); err != nil {
return fmt.Errorf("更新密码失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "更新密码失败")
}
return nil
@@ -387,11 +387,11 @@ func (s *Service) UpdateStatus(ctx context.Context, accountID uint, status int)
if err == gorm.ErrRecordNotFound {
return errors.New(errors.CodeAccountNotFound, "账号不存在")
}
return fmt.Errorf("获取账号失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "获取账号失败")
}
if err := s.accountStore.UpdateStatus(ctx, accountID, status, currentUserID); err != nil {
return fmt.Errorf("更新状态失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "更新状态失败")
}
return nil
@@ -449,12 +449,12 @@ func (s *Service) CreateSystemAccount(ctx context.Context, account *model.Accoun
hashedPassword, err := bcrypt.GenerateFromPassword([]byte(account.Password), bcrypt.DefaultCost)
if err != nil {
return fmt.Errorf("密码哈希失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "密码哈希失败")
}
account.Password = string(hashedPassword)
if err := s.accountStore.Create(ctx, account); err != nil {
return fmt.Errorf("创建账号失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "创建账号失败")
}
return nil