部分完成任务6(先提交然后修bug)
This commit is contained in:
@@ -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 中启动服务器
|
||||
|
||||
@@ -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. 审计日志中间件
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user