如何优化Go语言REST API的路由实现方式？

1. 精细化控制中间件作用范围 #

你当前把AuthMiddleware挂载在全局，除/health外的所有请求都会执行该中间件，但实际上只有v1分组需要认证。将中间件移到对应分组，避免无意义的中间件执行开销：

func NewRouter() *gin.Engine {
    router := gin.New()
    router.Use(gin.Logger())
    router.Use(gin.Recovery())

    health := new(controllers.HealthController)
    router.GET("/health", health.Status)

    // 仅给v1分组挂载认证中间件
    v1 := router.Group("v1")
    v1.Use(middlewares.AuthMiddleware())
    {
        userGroup := v1.Group("user")
        {
            user := new(controllers.UserController)
            userGroup.GET("/:id", user.Retrieve)
        }
    }
    return router
}

2. 复用控制器实例 #

当前在路由分组内重复创建控制器实例，高并发场景下会增加对象创建开销。提前创建实例并复用：

func NewRouter() *gin.Engine {
    router := gin.New()
    router.Use(gin.Logger())
    router.Use(gin.Recovery())

    // 提前创建所有需要的控制器实例，全局复用
    healthCtrl := new(controllers.HealthController)
    userCtrl := new(controllers.UserController)

    router.GET("/health", healthCtrl.Status)

    v1 := router.Group("v1")
    v1.Use(middlewares.AuthMiddleware())
    {
        userGroup := v1.Group("user")
        userGroup.GET("/:id", userCtrl.Retrieve)
        // 后续新增user相关路由直接复用userCtrl
    }
    return router
}

3. 路由模块化拆分 #

随着路由增多，NewRouter会逐渐臃肿。将不同版本/模块的路由拆分到单独函数，提升代码可读性和扩展性：

func NewRouter() *gin.Engine {
    router := gin.New()
    router.Use(gin.Logger())
    router.Use(gin.Recovery())

    setupHealthRoutes(router)
    setupV1Routes(router)

    return router
}

// 单独拆分健康检查路由
func setupHealthRoutes(router *gin.Engine) {
    healthCtrl := new(controllers.HealthController)
    router.GET("/health", healthCtrl.Status)
}

// 单独拆分v1版本路由
func setupV1Routes(router *gin.Engine) {
    userCtrl := new(controllers.UserController)
    
    v1 := router.Group("v1")
    v1.Use(middlewares.AuthMiddleware())
    {
        userGroup := v1.Group("user")
        userGroup.GET("/:id", userCtrl.Retrieve)
    }
}

4. 简化路由分组写法 #

Gin的分组大括号是可选的，去掉后代码更简洁，不影响可读性：

func setupV1Routes(router *gin.Engine) {
    userCtrl := new(controllers.UserController)
    
    v1 := router.Group("v1").Use(middlewares.AuthMiddleware())
    userGroup := v1.Group("user")
    userGroup.GET("/:id", userCtrl.Retrieve)
}

5. 优化路由匹配顺序 #

Gin按路由注册顺序进行匹配，避免把模糊路由（如/:id）放在具体路由前面，否则会导致具体路由无法被匹配。比如新增/user/list时要放在/user/:id之前：

userGroup.GET("/list", userCtrl.List)
userGroup.GET("/:id", userCtrl.Retrieve)

内容的提问来源于stack exchange，提问作者Chetan Patankar