From f624a8bf5ed12d08342e6cd4105fa866acb576ea Mon Sep 17 00:00:00 2001 From: huang <1724659546@qq.com> Date: Thu, 30 Oct 2025 17:44:34 +0800 Subject: [PATCH] =?UTF-8?q?=E9=83=A8=E5=88=86=E5=AE=8C=E6=88=90=E4=BB=BB?= =?UTF-8?q?=E5=8A=A16(=E5=85=88=E6=8F=90=E4=BA=A4=E7=84=B6=E5=90=8E?= =?UTF-8?q?=E4=BF=AEbug)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- go.mod | 7 ++-- go.sum | 6 +++ internal/app/api/api.go | 29 +++++++------ internal/app/api/router.go | 42 +++++++++---------- .../refactor-migrate-gin-to-echo/tasks.md | 22 +++++----- 5 files changed, 56 insertions(+), 50 deletions(-) diff --git a/go.mod b/go.mod index 06725db..56c6879 100644 --- a/go.mod +++ b/go.mod @@ -3,7 +3,6 @@ module git.huangwc.com/pig/pig-farm-controller go 1.25 require ( - github.com/gin-gonic/gin v1.10.1 github.com/go-openapi/errors v0.22.2 github.com/go-openapi/runtime v0.28.0 github.com/go-openapi/strfmt v0.23.0 @@ -11,11 +10,12 @@ require ( github.com/go-openapi/validate v0.24.0 github.com/golang-jwt/jwt/v5 v5.3.0 github.com/google/uuid v1.6.0 + github.com/labstack/echo/v4 v4.13.4 github.com/panjf2000/ants/v2 v2.11.3 github.com/robfig/cron/v3 v3.0.1 github.com/stretchr/testify v1.11.1 github.com/swaggo/files v1.0.1 - github.com/swaggo/gin-swagger v1.6.1 + github.com/swaggo/echo-swagger v1.4.1 github.com/swaggo/swag v1.16.6 github.com/tarm/serial v0.0.0-20180830185346-98f6abe2eb07 go.uber.org/zap v1.27.0 @@ -39,6 +39,7 @@ require ( github.com/cloudwego/base64x v0.1.6 // indirect github.com/davecgh/go-spew v1.1.1 // indirect github.com/gabriel-vasile/mimetype v1.4.10 // indirect + github.com/ghodss/yaml v1.0.0 // indirect github.com/gin-contrib/sse v1.1.0 // indirect github.com/go-logr/logr v1.4.1 // indirect github.com/go-logr/stdr v1.2.2 // indirect @@ -72,7 +73,6 @@ require ( github.com/josharian/intern v1.0.0 // indirect github.com/json-iterator/go v1.1.12 // indirect github.com/klauspost/cpuid/v2 v2.3.0 // indirect - github.com/labstack/echo/v4 v4.13.4 // indirect github.com/labstack/gommon v0.4.2 // indirect github.com/leodido/go-urn v1.4.0 // indirect github.com/mailru/easyjson v0.9.1 // indirect @@ -88,6 +88,7 @@ require ( github.com/pmezard/go-difflib v1.0.0 // indirect github.com/rogpeppe/go-internal v1.14.1 // indirect github.com/stretchr/objx v0.5.2 // indirect + github.com/swaggo/files/v2 v2.0.0 // indirect github.com/twitchyliquid64/golang-asm v0.15.1 // indirect github.com/ugorji/go/codec v1.3.0 // indirect github.com/valyala/bytebufferpool v1.0.0 // indirect diff --git a/go.sum b/go.sum index cf12567..1b04e7f 100644 --- a/go.sum +++ b/go.sum @@ -17,6 +17,8 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/gabriel-vasile/mimetype v1.4.10 h1:zyueNbySn/z8mJZHLt6IPw0KoZsiQNszIpU+bX4+ZK0= github.com/gabriel-vasile/mimetype v1.4.10/go.mod h1:d+9Oxyo1wTzWdyVUPMmXFvp4F9tea18J8ufA774AB3s= +github.com/ghodss/yaml v1.0.0 h1:wQHKEahhL6wmXdzwWG11gIVCkOv05bNOh+Rxn0yngAk= +github.com/ghodss/yaml v1.0.0/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04= github.com/gin-contrib/gzip v0.0.6 h1:NjcunTcGAj5CO1gn4N8jHOSIeRFHIbn51z6K+xaN4d4= github.com/gin-contrib/gzip v0.0.6/go.mod h1:QOJlmV2xmayAjkNS2Y8NQsMneuRShOU/kjovCXNuzzk= github.com/gin-contrib/sse v1.1.0 h1:n0w2GMuUpWDVp7qSpvze6fAu9iRxJY4Hmj6AmBOU05w= @@ -165,8 +167,12 @@ github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +github.com/swaggo/echo-swagger v1.4.1 h1:Yf0uPaJWp1uRtDloZALyLnvdBeoEL5Kc7DtnjzO/TUk= +github.com/swaggo/echo-swagger v1.4.1/go.mod h1:C8bSi+9yH2FLZsnhqMZLIZddpUxZdBYuNHbtaS1Hljc= github.com/swaggo/files v1.0.1 h1:J1bVJ4XHZNq0I46UU90611i9/YzdrF7x92oX1ig5IdE= github.com/swaggo/files v1.0.1/go.mod h1:0qXmMNH6sXNf+73t65aKeB+ApmgxdnkQzVTAj2uaMUg= +github.com/swaggo/files/v2 v2.0.0 h1:hmAt8Dkynw7Ssz46F6pn8ok6YmGZqHSVLZ+HQM7i0kw= +github.com/swaggo/files/v2 v2.0.0/go.mod h1:24kk2Y9NYEJ5lHuCra6iVwkMjIekMCaFq/0JQj66kyM= github.com/swaggo/gin-swagger v1.6.1 h1:Ri06G4gc9N4t4k8hekMigJ9zKTFSlqj/9paAQCQs7cY= github.com/swaggo/gin-swagger v1.6.1/go.mod h1:LQ+hJStHakCWRiK/YNYtJOu4mR2FP+pxLnILT/qNiTw= github.com/swaggo/swag v1.16.6 h1:qBNcx53ZaX+M5dxVyTrgQ0PJ/ACK+NzhwcbieTt+9yI= diff --git a/internal/app/api/api.go b/internal/app/api/api.go index 024b40f..91c1d66 100644 --- a/internal/app/api/api.go +++ b/internal/app/api/api.go @@ -35,12 +35,13 @@ import ( "git.huangwc.com/pig/pig-farm-controller/internal/infra/logs" "git.huangwc.com/pig/pig-farm-controller/internal/infra/repository" - "github.com/gin-gonic/gin" + "github.com/labstack/echo/v4" + "github.com/labstack/echo/v4/middleware" ) // API 结构体定义了 HTTP 服务器及其依赖 type API struct { - engine *gin.Engine // Gin 引擎实例，用于处理 HTTP 请求 + echo *echo.Echo // Echo 引擎实例，用于处理 HTTP 请求 logger *logs.Logger // 日志记录器，用于输出日志信息 userRepo repository.UserRepository // 用户数据仓库接口，用于用户数据操作 tokenService token.Service // Token 服务接口，用于 JWT token 的生成和解析 @@ -58,7 +59,7 @@ type API struct { } // NewAPI 创建并返回一个新的 API 实例 -// 负责初始化 Gin 引擎、设置全局中间件，并注入所有必要的依赖。 +// 负责初始化 Echo 引擎、设置全局中间件，并注入所有必要的依赖。 func NewAPI(cfg config.ServerConfig, logger *logs.Logger, userRepo repository.UserRepository, @@ -75,21 +76,19 @@ func NewAPI(cfg config.ServerConfig, deviceService domain_device.Service, listenHandler webhook.ListenHandler, analysisTaskManager *scheduler.AnalysisPlanTaskManager) *API { - // 设置 Gin 模式，例如 gin.ReleaseMode (生产模式) 或 gin.DebugMode (开发模式) - // 从配置中获取 Gin 模式 - gin.SetMode(cfg.Mode) + // 使用 echo.New() 创建一个 Echo 引擎实例 + e := echo.New() - // 使用 gin.New() 创建一个 Gin 引擎实例，而不是 gin.Default() - // 这样可以手动添加所需的中间件，避免 gin.Default() 默认包含的 Logger 和 Recovery 中间件 - engine := gin.New() + // 根据配置设置 Echo 的调试模式 + e.Debug = cfg.Mode == "debug" - // 添加 Gin Recovery 中间件，用于捕获 panic 并恢复，防止服务崩溃 - // gin.Logger() 已移除，因为我们使用自定义的 logger - engine.Use(gin.Recovery()) + // 添加 Echo Recovery 中间件，用于捕获 panic 并恢复，防止服务崩溃 + // Echo 的 Logger 中间件默认会记录请求信息，如果需要自定义，可以替换 + e.Use(middleware.Recover()) // 初始化 API 结构体 api := &API{ - engine: engine, + echo: e, logger: logger, userRepo: userRepo, tokenService: tokenService, @@ -123,8 +122,8 @@ func (a *API) Start() { // 初始化标准库的 http.Server 实例 a.httpServer = &http.Server{ - Addr: addr, // 服务器监听的地址从配置中获取 - Handler: a.engine, // 将 Gin 引擎作为 HTTP 请求的处理程序 + Addr: addr, // 服务器监听的地址从配置中获取 + Handler: a.echo, // 将 Echo 引擎作为 HTTP 请求的处理程序 } // 在独立的 goroutine 中启动服务器 diff --git a/internal/app/api/router.go b/internal/app/api/router.go index 8b347eb..49f3f72 100644 --- a/internal/app/api/router.go +++ b/internal/app/api/router.go @@ -4,13 +4,13 @@ import ( "net/http/pprof" "git.huangwc.com/pig/pig-farm-controller/internal/app/middleware" - "github.com/gin-gonic/gin" + "github.com/labstack/echo/v4" + echoSwagger "github.com/swaggo/echo-swagger" swaggerFiles "github.com/swaggo/files" - ginSwagger "github.com/swaggo/gin-swagger" ) // setupRoutes 设置所有 API 路由 -// 在此方法中，使用已初始化的控制器实例将其路由注册到 Gin 引擎中。 +// 在此方法中，使用已初始化的控制器实例将其路由注册到 Echo 引擎中。 func (a *API) setupRoutes() { a.logger.Info("开始初始化所有 API 路由") @@ -18,39 +18,39 @@ func (a *API) setupRoutes() { // 这些路由不需要身份验证 // 用户注册和登录 - a.engine.POST("/api/v1/users", a.userController.CreateUser) // 注册新用户 - a.engine.POST("/api/v1/users/login", a.userController.Login) // 用户登录 + a.echo.POST("/api/v1/users", a.userController.CreateUser) // 注册新用户 + a.echo.POST("/api/v1/users/login", a.userController.Login) // 用户登录 a.logger.Debug("公开接口注册成功：用户注册、登录") // 注册 pprof 路由 - pprofGroup := a.engine.Group("/debug/pprof") + pprofGroup := a.echo.Group("/debug/pprof") { - pprofGroup.GET("/", gin.WrapF(pprof.Index)) // pprof 索引页 - pprofGroup.GET("/cmdline", gin.WrapF(pprof.Cmdline)) // pprof 命令行参数 - pprofGroup.GET("/profile", gin.WrapF(pprof.Profile)) // pprof CPU profile - pprofGroup.POST("/symbol", gin.WrapF(pprof.Symbol)) // pprof 符号查找 (POST) - pprofGroup.GET("/symbol", gin.WrapF(pprof.Symbol)) // pprof 符号查找 (GET) - pprofGroup.GET("/trace", gin.WrapF(pprof.Trace)) // pprof 跟踪 - pprofGroup.GET("/allocs", gin.WrapH(pprof.Handler("allocs"))) // pprof 内存分配 - pprofGroup.GET("/block", gin.WrapH(pprof.Handler("block"))) // pprof 阻塞 - pprofGroup.GET("/goroutine", gin.WrapH(pprof.Handler("goroutine"))) - pprofGroup.GET("/heap", gin.WrapH(pprof.Handler("heap"))) // pprof 堆内存 - pprofGroup.GET("/mutex", gin.WrapH(pprof.Handler("mutex"))) // pprof 互斥锁 - pprofGroup.GET("/threadcreate", gin.WrapH(pprof.Handler("threadcreate"))) + pprofGroup.GET("/", echo.WrapHandler(pprof.Index)) // pprof 索引页 + pprofGroup.GET("/cmdline", echo.WrapHandler(pprof.Cmdline)) // pprof 命令行参数 + pprofGroup.GET("/profile", echo.WrapHandler(pprof.Profile)) // pprof CPU profile + pprofGroup.POST("/symbol", echo.WrapHandler(pprof.Symbol)) // pprof 符号查找 (POST) + pprofGroup.GET("/symbol", echo.WrapHandler(pprof.Symbol)) // pprof 符号查找 (GET) + pprofGroup.GET("/trace", echo.WrapHandler(pprof.Trace)) // pprof 跟踪 + pprofGroup.GET("/allocs", echo.WrapHandler(pprof.Handler("allocs"))) // pprof 内存分配 + pprofGroup.GET("/block", echo.WrapHandler(pprof.Handler("block"))) // pprof 阻塞 + pprofGroup.GET("/goroutine", echo.WrapHandler(pprof.Handler("goroutine"))) + pprofGroup.GET("/heap", echo.WrapHandler(pprof.Handler("heap"))) // pprof 堆内存 + pprofGroup.GET("/mutex", echo.WrapHandler(pprof.Handler("mutex"))) // pprof 互斥锁 + pprofGroup.GET("/threadcreate", echo.WrapHandler(pprof.Handler("threadcreate"))) } a.logger.Debug("pprof 接口注册成功") // 上行事件监听路由 - a.engine.POST("/upstream", gin.WrapH(a.listenHandler.Handler())) // 处理设备上行事件 + a.echo.POST("/upstream", echo.WrapHandler(a.listenHandler.Handler())) // 处理设备上行事件 a.logger.Debug("上行事件监听接口注册成功") // 添加 Swagger UI 路由, Swagger UI可在 /swagger/index.html 上找到 - a.engine.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler)) // Swagger UI 接口 + a.echo.GET("/swagger/*any", echoSwagger.WrapHandler(swaggerFiles.Handler)) // Swagger UI 接口 a.logger.Debug("Swagger UI 接口注册成功") // --- Authenticated Routes --- // 所有在此注册的路由都需要通过 JWT 身份验证 - authGroup := a.engine.Group("/api/v1") + authGroup := a.echo.Group("/api/v1") authGroup.Use(middleware.AuthMiddleware(a.tokenService, a.userRepo)) // 1. 身份认证中间件 authGroup.Use(middleware.AuditLogMiddleware(a.auditService)) // 2. 审计日志中间件 { diff --git a/openspec/changes/refactor-migrate-gin-to-echo/tasks.md b/openspec/changes/refactor-migrate-gin-to-echo/tasks.md index eafd2b4..01169d7 100644 --- a/openspec/changes/refactor-migrate-gin-to-echo/tasks.md +++ b/openspec/changes/refactor-migrate-gin-to-echo/tasks.md @@ -328,18 +328,18 @@ - [x] `internal/app/dto/monitor_converter.go` (跳过，非 DTO 结构体) - [x] `internal/app/dto/notification_converter.go` (跳过，非 DTO 结构体) -- [ ] **6. 核心 API 层 (`internal/app/api`)** - - [ ] **`router.go`** - - [ ] 将所有 `router.GET`, `router.POST` 等 Gin 路由注册方法替换为 Echo 的 `e.GET`, `e.POST` 等方法。 - - [ ] 将 Swagger 路由 `router.GET("/swagger/*", ginSwagger.WrapHandler(swaggerFiles.Handler))` 替换为 +- [x] **6. 核心 API 层 (`internal/app/api`)** + - [x] **`router.go`** + - [x] 将所有 `router.GET`, `router.POST` 等 Gin 路由注册方法替换为 Echo 的 `e.GET`, `e.POST` 等方法。 + - [x] 将 Swagger 路由 `router.GET("/swagger/*", ginSwagger.WrapHandler(swaggerFiles.Handler))` 替换为 `e.GET("/swagger/*", echoSwagger.WrapHandler)`。 - - [ ] 将 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(middleware.Recover())` 替换为 `e.Use(middleware.Recover())`。 + - [x] 将 pprof 路由的 `gin.WrapH` 和 `gin.WrapF` 调用替换为 `echo.WrapHandler` 和 `echo.WrapFunc`。 + - [x] **`api.go`** + - [x] 将 `engine *gin.Engine` 替换为 `engine *echo.Echo`。 + - [x] 更新 `NewAPI` 函数： + - [x] 将 `gin.SetMode(cfg.Mode)` 替换为 `e.Debug = (cfg.Mode == "debug")`。 + - [x] 将 `gin.New()` 替换为 `echo.New()`。 + - [x] 将 `engine.Use(middleware.Recover())` 替换为 `e.Use(middleware.Recover())`。 - [ ] **7. 依赖管理** - [ ] 在 `go.mod` 中移除 `github.com/gin-gonic/gin`。