gin框架 路由拆分与注册

1. 基本的路由注册

下面最基础的 gin 路由注册方式，适用于路由条目比较少的简单项目或者项目 demo。

package main

import (
    "net/http"
    "github.com/gin-gonic/gin"
)

func helloHandler(c *gin.Context) {
    c.JSON(http.StatusOK, gin.H{
        "message": "Hello www.aizws.net!",
    })
}

func main() {
    engine := gin.Default()
    engine.GET("/aizws", helloHandler)
    if err := engine.Run(); err != nil {
        fmt.Println("startup service failed, err:%v\n", err)
    }
}

2. 路由拆分成单独文件或包

当项目的规模增大后就不太适合继续在项目的 main.go 文件中去实现路由注册相关逻辑了，我们会倾向于把路由部分的代码都拆分出来，形成一个单独的文件或包：

我们在routers.go文件中定义并注册路由信息：

package main

import (
    "net/http"
    "github.com/gin-gonic/gin"
)

func helloHandler(c *gin.Context) {
    c.JSON(http.StatusOK, gin.H{
        "message": "Hello www.aizws.net!",
    })
}

func setupRouter() *gin.Engine {
    engine := gin.Default()
    engine.GET("/aizws", helloHandler)
    return engine
}

此时 main.go 中调用上面定义好的 setupRouter 函数：

func main() {
    engine := setupRouter()
    if err := engine.Run(); err != nil {
        fmt.Println("startup service failed, err:%v\n", err)
    }
}

此时的目录结构：

gin_demo
├── go.mod
├── go.sum
├── main.go
└── routers.go

把路由部分的代码单独拆分成包的话也是可以的，拆分后的目录结构如下：

gin_demo
├── go.mod
├── go.sum
├── main.go
└── routers
    └── routers.go

routers/routers.go 需要注意此时 setupRouter 需要改成首字母大写：

package routers

import (
    "net/http"
    "github.com/gin-gonic/gin"
)

func helloHandler(c *gin.Context) {
    c.JSON(http.StatusOK, gin.H{
        "message": "Hello www.aizws.net",
    })
}

// SetupRouter 配置路由信息
func SetupRouter() *gin.Engine {
    r := gin.Default()
    r.GET("/aizws", helloHandler)
    return r
}

main.go文件内容如下：

package main

import (
    "fmt"
    "gin_demo/routers"
)

func main() {
    engine := routers.SetupRouter()
    if err := engine.Run(); err != nil {
        fmt.Println("startup service failed, err:%v\n", err)
    }
}

3. 路由拆分成多个文件

当我们的业务规模继续膨胀，单独的一个 routers 文件或包已经满足不了我们的需求了：

func SetupRouter() *gin.Engine {
    engine := gin.Default()
    engine.GET("/aizws", helloHandler)
    engine.GET("/xx1", xxHandler1)
    ...
    engine.GET("/xx30", xxHandler30)
    return engine
}

因为我们把所有的路由注册都写在一个 SetupRouter 函数中的话就会太复杂了。

我们可以分开定义多个路由文件，例如：

gin_demo
├── go.mod
├── go.sum
├── main.go
└── routers
    ├── blog.go
    └── shop.go

routers/shop.go 中添加一个 LoadShop 的函数，将 shop 相关的路由注册到指定的路由器：

func LoadShop(e *gin.Engine)  {
    e.GET("/hello", helloHandler)
    e.GET("/goods", goodsHandler)
    e.GET("/checkout", checkoutHandler)
    ...
}

routers/blog.go 中添加一个 LoadBlog 的函数，将 blog 相关的路由注册到指定的路由器：

func LoadBlog(e *gin.Engine) {
    e.GET("/post", postHandler)
    e.GET("/comment", commentHandler)
    ...
}

在 main 函数中实现最终的注册逻辑如下：

func main() {
    engine := gin.Default()
    routers.LoadBlog(engine)
    routers.LoadShop(engine)
    if err := engine.Run(); err != nil {
        fmt.Println("startup service failed, err:%v\n", err)
    }
}

4. 路由拆分到不同的 APP

有时候项目规模实在太大，那么我们就更倾向于把业务拆分的更详细一些，例如把不同的业务代码拆分成不同的 APP。

因此我们在项目目录下单独定义一个app目录，用来存放我们不同业务线的代码文件，这样就很容易进行横向扩展。大致目录结构如下：

gin_demo
├── app
│   ├── blog
│   │   ├── handler.go
│   │   └── router.go
│   └── shop
│       ├── handler.go
│       └── router.go
├── go.mod
├── go.sum
├── main.go
└── routers
    └── routers.go

其中app/blog/router.go用来定义post相关路由信息，具体内容如下：

func Routers(e *gin.Engine) {
    e.GET("/post", postHandler)
    e.GET("/comment", commentHandler)
}

app/shop/router.go 用来定义 shop 相关路由信息，具体内容如下：

func Routers(e *gin.Engine) {
    e.GET("/goods", goodsHandler)
    e.GET("/checkout", checkoutHandler)
}

routers/routers.go 中根据需要定义 Include 函数用来注册子 app 中定义的路由，Init 函数用来进行路由的初始化操作：

type Option func(*gin.Engine)

var options = []Option{}

// 注册app的路由配置
func Include(opts ...Option) {
    options = append(options, opts...)
}

// 初始化
func Init() *gin.Engine {
    engine := gin.New()
    for _, opt := range options {
        opt(engine)
    }
    return engine
}

main.go 中按如下方式先注册子 app 中的路由，然后再进行路由的初始化：

func main() {
    // 加载多个APP的路由配置
    routers.Include(shop.Routers, blog.Routers)
    // 初始化路由
    engine := routers.Init()
    if err := engine.Run(); err != nil {
        fmt.Println("startup service failed, err:%v\n", err)
    }
}