feat: OpenAPI 契约对齐与框架优化
All checks were successful
构建并部署到测试环境(无 SSH) / build-and-deploy (push) Successful in 5m45s
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:
@@ -2,7 +2,6 @@ package shop_package_allocation
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"time"
|
||||
|
||||
"github.com/break/junhong_cmp_fiber/internal/model"
|
||||
@@ -57,7 +56,7 @@ func (s *Service) Create(ctx context.Context, req *dto.CreateShopPackageAllocati
|
||||
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 {
|
||||
@@ -71,7 +70,7 @@ func (s *Service) Create(ctx context.Context, req *dto.CreateShopPackageAllocati
|
||||
if err == gorm.ErrRecordNotFound {
|
||||
return nil, errors.New(errors.CodeNotFound, "套餐不存在")
|
||||
}
|
||||
return nil, fmt.Errorf("获取套餐失败: %w", err)
|
||||
return nil, errors.Wrap(errors.CodeInternalError, err, "获取套餐失败")
|
||||
}
|
||||
|
||||
seriesAllocation, err := s.seriesAllocationStore.GetByShopAndSeries(ctx, req.ShopID, pkg.SeriesID)
|
||||
@@ -79,7 +78,7 @@ func (s *Service) Create(ctx context.Context, req *dto.CreateShopPackageAllocati
|
||||
if err == gorm.ErrRecordNotFound {
|
||||
return nil, errors.New(errors.CodeForbidden, "该套餐的系列未分配给此店铺")
|
||||
}
|
||||
return nil, fmt.Errorf("获取系列分配失败: %w", err)
|
||||
return nil, errors.Wrap(errors.CodeInternalError, err, "获取系列分配失败")
|
||||
}
|
||||
|
||||
existing, _ := s.packageAllocationStore.GetByShopAndPackage(ctx, req.ShopID, req.PackageID)
|
||||
@@ -97,7 +96,7 @@ func (s *Service) Create(ctx context.Context, req *dto.CreateShopPackageAllocati
|
||||
allocation.Creator = currentUserID
|
||||
|
||||
if err := s.packageAllocationStore.Create(ctx, allocation); err != nil {
|
||||
return nil, fmt.Errorf("创建分配失败: %w", err)
|
||||
return nil, errors.Wrap(errors.CodeInternalError, err, "创建分配失败")
|
||||
}
|
||||
|
||||
return s.buildResponse(ctx, allocation, targetShop.ShopName, pkg.PackageName, pkg.PackageCode)
|
||||
@@ -109,7 +108,7 @@ func (s *Service) Get(ctx context.Context, id uint) (*dto.ShopPackageAllocationR
|
||||
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)
|
||||
@@ -140,7 +139,7 @@ func (s *Service) Update(ctx context.Context, id uint, req *dto.UpdateShopPackag
|
||||
if err == gorm.ErrRecordNotFound {
|
||||
return nil, errors.New(errors.CodeNotFound, "分配记录不存在")
|
||||
}
|
||||
return nil, fmt.Errorf("获取分配记录失败: %w", err)
|
||||
return nil, errors.Wrap(errors.CodeInternalError, err, "获取分配记录失败")
|
||||
}
|
||||
|
||||
if req.CostPrice != nil {
|
||||
@@ -149,7 +148,7 @@ func (s *Service) Update(ctx context.Context, id uint, req *dto.UpdateShopPackag
|
||||
allocation.Updater = currentUserID
|
||||
|
||||
if err := s.packageAllocationStore.Update(ctx, allocation); err != nil {
|
||||
return nil, fmt.Errorf("更新分配失败: %w", err)
|
||||
return nil, errors.Wrap(errors.CodeInternalError, err, "更新分配失败")
|
||||
}
|
||||
|
||||
shop, _ := s.shopStore.GetByID(ctx, allocation.ShopID)
|
||||
@@ -175,11 +174,11 @@ 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, "获取分配记录失败")
|
||||
}
|
||||
|
||||
if err := s.packageAllocationStore.Delete(ctx, id); err != nil {
|
||||
return fmt.Errorf("删除分配失败: %w", err)
|
||||
return errors.Wrap(errors.CodeInternalError, err, "删除分配失败")
|
||||
}
|
||||
|
||||
return nil
|
||||
@@ -211,7 +210,7 @@ func (s *Service) List(ctx context.Context, req *dto.ShopPackageAllocationListRe
|
||||
|
||||
allocations, total, err := s.packageAllocationStore.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.ShopPackageAllocationResponse, len(allocations))
|
||||
@@ -248,11 +247,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.packageAllocationStore.UpdateStatus(ctx, id, status, currentUserID); err != nil {
|
||||
return fmt.Errorf("更新状态失败: %w", err)
|
||||
return errors.Wrap(errors.CodeInternalError, err, "更新状态失败")
|
||||
}
|
||||
|
||||
return nil
|
||||
@@ -286,7 +285,7 @@ func (s *Service) UpdateCostPrice(ctx context.Context, id uint, newCostPrice int
|
||||
if err == gorm.ErrRecordNotFound {
|
||||
return nil, errors.New(errors.CodeNotFound, "分配记录不存在")
|
||||
}
|
||||
return nil, fmt.Errorf("获取分配记录失败: %w", err)
|
||||
return nil, errors.Wrap(errors.CodeInternalError, err, "获取分配记录失败")
|
||||
}
|
||||
|
||||
if allocation.CostPrice == newCostPrice {
|
||||
@@ -305,13 +304,13 @@ func (s *Service) UpdateCostPrice(ctx context.Context, id uint, newCostPrice int
|
||||
EffectiveFrom: now,
|
||||
}
|
||||
if err := s.priceHistoryStore.Create(ctx, priceHistory); err != nil {
|
||||
return nil, fmt.Errorf("创建价格历史记录失败: %w", err)
|
||||
return nil, errors.Wrap(errors.CodeInternalError, err, "创建价格历史记录失败")
|
||||
}
|
||||
|
||||
allocation.CostPrice = newCostPrice
|
||||
allocation.Updater = currentUserID
|
||||
if err := s.packageAllocationStore.Update(ctx, allocation); err != nil {
|
||||
return nil, fmt.Errorf("更新成本价失败: %w", err)
|
||||
return nil, errors.Wrap(errors.CodeInternalError, err, "更新成本价失败")
|
||||
}
|
||||
|
||||
shop, _ := s.shopStore.GetByID(ctx, allocation.ShopID)
|
||||
@@ -337,12 +336,12 @@ func (s *Service) GetPriceHistory(ctx context.Context, allocationID uint) ([]*mo
|
||||
if err == gorm.ErrRecordNotFound {
|
||||
return nil, errors.New(errors.CodeNotFound, "分配记录不存在")
|
||||
}
|
||||
return nil, fmt.Errorf("获取分配记录失败: %w", err)
|
||||
return nil, errors.Wrap(errors.CodeInternalError, err, "获取分配记录失败")
|
||||
}
|
||||
|
||||
history, err := s.priceHistoryStore.ListByAllocation(ctx, allocationID)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("获取价格历史失败: %w", err)
|
||||
return nil, errors.Wrap(errors.CodeInternalError, err, "获取价格历史失败")
|
||||
}
|
||||
|
||||
return history, nil
|
||||
|
||||
Reference in New Issue
Block a user