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

@@ -2,7 +2,6 @@ package shop_series_allocation
import (
"context"
"fmt"
"time"
"github.com/break/junhong_cmp_fiber/internal/model"
@@ -63,7 +62,7 @@ func (s *Service) Create(ctx context.Context, req *dto.CreateShopSeriesAllocatio
if err == gorm.ErrRecordNotFound {
return nil, errors.New(errors.CodeNotFound, "目标店铺不存在")
}
return nil, fmt.Errorf("获取店铺失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "获取店铺失败")
}
isPlatformUser := userType == constants.UserTypeSuperAdmin || userType == constants.UserTypePlatform
@@ -84,13 +83,13 @@ func (s *Service) Create(ctx context.Context, req *dto.CreateShopSeriesAllocatio
if err == gorm.ErrRecordNotFound {
return nil, errors.New(errors.CodeNotFound, "套餐系列不存在")
}
return nil, fmt.Errorf("获取套餐系列失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "获取套餐系列失败")
}
if userType == constants.UserTypeAgent {
myAllocation, err := s.allocationStore.GetByShopAndSeries(ctx, allocatorShopID, req.SeriesID)
if err != nil && err != gorm.ErrRecordNotFound {
return nil, fmt.Errorf("检查分配权限失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "检查分配权限失败")
}
if myAllocation == nil || myAllocation.Status != constants.StatusEnabled {
return nil, errors.New(errors.CodeForbidden, "您没有该套餐系列的分配权限")
@@ -132,14 +131,14 @@ func (s *Service) Create(ctx context.Context, req *dto.CreateShopSeriesAllocatio
allocation.Creator = currentUserID
if err := s.allocationStore.Create(ctx, allocation); err != nil {
return nil, fmt.Errorf("创建分配失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "创建分配失败")
}
// 如果是梯度类型,保存梯度配置
if req.EnableOneTimeCommission && req.OneTimeCommissionConfig != nil &&
req.OneTimeCommissionConfig.Type == model.OneTimeCommissionTypeTiered {
if err := s.saveOneTimeCommissionTiers(ctx, allocation.ID, req.OneTimeCommissionConfig.Tiers, currentUserID); err != nil {
return nil, fmt.Errorf("创建一次性佣金梯度配置失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "创建一次性佣金梯度配置失败")
}
}
@@ -152,7 +151,7 @@ func (s *Service) Get(ctx context.Context, id uint) (*dto.ShopSeriesAllocationRe
if err == gorm.ErrRecordNotFound {
return nil, errors.New(errors.CodeNotFound, "分配记录不存在")
}
return nil, fmt.Errorf("获取分配记录失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "获取分配记录失败")
}
shop, _ := s.shopStore.GetByID(ctx, allocation.ShopID)
@@ -181,7 +180,7 @@ func (s *Service) Update(ctx context.Context, id uint, req *dto.UpdateShopSeries
if err == gorm.ErrRecordNotFound {
return nil, errors.New(errors.CodeNotFound, "分配记录不存在")
}
return nil, fmt.Errorf("获取分配记录失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "获取分配记录失败")
}
configChanged := false
@@ -239,21 +238,21 @@ func (s *Service) Update(ctx context.Context, id uint, req *dto.UpdateShopSeries
if configChanged {
if err := s.createNewConfigVersion(ctx, allocation); err != nil {
return nil, fmt.Errorf("创建配置版本失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "创建配置版本失败")
}
}
if err := s.allocationStore.Update(ctx, allocation); err != nil {
return nil, fmt.Errorf("更新分配失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "更新分配失败")
}
if oneTimeCommissionChanged && req.OneTimeCommissionConfig != nil &&
req.OneTimeCommissionConfig.Type == model.OneTimeCommissionTypeTiered {
if err := s.oneTimeCommissionTierStore.DeleteByAllocationID(ctx, allocation.ID); err != nil {
return nil, fmt.Errorf("清理旧梯度配置失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "清理旧梯度配置失败")
}
if err := s.saveOneTimeCommissionTiers(ctx, allocation.ID, req.OneTimeCommissionConfig.Tiers, currentUserID); err != nil {
return nil, fmt.Errorf("更新一次性佣金梯度配置失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "更新一次性佣金梯度配置失败")
}
}
@@ -278,19 +277,19 @@ func (s *Service) Delete(ctx context.Context, id uint) error {
if err == gorm.ErrRecordNotFound {
return errors.New(errors.CodeNotFound, "分配记录不存在")
}
return fmt.Errorf("获取分配记录失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "获取分配记录失败")
}
hasDependent, err := s.allocationStore.HasDependentAllocations(ctx, allocation.ShopID, allocation.SeriesID)
if err != nil {
return fmt.Errorf("检查依赖关系失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "检查依赖关系失败")
}
if hasDependent {
return errors.New(errors.CodeConflict, "存在下级依赖,无法删除")
}
if err := s.allocationStore.Delete(ctx, id); err != nil {
return fmt.Errorf("删除分配失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "删除分配失败")
}
return nil
@@ -328,7 +327,7 @@ func (s *Service) List(ctx context.Context, req *dto.ShopSeriesAllocationListReq
allocations, total, err := s.allocationStore.List(ctx, opts, filters)
if err != nil {
return nil, 0, fmt.Errorf("查询分配列表失败: %w", err)
return nil, 0, errors.Wrap(errors.CodeInternalError, err, "查询分配列表失败")
}
responses := make([]*dto.ShopSeriesAllocationResponse, len(allocations))
@@ -363,11 +362,11 @@ func (s *Service) UpdateStatus(ctx context.Context, id uint, status int) error {
if err == gorm.ErrRecordNotFound {
return errors.New(errors.CodeNotFound, "分配记录不存在")
}
return fmt.Errorf("获取分配记录失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "获取分配记录失败")
}
if err := s.allocationStore.UpdateStatus(ctx, id, status, currentUserID); err != nil {
return fmt.Errorf("更新状态失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "更新状态失败")
}
return nil
@@ -376,12 +375,12 @@ func (s *Service) UpdateStatus(ctx context.Context, id uint, status int) error {
func (s *Service) GetParentCostPrice(ctx context.Context, shopID, packageID uint) (int64, error) {
pkg, err := s.packageStore.GetByID(ctx, packageID)
if err != nil {
return 0, fmt.Errorf("获取套餐失败: %w", err)
return 0, errors.Wrap(errors.CodeInternalError, err, "获取套餐失败")
}
shop, err := s.shopStore.GetByID(ctx, shopID)
if err != nil {
return 0, fmt.Errorf("获取店铺失败: %w", err)
return 0, errors.Wrap(errors.CodeInternalError, err, "获取店铺失败")
}
if shop.ParentID == nil || *shop.ParentID == 0 {
@@ -449,7 +448,7 @@ func (s *Service) createNewConfigVersion(ctx context.Context, allocation *model.
now := time.Now()
if err := s.configStore.InvalidateCurrent(ctx, allocation.ID, now); err != nil {
return fmt.Errorf("失效当前配置版本失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "失效当前配置版本失败")
}
latestVersion, err := s.configStore.GetLatestVersion(ctx, allocation.ID)
@@ -468,7 +467,7 @@ func (s *Service) createNewConfigVersion(ctx context.Context, allocation *model.
}
if err := s.configStore.Create(ctx, newConfig); err != nil {
return fmt.Errorf("创建新配置版本失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "创建新配置版本失败")
}
return nil
@@ -546,7 +545,7 @@ func (s *Service) GetEffectiveConfig(ctx context.Context, allocationID uint, at
if err == gorm.ErrRecordNotFound {
return nil, errors.New(errors.CodeNotFound, "未找到生效的配置版本")
}
return nil, fmt.Errorf("获取生效配置失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "获取生效配置失败")
}
return config, nil
}
@@ -557,12 +556,12 @@ func (s *Service) ListConfigVersions(ctx context.Context, allocationID uint) ([]
if err == gorm.ErrRecordNotFound {
return nil, errors.New(errors.CodeNotFound, "分配记录不存在")
}
return nil, fmt.Errorf("获取分配记录失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "获取分配记录失败")
}
configs, err := s.configStore.List(ctx, allocationID)
if err != nil {
return nil, fmt.Errorf("获取配置版本列表失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "获取配置版本列表失败")
}
return configs, nil