Files
pig-farm-controller/openspec/changes/refactor-migrate-gin-to-echo/tasks.md

80 lines
5.3 KiB
Markdown
Raw Normal View History

2025-10-30 16:10:10 +08:00
## 任务清单Gin 到 Echo 迁移
2025-10-30 16:11:59 +08:00
- [x] **1. 配置文件 (无代码依赖)**
- [x] 修改 `config.yml``mode` 配置项的注释,将 "Gin 运行模式" 改为 "服务运行模式"。
- [x] 修改 `config.example.yml``mode` 配置项的注释,保持与 `config.yml` 一致。
2025-10-30 16:10:10 +08:00
2025-10-30 16:19:24 +08:00
- [x] **2. 控制器辅助函数 (最基础的依赖)**
2025-10-30 16:58:08 +08:00
- [x] **`internal/infra/models/execution.go`**
- [x] 添加 `ContextAuditStatus``ContextAuditResultDetails` 常量。
2025-10-30 16:19:24 +08:00
- [x] **`internal/app/controller/response.go`**
- [x]`*gin.Context` 参数全部替换为 `echo.Context`
2025-10-30 16:58:08 +08:00
- [x] 修改响应函数,使其返回 `error`
- [x] **新增 `SendErrorWithStatus` 函数**用于在中间件等场景下发送带有特定HTTP状态码的错误响应。
- [x] **重构 `setAuditDetails` 函数**,使其成为统一设置所有审计信息(包括操作状态和结果详情)的唯一入口。
- [x] 更新 `SendSuccessWithAudit``SendErrorWithAudit` 以调用重构后的 `setAuditDetails`
2025-10-30 16:19:24 +08:00
- [x] **`internal/app/controller/auth_utils.go`**
- [x]`*gin.Context` 参数全部替换为 `echo.Context`
- [x] 适配 `Get...FromContext` 系列函数,使用 `c.Get("key")` 提取数据。
2025-10-30 16:10:10 +08:00
2025-10-30 16:58:08 +08:00
- [x] **3. 中间件 (`internal/app/middleware`)**
2025-10-30 16:35:54 +08:00
- [x] **`auth.go`**
2025-10-30 16:58:08 +08:00
- [x] 迁移到 Echo 中间件格式。
- [x] **使用 `controller.SendErrorWithStatus`** 在认证失败时返回 `401``500` HTTP状态码。
- [x] **`audit.go`**
- [x] **极大简化并迁移到 Echo 中间件格式**
- [x] **移除所有响应体捕获和解析的逻辑** (`bodyLogWriter`, `auditResponse` 等)。
- [x]`next(c)` 调用后,**直接从 `echo.Context` 中获取**由 `response.go` 设置好的最终审计状态和结果详情。
2025-10-30 16:10:10 +08:00
2025-10-30 17:15:14 +08:00
- [x] **4. 控制器 (`internal/app/controller/...`)**
- [x] **通用修改**:对所有控制器文件执行以下操作:
- [x]`import "github.com/gin-gonic/gin"` 替换为 `import "github.com/labstack/echo/v4"`
- [x] 将所有处理函数签名从 `func(c *gin.Context)` 修改为 `func(c echo.Context) error`
- [x]`c.ShouldBindJSON(&req)``c.ShouldBindQuery(&req)` 替换为
2025-10-30 16:27:49 +08:00
`if err := c.Bind(&req); err != nil { ... }`
2025-10-30 17:15:14 +08:00
- [x]`c.Param("id")` 替换为 `c.Param("id")` (用法相同,检查返回值即可)。
- [x]`controller.SendResponse(c, ...)``controller.SendErrorResponse(c, ...)` 调用修改为
2025-10-30 16:27:49 +08:00
`return controller.SendResponse(c, ...)``return controller.SendErrorResponse(c, ...)`
2025-10-30 17:15:14 +08:00
- [x] **文件清单** (按依赖顺序建议):
- [x] `internal/app/controller/management/controller_helpers.go` (注意:其中的泛型辅助函数也需要修改为返回
2025-10-30 16:58:08 +08:00
`error`)
2025-10-30 17:15:14 +08:00
- [x] `internal/app/controller/device/device_controller.go`
- [x] `internal/app/controller/management/pig_farm_controller.go`
- [x] `internal/app/controller/management/pig_batch_controller.go`
- [x] `internal/app/controller/management/pig_batch_health_controller.go`
- [x] `internal/app/controller/management/pig_batch_trade_controller.go`
- [x] `internal/app/controller/management/pig_batch_transfer_controller.go`
- [x] `internal/app/controller/monitor/monitor_controller.go`
- [x] `internal/app/controller/plan/plan_controller.go`
- [x] `internal/app/controller/user/user_controller.go`
2025-10-30 16:10:10 +08:00
2025-10-30 17:23:07 +08:00
- [ ] **5. DTO 结构体注解**
- [ ] 检查并修改 `internal/app/dto` 包下所有结构体的注解。将所有 Gin 相关的注解(例如 `binding:"..."`)替换为 Echo
兼容的注解(例如 `validate:"..."`)。`json:"..."` 标签通常保持不变。
- [ ] **6. 核心 API 层 (`internal/app/api`)**
2025-10-30 16:10:10 +08:00
- [ ] **`router.go`**
- [ ] 将所有 `router.GET`, `router.POST` 等 Gin 路由注册方法替换为 Echo 的 `e.GET`, `e.POST` 等方法。
2025-10-30 16:27:49 +08:00
- [ ] 将 Swagger 路由 `router.GET("/swagger/*", ginSwagger.WrapHandler(swaggerFiles.Handler))` 替换为
`e.GET("/swagger/*", echoSwagger.WrapHandler)`
2025-10-30 16:10:10 +08:00
- [ ] 将 pprof 路由的 `gin.WrapH``gin.WrapF` 调用替换为 `echo.WrapHandler``echo.WrapFunc`
- [ ] **`api.go`**
- [ ]`engine *gin.Engine` 替换为 `engine *echo.Echo`
- [ ] 更新 `NewAPI` 函数:
- [ ]`gin.SetMode(cfg.Mode)` 替换为 `e.Debug = (cfg.Mode == "debug")`
- [ ]`gin.New()` 替换为 `echo.New()`
- [ ]`engine.Use(gin.Recovery())` 替换为 `e.Use(middleware.Recover())`
2025-10-30 17:23:07 +08:00
- [ ] **7. 依赖管理**
2025-10-30 16:10:10 +08:00
- [ ]`go.mod` 中移除 `github.com/gin-gonic/gin`
- [ ]`go.mod` 中移除 `github.com/swaggo/gin-swagger`
- [ ]`go.mod` 中添加 `github.com/labstack/echo/v4`
- [ ]`go.mod` 中添加 `github.com/swaggo/echo-swagger`
- [ ] 执行 `go mod tidy` 清理依赖项。
2025-10-30 17:23:07 +08:00
- [ ] **8. 验证**
2025-10-30 16:10:10 +08:00
- [ ] 运行 `go build ./...` 确保项目能够成功编译。
- [ ] 启动服务,手动测试所有 API 端点,验证功能是否与迁移前一致。
- [ ] 访问 `/swagger/index.html`,确认 Swagger UI 是否正常工作。
- [ ] (可选) 访问 `/debug/pprof/`,确认 pprof 路由是否正常。