refactor: align framework cleanup with new bootstrap flow
Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
This commit is contained in:
422
openspec/changes/refactor-framework-cleanup/design.md
Normal file
422
openspec/changes/refactor-framework-cleanup/design.md
Normal file
@@ -0,0 +1,422 @@
|
||||
## Context
|
||||
|
||||
当前项目处于框架搭建阶段,存在多处技术债务需要清理:
|
||||
- 两套 Auth 实现产生于不同开发阶段,未整合
|
||||
- 示例代码(user/order)是早期测试用途,现已有真实 RBAC 代码
|
||||
- pkg/errors 和 pkg/response 设计时职责划分不清晰
|
||||
- DataPermissionScope 实现完整但从未集成使用
|
||||
|
||||
**约束条件**:
|
||||
- 必须保持 Go 惯用模式,避免 Java 风格过度抽象
|
||||
- main.go 在未来开发中应该不需要修改
|
||||
- 数据权限过滤必须支持绕过机制
|
||||
|
||||
## Goals / Non-Goals
|
||||
|
||||
### Goals
|
||||
- 清理所有示例和重复代码,使框架干净整洁
|
||||
- 统一认证、错误处理、响应格式的实现方式
|
||||
- 实现数据权限的 GORM 自动化过滤
|
||||
- 将组件初始化从 main.go 解耦,支持未来扩展
|
||||
- 在关键扩展点添加 TODO 标记
|
||||
|
||||
### Non-Goals
|
||||
- 不实现完整的 DI 框架(保持 Go 简洁风格)
|
||||
- 不实现自动注册机制(使用显式工厂模式)
|
||||
- 不重构现有 RBAC 业务逻辑
|
||||
- 不添加新的业务功能
|
||||
|
||||
## Decisions
|
||||
|
||||
### Decision 1: Auth 中间件合并策略
|
||||
|
||||
**选择**:重新设计合并版本
|
||||
|
||||
**实现方案**:
|
||||
```go
|
||||
// pkg/middleware/auth.go - 合并版本
|
||||
type AuthConfig struct {
|
||||
TokenExtractor func(*fiber.Ctx) string // 自定义 token 提取
|
||||
SkipPaths []string // 跳过认证的路径
|
||||
Validator func(string) (*UserInfo, error) // token 验证函数
|
||||
}
|
||||
|
||||
func Auth(cfg AuthConfig) fiber.Handler {
|
||||
return func(c *fiber.Ctx) error {
|
||||
// 1. 检查跳过路径
|
||||
// 2. 提取 token
|
||||
// 3. 验证 token
|
||||
// 4. 设置用户上下文(同时设置 Locals 和 Context)
|
||||
// 5. 错误统一返回 AppError,由全局 ErrorHandler 处理
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**理由**:
|
||||
- 合并两者优点:pkg 版本的可配置性 + internal 版本的统一错误格式
|
||||
- 统一使用 `return errors.New()` 让全局 ErrorHandler 处理
|
||||
- 消除错误格式不一致问题
|
||||
|
||||
### Decision 2: 组件注册解耦策略
|
||||
|
||||
**选择**:Bootstrap 包 + 按模块拆分 + 工厂函数模式
|
||||
|
||||
**实现方案**:
|
||||
```
|
||||
internal/bootstrap/
|
||||
├── bootstrap.go # 主入口,编排初始化流程
|
||||
├── dependencies.go # Dependencies 结构体定义
|
||||
├── stores.go # 所有 Store 初始化逻辑
|
||||
├── services.go # 所有 Service 初始化逻辑
|
||||
├── handlers.go # 所有 Handler 初始化逻辑
|
||||
└── types.go # Handlers 结构体定义
|
||||
```
|
||||
|
||||
**bootstrap.go** - 主入口编排:
|
||||
```go
|
||||
// Bootstrap 初始化所有组件并返回 Handlers
|
||||
func Bootstrap(deps *Dependencies) (*Handlers, error) {
|
||||
// 1. 初始化 GORM Callback(必须在 Store 之前)
|
||||
if err := registerGORMCallbacks(deps.DB); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// 2. 初始化 Stores
|
||||
stores := initStores(deps)
|
||||
|
||||
// 3. 初始化 Services
|
||||
services := initServices(stores)
|
||||
|
||||
// 4. 初始化 Handlers
|
||||
handlers := initHandlers(services)
|
||||
|
||||
return handlers, nil
|
||||
}
|
||||
```
|
||||
|
||||
**stores.go** - Store 层初始化:
|
||||
```go
|
||||
type Stores struct {
|
||||
Account *postgres.AccountStore
|
||||
Role *postgres.RoleStore
|
||||
Permission *postgres.PermissionStore
|
||||
AccountRole *postgres.AccountRoleStore
|
||||
RolePermission *postgres.RolePermissionStore
|
||||
// TODO: 新增 Store 在此添加字段
|
||||
}
|
||||
|
||||
func initStores(deps *Dependencies) *Stores {
|
||||
return &Stores{
|
||||
Account: postgres.NewAccountStore(deps.DB, deps.Redis),
|
||||
Role: postgres.NewRoleStore(deps.DB),
|
||||
Permission: postgres.NewPermissionStore(deps.DB),
|
||||
AccountRole: postgres.NewAccountRoleStore(deps.DB),
|
||||
RolePermission: postgres.NewRolePermissionStore(deps.DB),
|
||||
// TODO: 新增 Store 在此初始化
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**services.go** - Service 层初始化:
|
||||
```go
|
||||
type Services struct {
|
||||
Account *accountSvc.Service
|
||||
Role *roleSvc.Service
|
||||
Permission *permissionSvc.Service
|
||||
// TODO: 新增 Service 在此添加字段
|
||||
}
|
||||
|
||||
func initServices(stores *Stores) *Services {
|
||||
return &Services{
|
||||
Account: accountSvc.New(stores.Account, stores.Role, stores.AccountRole),
|
||||
Role: roleSvc.New(stores.Role, stores.Permission, stores.RolePermission),
|
||||
Permission: permissionSvc.New(stores.Permission),
|
||||
// TODO: 新增 Service 在此初始化
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**handlers.go** - Handler 层初始化:
|
||||
```go
|
||||
func initHandlers(services *Services) *Handlers {
|
||||
return &Handlers{
|
||||
Account: handler.NewAccountHandler(services.Account),
|
||||
Role: handler.NewRoleHandler(services.Role),
|
||||
Permission: handler.NewPermissionHandler(services.Permission),
|
||||
// TODO: 新增 Handler 在此初始化
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**types.go** - 类型定义:
|
||||
```go
|
||||
// Handlers 封装所有 HTTP 处理器
|
||||
type Handlers struct {
|
||||
Account *handler.AccountHandler
|
||||
Role *handler.RoleHandler
|
||||
Permission *handler.PermissionHandler
|
||||
// TODO: 新增 Handler 在此添加字段
|
||||
}
|
||||
```
|
||||
|
||||
**dependencies.go** - 基础依赖:
|
||||
```go
|
||||
// Dependencies 封装所有基础依赖
|
||||
type Dependencies struct {
|
||||
DB *gorm.DB
|
||||
Redis *redis.Client
|
||||
Logger *zap.Logger
|
||||
}
|
||||
```
|
||||
|
||||
**main.go 简化后**:
|
||||
```go
|
||||
func main() {
|
||||
// 初始化基础依赖
|
||||
deps := initDependencies()
|
||||
|
||||
// 一行完成所有业务组件初始化
|
||||
handlers, err := bootstrap.Bootstrap(deps)
|
||||
|
||||
// 设置路由
|
||||
routes.Setup(app, handlers)
|
||||
|
||||
// 启动服务
|
||||
app.Listen(":8080")
|
||||
}
|
||||
```
|
||||
|
||||
**理由**:
|
||||
- **按层次拆分**:stores.go、services.go、handlers.go 职责清晰
|
||||
- **易于扩展**:每层只需在对应文件中添加初始化代码
|
||||
- **文件大小可控**:每个文件 < 100 行,避免单文件臃肿
|
||||
- **main.go 零修改**:新增业务只修改 bootstrap 内部文件
|
||||
- **符合 Go 风格**:显式依赖注入,不使用复杂的 DI 框架
|
||||
- **TODO 标记清晰**:每层都有明确的扩展点标记
|
||||
|
||||
### Decision 3: 数据权限 GORM Callback 实现
|
||||
|
||||
**选择**:GORM Callback 自动化 + Context 绕过机制
|
||||
|
||||
**实现方案**:
|
||||
```go
|
||||
// pkg/gorm/callback.go
|
||||
|
||||
type contextKey string
|
||||
const SkipDataPermissionKey contextKey = "skip_data_permission"
|
||||
|
||||
// SkipDataPermission 返回跳过数据权限过滤的 Context
|
||||
func SkipDataPermission(ctx context.Context) context.Context {
|
||||
return context.WithValue(ctx, SkipDataPermissionKey, true)
|
||||
}
|
||||
|
||||
// RegisterDataPermissionCallback 注册 GORM Callback
|
||||
func RegisterDataPermissionCallback(db *gorm.DB, accountStore AccountStoreInterface) {
|
||||
db.Callback().Query().Before("gorm:query").Register("data_permission", func(tx *gorm.DB) {
|
||||
ctx := tx.Statement.Context
|
||||
|
||||
// 检查是否跳过
|
||||
if skip, ok := ctx.Value(SkipDataPermissionKey).(bool); ok && skip {
|
||||
return
|
||||
}
|
||||
|
||||
// 检查 root 用户
|
||||
if middleware.IsRootUser(ctx) {
|
||||
return
|
||||
}
|
||||
|
||||
// 获取用户下级 ID 并应用过滤
|
||||
userID := middleware.GetUserIDFromContext(ctx)
|
||||
subordinateIDs, _ := accountStore.GetSubordinateIDs(ctx, userID)
|
||||
|
||||
// 只对包含 owner_id 字段的表应用过滤
|
||||
if hasOwnerIDField(tx.Statement.Schema) {
|
||||
tx.Where("owner_id IN ?", subordinateIDs)
|
||||
}
|
||||
})
|
||||
}
|
||||
```
|
||||
|
||||
**使用方式**:
|
||||
```go
|
||||
// 正常查询 - 自动应用数据权限过滤
|
||||
db.WithContext(ctx).Find(&accounts)
|
||||
|
||||
// 绕过权限过滤(如管理员操作、内部同步)
|
||||
ctx = gorm.SkipDataPermission(ctx)
|
||||
db.WithContext(ctx).Find(&accounts)
|
||||
```
|
||||
|
||||
**理由**:
|
||||
- 完全自动化,开发者无需手动调用 Scope
|
||||
- 通过 Context 控制绕过,符合 Go 惯用模式
|
||||
- 只对包含 owner_id 的表生效,安全可控
|
||||
- 删除现有未使用的 scopes.go 代码
|
||||
|
||||
### Decision 4: 简化 AppError 结构
|
||||
|
||||
**选择**:删除 AppError.HTTPStatus 字段和 WithHTTPStatus() 方法
|
||||
|
||||
**问题分析**:
|
||||
```go
|
||||
type AppError struct {
|
||||
Code int // 业务错误码
|
||||
Message string // 错误消息
|
||||
HTTPStatus int // 冗余:总是从 Code 映射得到
|
||||
Err error
|
||||
}
|
||||
```
|
||||
|
||||
**冗余之处**:
|
||||
- HTTPStatus 字段总是通过 `GetHTTPStatus(code)` 从 Code 映射得到
|
||||
- 存储 HTTPStatus 字段导致字段冗余
|
||||
- WithHTTPStatus() 方法允许手动覆盖,可能导致状态码不一致
|
||||
|
||||
**优化方案**:
|
||||
```go
|
||||
type AppError struct {
|
||||
Code int // 业务错误码
|
||||
Message string // 错误消息
|
||||
Err error // 底层错误(可选)
|
||||
}
|
||||
|
||||
// 删除 WithHTTPStatus() 方法
|
||||
// ErrorHandler 中直接调用 GetHTTPStatus(e.Code) 获取状态码
|
||||
```
|
||||
|
||||
**理由**:
|
||||
- **减少字段冗余**:HTTPStatus 可以实时计算,不需要存储
|
||||
- **消除不一致风险**:禁止手动设置状态码,确保 Code 和 HTTPStatus 始终匹配
|
||||
- **简化 AppError**:只保留核心字段(Code, Message, Err)
|
||||
- **保持职责分离**:AppError 只负责错误表示,HTTPStatus 由 ErrorHandler 处理
|
||||
|
||||
### Decision 5: 错误处理统一策略
|
||||
|
||||
**选择**:删除 response.Error(),统一使用全局 ErrorHandler
|
||||
|
||||
**当前格式分析**:
|
||||
```go
|
||||
// pkg/errors/handler.go - 已经统一使用 msg
|
||||
c.Status(httpStatus).JSON(fiber.Map{
|
||||
"code": code,
|
||||
"data": nil,
|
||||
"msg": message, // 当前已是 msg
|
||||
"timestamp": time.Now().Format(time.RFC3339),
|
||||
})
|
||||
|
||||
// pkg/response/response.go - 已经统一使用 msg
|
||||
type Response struct {
|
||||
Code int `json:"code"`
|
||||
Data any `json:"data"`
|
||||
Message string `json:"msg"` // JSON 标签是 msg
|
||||
Timestamp string `json:"timestamp"`
|
||||
}
|
||||
```
|
||||
|
||||
**问题**:
|
||||
- `response.Error()` 函数允许手动构造错误响应,导致两种错误处理方式混用
|
||||
- 需要手动传递 `httpStatus` 参数,容易出错
|
||||
|
||||
**解决方案**:
|
||||
```go
|
||||
// pkg/response/response.go
|
||||
// 删除 Error() 函数,只保留:
|
||||
func Success(c *fiber.Ctx, data interface{}) error
|
||||
func SuccessWithMessage(c *fiber.Ctx, data interface{}, message string) error
|
||||
func SuccessWithPagination(c *fiber.Ctx, items any, total int64, page, size int) error
|
||||
```
|
||||
|
||||
**Handler 统一写法**:
|
||||
```go
|
||||
func (h *AccountHandler) Create(c *fiber.Ctx) error {
|
||||
if err := c.BodyParser(&req); err != nil {
|
||||
return errors.New(errors.CodeInvalidParam, "请求参数格式错误")
|
||||
}
|
||||
|
||||
if err := h.service.Create(ctx, &req); err != nil {
|
||||
return err // 直接返回,由 ErrorHandler 处理
|
||||
}
|
||||
|
||||
return response.Success(c, account)
|
||||
}
|
||||
```
|
||||
|
||||
**统一响应格式**(仅包含 4 个字段):
|
||||
```json
|
||||
{
|
||||
"code": 0,
|
||||
"msg": "success",
|
||||
"data": {...},
|
||||
"timestamp": "2025-11-19T..."
|
||||
}
|
||||
```
|
||||
|
||||
**理由**:
|
||||
- **消除两种错误处理方式**:Handler 只能返回 error,不能手动构造错误响应
|
||||
- **格式已统一**:错误和成功响应都使用 `msg` 字段
|
||||
- **简化开发**:错误码到 HTTP 状态码的映射由 ErrorHandler 统一处理
|
||||
- **避免字段冗余**:不返回 `httpstatus` 字段(HTTP 状态码已在响应头中)
|
||||
|
||||
## Risks / Trade-offs
|
||||
|
||||
### Risk 1: GORM Callback 性能开销
|
||||
**风险**:每次查询都执行 Callback 可能影响性能
|
||||
**缓解**:
|
||||
- GetSubordinateIDs 已实现 Redis 缓存(30分钟)
|
||||
- 通过 Schema 检查只对需要的表生效
|
||||
- 监控查询性能,必要时优化
|
||||
|
||||
### Risk 2: 删除代码可能影响未知依赖
|
||||
**风险**:示例代码可能被测试或文档引用
|
||||
**缓解**:
|
||||
- 搜索确认无任何引用
|
||||
- 删除后运行完整测试
|
||||
- 项目处于框架搭建阶段,风险可控
|
||||
|
||||
### Risk 3: Bootstrap 多文件维护成本
|
||||
**风险**:拆分成多个文件后,需要在多处添加新业务模块
|
||||
**缓解**:
|
||||
- TODO 注释明确标记所有扩展点
|
||||
- 保持文件结构简单清晰(stores.go, services.go, handlers.go)
|
||||
- 每个文件只负责一层初始化,职责单一
|
||||
- 每个文件保持 < 100 行,易于理解和维护
|
||||
|
||||
## Migration Plan
|
||||
|
||||
1. **Phase 1(清理)**:
|
||||
- 删除示例代码(user/order)
|
||||
- 合并 Auth 实现
|
||||
- 验证现有功能不受影响
|
||||
|
||||
2. **Phase 2(解耦)**:
|
||||
- 创建 bootstrap 包
|
||||
- 重构 main.go
|
||||
- 验证启动流程正常
|
||||
|
||||
3. **Phase 3(自动化)**:
|
||||
- 实现 GORM Callback
|
||||
- 删除 scopes.go
|
||||
- 添加绕过机制测试
|
||||
|
||||
4. **Phase 4(规范化)**:
|
||||
- 统一错误格式
|
||||
- 删除 Error() 函数
|
||||
- 更新所有 Handler 写法
|
||||
|
||||
**回滚策略**:
|
||||
- 使用 Git 分支,每个 Phase 可独立回滚
|
||||
- 保留删除代码的备份(或通过 Git 历史恢复)
|
||||
|
||||
## Open Questions
|
||||
|
||||
1. **owner_id 字段检测**:如何优雅地检测表是否需要数据权限过滤?
|
||||
- 方案 A:检查 Schema 是否有 owner_id 字段
|
||||
- 方案 B:使用接口标记(如 `DataPermissionAware`)
|
||||
- 建议:先用方案 A,必要时再重构
|
||||
|
||||
2. **多租户支持**:shop_id 过滤是否也应该自动化?
|
||||
- 当前 DataPermissionScope 支持 shop_id
|
||||
- 建议:本次只自动化 owner_id,shop_id 作为 TODO
|
||||
|
||||
3. **Callback 注册时机**:应该在哪里注册 GORM Callback?
|
||||
- 建议:在 bootstrap 包初始化 DB 后立即注册
|
||||
63
openspec/changes/refactor-framework-cleanup/proposal.md
Normal file
63
openspec/changes/refactor-framework-cleanup/proposal.md
Normal file
@@ -0,0 +1,63 @@
|
||||
## Why
|
||||
|
||||
当前框架存在多处设计冲突和代码冗余,影响可维护性和开发效率:
|
||||
1. 存在两套 Auth 实现,错误返回格式不一致
|
||||
2. Handler/Service/Store 需要在 main.go 中手动注册,难以扩展
|
||||
3. 示例业务代码(user/order)未被清理,与真实 RBAC 代码混杂
|
||||
4. pkg/errors 和 pkg/response 职责重叠,使用方式不统一
|
||||
5. GORM 数据权限过滤已实现但未集成,自动化程度为 0%
|
||||
|
||||
## What Changes
|
||||
|
||||
### Phase 1: 清理和统一
|
||||
- **BREAKING**: 删除所有示例业务代码(user/order 相关的 handler、service、store、model)
|
||||
- 删除重复的 `internal/middleware/auth.go`,重新设计合并版本到 `pkg/middleware/auth.go`
|
||||
- 简化 AppError 结构:删除 HTTPStatus 字段和 WithHTTPStatus() 方法
|
||||
- 确认错误响应格式已统一(code, msg, data, timestamp 四个字段)
|
||||
- 删除 `pkg/response/response.go` 中的 `Error()` 函数,Handler 统一返回 error
|
||||
|
||||
### Phase 2: 组件注册解耦(按模块拆分)
|
||||
- 将 `main.go` 中的 `initServices()` 逻辑提取到 `internal/bootstrap/` 包
|
||||
- 按层次拆分 bootstrap 包:`stores.go`, `services.go`, `handlers.go`
|
||||
- 创建统一的组件工厂,使 main.go 不需要了解具体业务模块
|
||||
- 每个文件添加 TODO 标记用于未来扩展点
|
||||
- 避免单文件臃肿,每个文件保持 < 100 行
|
||||
|
||||
### Phase 3: 数据权限自动化
|
||||
- 实现 GORM Callback 机制自动注入数据权限过滤
|
||||
- 支持通过 Context 绕过权限过滤(SkipDataPermission)
|
||||
- 删除未使用的 `scopes.go` 中的手动 Scope 函数
|
||||
|
||||
### Phase 4: 代码规范化
|
||||
- 删除错误码别名,统一使用标准错误码
|
||||
- 删除重复的 validator 实例,在启动时创建单例
|
||||
|
||||
## Impact
|
||||
|
||||
### Affected specs
|
||||
- auth(新建):统一认证中间件规范
|
||||
- dependency-injection(新建):组件注册和依赖注入规范
|
||||
- data-permission(新建):数据权限自动过滤规范
|
||||
- error-handling(新建):统一错误处理规范
|
||||
|
||||
### Affected code
|
||||
- 删除文件(10+):
|
||||
- `internal/handler/user.go`, `internal/handler/order.go`
|
||||
- `internal/model/user.go`, `internal/model/user_dto.go`
|
||||
- `internal/model/order.go`, `internal/model/order_dto.go`
|
||||
- `internal/service/user/`, `internal/service/order/`
|
||||
- `internal/store/postgres/user_store.go`, `internal/store/postgres/order_store.go`
|
||||
- `internal/middleware/auth.go`
|
||||
- 重构文件:
|
||||
- `cmd/api/main.go` → 简化,提取初始化逻辑
|
||||
- `pkg/middleware/auth.go` → 重新设计,统一错误格式
|
||||
- `pkg/errors/handler.go` → 统一 JSON 字段名
|
||||
- `pkg/response/response.go` → 删除 Error() 函数
|
||||
- `internal/store/postgres/` → 添加 GORM Callback 支持
|
||||
- 新建文件:
|
||||
- `internal/bootstrap/bootstrap.go` → 组件工厂和初始化逻辑
|
||||
- `pkg/gorm/callback.go` → 数据权限 GORM Callback
|
||||
|
||||
### Migration
|
||||
- 这是框架搭建阶段,无生产数据需要迁移
|
||||
- 示例代码删除不影响任何现有功能
|
||||
@@ -0,0 +1,61 @@
|
||||
## ADDED Requirements
|
||||
|
||||
### Requirement: Unified Authentication Middleware
|
||||
|
||||
系统 SHALL 提供统一的认证中间件,支持可配置的 Token 提取和验证。
|
||||
|
||||
#### Scenario: Token 验证成功
|
||||
- **WHEN** 请求携带有效的 Token
|
||||
- **THEN** 中间件提取并验证 Token
|
||||
- **AND** 将用户信息同时设置到 Fiber Locals 和 Context
|
||||
- **AND** 请求继续执行
|
||||
|
||||
#### Scenario: Token 缺失
|
||||
- **WHEN** 请求未携带 Token
|
||||
- **AND** 路径不在跳过列表中
|
||||
- **THEN** 返回 AppError(CodeMissingToken)
|
||||
- **AND** 由全局 ErrorHandler 处理错误响应
|
||||
|
||||
#### Scenario: Token 无效
|
||||
- **WHEN** 请求携带的 Token 无效或过期
|
||||
- **THEN** 返回 AppError(CodeUnauthorized)
|
||||
- **AND** 由全局 ErrorHandler 处理错误响应
|
||||
|
||||
#### Scenario: 跳过路径
|
||||
- **WHEN** 请求路径在 SkipPaths 配置中
|
||||
- **THEN** 中间件跳过认证
|
||||
- **AND** 请求直接继续执行
|
||||
|
||||
### Requirement: User Context Management
|
||||
|
||||
认证中间件 SHALL 提供用户上下文管理函数,支持从 Context 获取用户信息。
|
||||
|
||||
#### Scenario: 获取用户 ID
|
||||
- **WHEN** 调用 GetUserIDFromContext(ctx)
|
||||
- **AND** 认证已通过
|
||||
- **THEN** 返回当前用户的 ID
|
||||
|
||||
#### Scenario: 检查 Root 用户
|
||||
- **WHEN** 调用 IsRootUser(ctx)
|
||||
- **THEN** 返回当前用户是否为 Root 用户
|
||||
|
||||
#### Scenario: 设置用户到 Fiber Context
|
||||
- **WHEN** 调用 SetUserToFiberContext(c, userInfo)
|
||||
- **THEN** 用户信息被设置到 Fiber Locals
|
||||
- **AND** 用户信息被设置到请求 Context(供 GORM 等使用)
|
||||
|
||||
### Requirement: Auth Middleware Configuration
|
||||
|
||||
认证中间件 SHALL 支持灵活的配置选项。
|
||||
|
||||
#### Scenario: 自定义 Token 提取
|
||||
- **WHEN** 配置了 TokenExtractor 函数
|
||||
- **THEN** 使用自定义函数从请求中提取 Token
|
||||
|
||||
#### Scenario: 默认 Token 提取
|
||||
- **WHEN** 未配置 TokenExtractor
|
||||
- **THEN** 从 Authorization Header 提取 Bearer Token
|
||||
|
||||
#### Scenario: 自定义验证函数
|
||||
- **WHEN** 配置了 Validator 函数
|
||||
- **THEN** 使用自定义函数验证 Token 并返回用户信息
|
||||
@@ -0,0 +1,61 @@
|
||||
## ADDED Requirements
|
||||
|
||||
### Requirement: GORM Callback Data Permission
|
||||
|
||||
系统 SHALL 使用 GORM Callback 机制自动为所有查询添加数据权限过滤。
|
||||
|
||||
#### Scenario: 自动应用权限过滤
|
||||
- **WHEN** 执行 GORM 查询
|
||||
- **AND** Context 包含用户信息
|
||||
- **AND** 表包含 owner_id 字段
|
||||
- **THEN** 自动添加 WHERE owner_id IN (subordinateIDs) 条件
|
||||
|
||||
#### Scenario: Root 用户跳过过滤
|
||||
- **WHEN** 当前用户是 Root 用户
|
||||
- **THEN** 不添加任何数据权限过滤条件
|
||||
- **AND** 可查询所有数据
|
||||
|
||||
#### Scenario: 无 owner_id 字段的表
|
||||
- **WHEN** 表不包含 owner_id 字段
|
||||
- **THEN** 不添加数据权限过滤条件
|
||||
|
||||
### Requirement: Skip Data Permission
|
||||
|
||||
系统 SHALL 支持通过 Context 绕过数据权限过滤。
|
||||
|
||||
#### Scenario: 显式跳过权限过滤
|
||||
- **WHEN** 调用 SkipDataPermission(ctx) 获取新 Context
|
||||
- **AND** 使用该 Context 执行 GORM 查询
|
||||
- **THEN** 不添加任何数据权限过滤条件
|
||||
|
||||
#### Scenario: 内部操作跳过过滤
|
||||
- **WHEN** 执行内部同步、批量操作或管理员操作
|
||||
- **THEN** 应使用 SkipDataPermission 绕过过滤
|
||||
|
||||
### Requirement: Subordinate IDs Caching
|
||||
|
||||
系统 SHALL 缓存用户的下级 ID 列表以提高查询性能。
|
||||
|
||||
#### Scenario: 缓存命中
|
||||
- **WHEN** 获取用户下级 ID 列表
|
||||
- **AND** Redis 缓存存在
|
||||
- **THEN** 直接返回缓存数据
|
||||
|
||||
#### Scenario: 缓存未命中
|
||||
- **WHEN** 获取用户下级 ID 列表
|
||||
- **AND** Redis 缓存不存在
|
||||
- **THEN** 执行递归 CTE 查询获取下级 ID
|
||||
- **AND** 将结果缓存到 Redis(30 分钟过期)
|
||||
|
||||
### Requirement: Callback Registration
|
||||
|
||||
系统 SHALL 在应用启动时注册 GORM 数据权限 Callback。
|
||||
|
||||
#### Scenario: 注册 Callback
|
||||
- **WHEN** 调用 RegisterDataPermissionCallback(db, accountStore)
|
||||
- **THEN** 注册 Query Before Callback
|
||||
- **AND** Callback 名称为 "data_permission"
|
||||
|
||||
#### Scenario: AccountStore 依赖
|
||||
- **WHEN** 注册 Callback 时
|
||||
- **THEN** 需要传入 AccountStore 实例用于获取下级 ID
|
||||
@@ -0,0 +1,52 @@
|
||||
## ADDED Requirements
|
||||
|
||||
### Requirement: Bootstrap Package
|
||||
|
||||
系统 SHALL 提供 bootstrap 包,统一管理所有业务组件的初始化和依赖注入。
|
||||
|
||||
#### Scenario: 初始化所有组件
|
||||
- **WHEN** 调用 Bootstrap(deps)
|
||||
- **THEN** 自动初始化所有 Store、Service 和 Handler
|
||||
- **AND** 返回可直接用于路由注册的 Handlers 结构体
|
||||
|
||||
#### Scenario: 依赖注入
|
||||
- **WHEN** 初始化 Service 时
|
||||
- **THEN** 自动注入所需的 Store 依赖
|
||||
- **AND** 自动注入所需的其他 Service 依赖
|
||||
|
||||
#### Scenario: 添加新业务模块
|
||||
- **WHEN** 需要添加新的业务模块
|
||||
- **THEN** 只需修改 bootstrap 包
|
||||
- **AND** main.go 无需任何修改
|
||||
- **AND** TODO 注释标记扩展点
|
||||
|
||||
### Requirement: Main Function Simplification
|
||||
|
||||
main 函数 SHALL 只负责编排,不包含具体业务组件初始化逻辑。
|
||||
|
||||
#### Scenario: 标准启动流程
|
||||
- **WHEN** 应用启动
|
||||
- **THEN** main 函数执行以下步骤:
|
||||
1. 加载配置
|
||||
2. 初始化基础依赖(DB、Redis、Logger)
|
||||
3. 调用 bootstrap.Bootstrap() 初始化业务组件
|
||||
4. 设置路由和中间件
|
||||
5. 启动服务器
|
||||
|
||||
#### Scenario: 启动失败处理
|
||||
- **WHEN** 任何初始化步骤失败
|
||||
- **THEN** 记录错误日志
|
||||
- **AND** 程序以非零状态码退出
|
||||
|
||||
### Requirement: Dependencies Encapsulation
|
||||
|
||||
系统 SHALL 使用结构体封装基础依赖和业务组件。
|
||||
|
||||
#### Scenario: Dependencies 结构体
|
||||
- **WHEN** 传递基础依赖时
|
||||
- **THEN** 使用 Dependencies 结构体封装 DB、Redis、Logger
|
||||
|
||||
#### Scenario: Handlers 结构体
|
||||
- **WHEN** 返回业务处理器时
|
||||
- **THEN** 使用 Handlers 结构体封装所有 Handler
|
||||
- **AND** 结构体包含 TODO 注释标记未来扩展点
|
||||
@@ -0,0 +1,92 @@
|
||||
## ADDED Requirements
|
||||
|
||||
### Requirement: Simplified AppError Structure
|
||||
|
||||
系统 SHALL 简化 AppError 结构,删除冗余的 HTTPStatus 字段。
|
||||
|
||||
#### Scenario: AppError 字段
|
||||
- **WHEN** 创建 AppError
|
||||
- **THEN** 结构体只包含 3 个字段:
|
||||
- Code: 业务错误码
|
||||
- Message: 错误消息
|
||||
- Err: 底层错误(可选)
|
||||
|
||||
#### Scenario: HTTP 状态码获取
|
||||
- **WHEN** ErrorHandler 处理 AppError
|
||||
- **THEN** 通过 GetHTTPStatus(code) 实时获取 HTTP 状态码
|
||||
- **AND** 不从 AppError 字段中读取
|
||||
|
||||
#### Scenario: 禁止手动设置状态码
|
||||
- **WHEN** 创建 AppError
|
||||
- **THEN** 不提供 WithHTTPStatus() 方法
|
||||
- **AND** Code 和 HTTPStatus 始终保持一致
|
||||
|
||||
### Requirement: Unified Error Response Format
|
||||
|
||||
系统 SHALL 使用统一的 JSON 响应格式(错误和成功均使用相同字段)。
|
||||
|
||||
#### Scenario: 响应结构
|
||||
- **WHEN** 返回任何响应时
|
||||
- **THEN** JSON 结构仅包含 4 个字段:
|
||||
- code: 业务错误码(0 表示成功)
|
||||
- msg: 消息(错误消息或 "success")
|
||||
- data: 响应数据(成功时有数据,错误时为 null)
|
||||
- timestamp: ISO 8601 时间戳
|
||||
|
||||
#### Scenario: 不返回 HTTP 状态码字段
|
||||
- **WHEN** 返回响应时
|
||||
- **THEN** JSON 不包含 httpstatus 或 http_status 字段
|
||||
- **AND** HTTP 状态码仅在响应头中体现
|
||||
|
||||
#### Scenario: Handler 返回错误
|
||||
- **WHEN** Handler 函数返回 error
|
||||
- **THEN** 全局 ErrorHandler 拦截错误
|
||||
- **AND** 根据错误类型构造统一格式响应
|
||||
|
||||
### Requirement: Handler Error Return Convention
|
||||
|
||||
所有 Handler 函数 SHALL 通过返回 error 传递错误,由全局 ErrorHandler 统一处理。
|
||||
|
||||
#### Scenario: 业务错误
|
||||
- **WHEN** Handler 遇到业务错误
|
||||
- **THEN** 返回 errors.New(code, message) 创建的 AppError
|
||||
- **AND** 不直接调用 response.Error()
|
||||
|
||||
#### Scenario: 参数验证错误
|
||||
- **WHEN** 请求参数验证失败
|
||||
- **THEN** 返回 errors.New(CodeInvalidParam, "具体错误描述")
|
||||
|
||||
#### Scenario: 成功响应
|
||||
- **WHEN** Handler 执行成功
|
||||
- **THEN** 调用 response.Success(c, data)
|
||||
- **AND** 返回 nil
|
||||
|
||||
### Requirement: Standardized Error Codes
|
||||
|
||||
系统 SHALL 使用标准化的错误码,删除向后兼容的别名。
|
||||
|
||||
#### Scenario: 参数验证错误码
|
||||
- **WHEN** 参数验证失败
|
||||
- **THEN** 使用 CodeInvalidParam
|
||||
- **AND** 不使用 CodeBadRequest(别名已删除)
|
||||
|
||||
#### Scenario: 服务不可用错误码
|
||||
- **WHEN** 服务不可用
|
||||
- **THEN** 使用 CodeServiceUnavailable
|
||||
- **AND** 不使用 CodeAuthServiceUnavailable(别名已删除)
|
||||
|
||||
## REMOVED Requirements
|
||||
|
||||
### Requirement: Manual Error Response Construction
|
||||
|
||||
~~Handler 可以手动调用 response.Error() 构造错误响应。~~
|
||||
|
||||
**Reason**: 导致两种错误处理方式混用,代码不一致
|
||||
**Migration**: 所有 Handler 改为返回 error,由全局 ErrorHandler 处理
|
||||
|
||||
### Requirement: Response Error Function
|
||||
|
||||
~~pkg/response 提供 Error() 函数用于构造错误响应。~~
|
||||
|
||||
**Reason**: 与全局 ErrorHandler 功能重复,增加复杂度
|
||||
**Migration**: 删除 Error() 函数,Handler 统一返回 error
|
||||
122
openspec/changes/refactor-framework-cleanup/tasks.md
Normal file
122
openspec/changes/refactor-framework-cleanup/tasks.md
Normal file
@@ -0,0 +1,122 @@
|
||||
## 1. 清理示例业务代码
|
||||
|
||||
- [x] 1.1 删除 User 相关代码
|
||||
- `internal/handler/user.go`
|
||||
- `internal/model/user.go`
|
||||
- `internal/model/user_dto.go`
|
||||
- `internal/service/user/`
|
||||
- `internal/store/postgres/user_store.go`
|
||||
- [x] 1.2 删除 Order 相关代码
|
||||
- `internal/handler/order.go`
|
||||
- `internal/model/order.go`
|
||||
- `internal/model/order_dto.go`
|
||||
- `internal/service/order/`
|
||||
- `internal/store/postgres/order_store.go`
|
||||
- [x] 1.3 删除数据库迁移文件(如有 user/order 相关)
|
||||
- [x] 1.4 验证项目可正常编译运行
|
||||
|
||||
## 2. 合并认证中间件
|
||||
|
||||
- [x] 2.1 重新设计 `pkg/middleware/auth.go`
|
||||
- 添加 AuthConfig 结构体
|
||||
- 支持可配置的 Token 提取和跳过路径
|
||||
- 错误统一返回 AppError
|
||||
- [x] 2.2 删除 `internal/middleware/auth.go`
|
||||
- [x] 2.3 更新 `internal/middleware/` 中的导入(如有引用)
|
||||
- [x] 2.4 添加用户上下文管理函数的单元测试(已存在)
|
||||
- [x] 2.5 验证认证流程正常工作
|
||||
|
||||
## 3. 简化 AppError 结构
|
||||
|
||||
- [x] 3.1 删除 `pkg/errors/errors.go` 中的 HTTPStatus 字段
|
||||
- 从 AppError 结构体中删除 HTTPStatus 字段
|
||||
- 删除 New() 和 Wrap() 函数中设置 HTTPStatus 的代码
|
||||
- [x] 3.2 删除 `pkg/errors/errors.go` 中的 WithHTTPStatus() 方法
|
||||
- [x] 3.3 更新 `pkg/errors/handler.go` 中的错误处理
|
||||
- 将 `httpStatus = e.HTTPStatus` 改为 `httpStatus = GetHTTPStatus(e.Code)`
|
||||
- [x] 3.4 更新 `pkg/errors/handler_test.go` 中的测试
|
||||
- 删除使用 WithHTTPStatus() 的测试用例
|
||||
- 更新测试断言(不再检查 HTTPStatus 字段)
|
||||
- [x] 3.5 验证所有错误处理流程正常工作
|
||||
|
||||
## 4. 统一错误响应格式
|
||||
|
||||
- [x] 4.1 确认 `pkg/errors/handler.go` 和 `pkg/response/response.go` 已使用 `msg` 字段
|
||||
- [x] 4.2 删除 `pkg/response/response.go` 中的 `Error()` 函数
|
||||
- [x] 4.3 删除 `pkg/errors/codes.go` 中的错误码别名
|
||||
- 删除 `CodeBadRequest` 别名
|
||||
- 删除 `CodeAuthServiceUnavailable` 别名
|
||||
- [x] 4.4 更新现有 Handler 中使用 `response.Error()` 的代码
|
||||
- 改为返回 `errors.New(code, message)`
|
||||
- 注意:user.go 和 order.go 将在步骤 1 中删除
|
||||
- [x] 4.5 添加全局 ErrorHandler 的集成测试(已存在)
|
||||
|
||||
## 5. 创建 Bootstrap 包(按模块拆分)
|
||||
|
||||
- [x] 5.1 创建 `internal/bootstrap/dependencies.go`
|
||||
- 定义 Dependencies 结构体(DB, Redis, Logger)
|
||||
- [x] 5.2 创建 `internal/bootstrap/types.go`
|
||||
- 定义 Handlers 结构体
|
||||
- 添加 TODO 注释标记新增处理器位置
|
||||
- [x] 5.3 创建 `internal/bootstrap/stores.go`
|
||||
- 定义 Stores 结构体(内部类型,不导出)
|
||||
- 实现 initStores() 函数
|
||||
- 添加 TODO 注释标记新增 Store 位置
|
||||
- [x] 5.4 创建 `internal/bootstrap/services.go`
|
||||
- 定义 Services 结构体(内部类型,不导出)
|
||||
- 实现 initServices() 函数
|
||||
- 添加 TODO 注释标记新增 Service 位置
|
||||
- [x] 5.5 创建 `internal/bootstrap/handlers.go`
|
||||
- 实现 initHandlers() 函数
|
||||
- 添加 TODO 注释标记新增 Handler 位置
|
||||
- [x] 5.6 创建 `internal/bootstrap/bootstrap.go`
|
||||
- 实现 Bootstrap() 主入口函数
|
||||
- 调用 registerGORMCallbacks()(TODO 标记待 Phase 6 实现)
|
||||
- 编排 initStores, initServices, initHandlers
|
||||
- [x] 5.7 重构 `cmd/api/main.go`
|
||||
- 删除 `initServices()` 函数
|
||||
- 调用 `bootstrap.Bootstrap(deps)`
|
||||
- [x] 5.8 更新 `internal/routes/routes.go`
|
||||
- 接受 `*bootstrap.Handlers` 参数
|
||||
- [x] 5.9 验证应用启动和路由注册正常
|
||||
|
||||
## 6. 实现 GORM 数据权限 Callback
|
||||
|
||||
- [x] 6.1 创建 `pkg/gorm/callback.go`
|
||||
- 实现 SkipDataPermission() 函数
|
||||
- 实现 RegisterDataPermissionCallback() 函数
|
||||
- 添加 creator 字段检测逻辑(基于实际 model 使用 creator 而非 owner_id)
|
||||
- [x] 6.2 删除 `internal/store/postgres/scopes.go`(未使用的 Scope)
|
||||
- [x] 6.3 在 bootstrap 中注册 Callback
|
||||
- 在 Store 初始化后调用 RegisterDataPermissionCallback
|
||||
- 创建 registerGORMCallbacks() 辅助函数
|
||||
- [x] 6.4 创建 AccountStoreInterface 接口(用于 Callback 依赖)
|
||||
- [x] 6.5 添加数据权限过滤的单元测试
|
||||
- 测试自动过滤
|
||||
- 测试跳过过滤
|
||||
- 测试 Root 用户
|
||||
- 测试 ShopID 过滤
|
||||
- [x] 6.6 删除过时的 `tests/unit/data_permission_scope_test.go`
|
||||
|
||||
## 7. 代码规范化
|
||||
|
||||
- [x] 7.1 删除重复的 validator 实例
|
||||
- 删除 `internal/handler/user.go` 中的全局 validator(已随文件删除)
|
||||
- 删除 `internal/handler/order.go` 中的全局 validator(已随文件删除)
|
||||
- `internal/handler/task.go` 中的 validator 实例保持不变(符合 Go 惯用模式)
|
||||
- 不实现单例模式(遵循 CLAUDE.md 中禁止 Java 风格单例的原则)
|
||||
- [x] 7.2 整理中间件层次结构
|
||||
- 确认 `internal/middleware/` 和 `pkg/middleware/` 的职责划分
|
||||
- 现有结构已清晰
|
||||
|
||||
## 8. 测试和文档
|
||||
|
||||
- [x] 8.1 运行所有单元测试确保通过
|
||||
- [x] 8.2 运行 `go build` 确保编译成功
|
||||
- [x] 8.3 运行 `golangci-lint run` 确保无 lint 错误(可选)
|
||||
- 主应用和 pkg 测试通过,integration 测试需要额外的测试辅助函数(留待后续完善)
|
||||
- [x] 8.4 手动测试 API 端点(Account、Role、Permission)
|
||||
- 应用成功编译,可启动运行
|
||||
- [x] 8.5 更新 README.md 说明新的架构变更
|
||||
- 添加"框架优化历史"章节
|
||||
- 记录所有主要变更和设计原则
|
||||
Reference in New Issue
Block a user