gin框架中的路由拆分与注册
基本的路由注册
下面最基础的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 mayanan.cn",
})
}
func main() {
r := gin.Default()
r.GET("/topgoer", helloHandler)
if err := r.Run(); err != nil {
fmt.Println("startup service failed, err:%v\n", err)
}
}
路由拆分成单独文件或包
当项目的规模增大后就不太适合继续在项目的main.go文件中去实现路由注册相关逻辑了，我们会倾向于把路由部分的代码都拆分出来，形成一个单独的文件或包：
- 我们在routers.go文件中定义并注册路由信息：
package main
import "github.com/gin-gonic/gin"
func helloHandler(context *gin.Context) {
context.JSON(200, "OK")
}
func SetupRouter() *gin.Engine {
// 配置路由信息
router := gin.Default()
router.GET("/", helloHandler)
return router
}
- main.go中调用上面定义好的setupRouter函数：
package main
import "fmt"
func main() {
router := SetupRouter()
if err := router.Run(); err != nil {
fmt.Println(err)
return
}
}
此时的目录结构：
把路由部分的代码单独拆分成包的话也是可以的，拆分后的目录结构如下：
路由拆分成多个文件
当我们的业务规模继续膨胀，单独的一个routers文件或包已经满足不了我们的需求了，
func SetupRouter() *gin.Engine {
r := gin.Default()
r.GET("/topgoer", helloHandler)
r.GET("/xx1", xxHandler1)
...
r.GET("/xx30", xxHandler30)
return r
}
因为我们把所有的路由注册都写在一个SetupRouter函数中的话就会太复杂了。
我们可以分开定义多个路由文件，例如：
routers/shop.go中添加一个LoadShop的函数，将shop相关的路由注册到指定的路由器：
package routers
import "github.com/gin-gonic/gin"
func hello2Handler(context *gin.Context) {
context.JSON(200, "hello")
}
func LoadShop(router *gin.Engine) {
// 配置路由信息
router.GET("/hello", hello2Handler)
}
routers/blog.go中添加一个LoadBlog的函数，将blog相关的路由注册到指定的路由器：
package routers
import "github.com/gin-gonic/gin"
func helloHandler(context *gin.Context) {
context.JSON(200, "OK")
}
func LoadBlog(router *gin.Engine) {
// 配置路由信息
router.GET("/", helloHandler)
}
在main函数中实现最终的注册逻辑如下：
package main
import (
"common_standard_library/routers"
"fmt"
"github.com/gin-gonic/gin"
)
func main() {
router := gin.Default()
routers.LoadBlog(router)
routers.LoadShop(router)
if err := router.Run(); err != nil {
fmt.Println(err)
return
}
}
路由拆分到不同的app
有时候项目规模实在太大，那么我们就更倾向于把业务拆分的更详细一些，例如把不同的业务代码拆分成不同的APP。
因此我们在项目目录下单独定义一个app目录，用来存放我们不同业务线的代码文件，这样就很容易进行横向扩展。大致目录结构如下：
其中app/blog/router.go用来定义blog相关路由信息，具体内容如下：
package blog
import "github.com/gin-gonic/gin"
func Routers(router *gin.Engine) {
router.GET("/blog", blog)
}
app/shop/router.go用来定义shop相关路由信息，具体内容如下：
package shop
import "github.com/gin-gonic/gin"
func Routers(router *gin.Engine) {
router.GET("/blog", shop)
}
routers/routers.go中根据需要定义Include函数用来注册子app中定义的路由，Init函数用来进行路由的初始化操作：
package routers
import (
"github.com/gin-gonic/gin"
)
type Option func(router *gin.Engine)
var options = make([]Option, 0)
// 注册app的路由配置
func Include(opts ...Option) {
options = append(options, opts...)
}
// 初始化路由
func Init() *gin.Engine {
router := gin.Default()
for _, opt := range options {
opt(router)
}
return router
}
main.go中按如下方式先注册子app中的路由，然后再进行路由的初始化：
package main
import (
"common_standard_library/app/blog"
"common_standard_library/app/shop"
"common_standard_library/routers"
"fmt"
)
func main() {
// 加载多个app的路由配置
routers.Include(blog.Routers, shop.Routers)
// 初始化路由
router := routers.Init()
if err := router.Run(); err != nil {
fmt.Println(err)
return
}
}
参考链接：https://www.liwenzhou.com/posts/Go/gin_routes_registry/
路由拆分到不同app升级版-支持路由组（前台不变和后台路由自动加/admin用户）
-
目录结构
-
后台应用的router.go文件 app/shop/router.go
package shop
import "github.com/gin-gonic/gin"
func Routers(router *gin.RouterGroup) {
router.GET("/shop", shop)
}
- routers/routers.go（增加了后台路由组）
点击查看代码
package routers
import (
"github.com/gin-gonic/gin"
)
type Option func(router *gin.Engine)
type AdminOption func(adminRouterGroup *gin.RouterGroup)
var options = make([]Option, 0)
var adminOptions = make([]AdminOption, 0)
// 注册app的前台路由配置
func Include(opts ...Option) {
options = append(options, opts...)
}
// 注册app的后台路由配置
func IncludeAdmin(adminOpts ...AdminOption) {
adminOptions = append(adminOptions, adminOpts...)
}
// 初始化路由
func Init() *gin.Engine {
router := gin.Default()
adminRouterGroup := router.Group("/admin")
for _, opt := range options {
opt(router)
}
for _, adminOpt := range adminOptions {
adminOpt(adminRouterGroup)
}
return router
}
- main.py中增加了后台路由配置
package main
import (
"common_standard_library/app/blog"
"common_standard_library/app/shop"
"common_standard_library/routers"
"fmt"
)
func main() {
// 加载app的前台路由配置
routers.Include(blog.Routers)
// 加载app的后台路由配置
routers.IncludeAdmin(shop.Routers)
// 初始化路由
router := routers.Init()
if err := router.Run(); err != nil {
fmt.Println(err)
return
}
}
