分组路由是业务项目中主要使用的路由注册方式。

分组路由

GoFrame框架支持分组路由的注册方式，可以给分组路由指定一个prefix前缀（也可以直接给定/前缀，表示注册在根路由下），在该分组下的所有路由注册都将注册在该路由前缀下。分组路由注册方式也是推荐的路由注册方式。

接口文档：https://pkg.go.dev/github.com/gogf/gf/v2/net/ghttp#RouterGroup

// 创建分组路由
func (s *Server) Group(prefix string, groups ...func(g *RouterGroup)) *RouterGroup

// 注册Method路由
func (g *RouterGroup) ALL(pattern string, object interface{}, params...interface{})
func (g *RouterGroup) GET(pattern string, object interface{}, params...interface{})
func (g *RouterGroup) PUT(pattern string, object interface{}, params...interface{})
func (g *RouterGroup) POST(pattern string, object interface{}, params...interface{})
func (g *RouterGroup) DELETE(pattern string, object interface{}, params...interface{})
...

// 中间件绑定
func (g *RouterGroup) Middleware(handlers ...HandlerFunc) *RouterGroup

// 批量注册
func (g *RouterGroup) Map(m map[string]interface{})
func (g *RouterGroup) ALLMap(m map[string]interface{})

简要介绍：

  1. Group方法用于创建一个分组路由对象，并且支持在指定域名对象上创建。
  2. 以HTTP Method命名的方法用于绑定指定的HTTP Method路由；其中ALL方法用于注册所有的HTTP Method到指定的函数/对象/控制器上；REST方法用于注册RESTful风格的路由，需给定一个执行对象或者控制器对象。
  3. Middleware方法用于绑定一个或多个中间件到当前分组的路由上，具体详见中间件章节。

简单示例

package main

import (
	"github.com/gogf/gf/v2/frame/g"
	"github.com/gogf/gf/v2/net/ghttp"
)

func main() {
	s := g.Server()
	s.Group("/api", func(group *ghttp.RouterGroup) {
		group.ALL("/all", func(r *ghttp.Request) {
			r.Response.Write("all")
		})
		group.GET("/get", func(r *ghttp.Request) {
			r.Response.Write("get")
		})
		group.POST("/post", func(r *ghttp.Request) {
			r.Response.Write("post")
		})
	})
	s.SetPort(8199)
	s.Run()
}

执行后，终端打印出路由表如下：

SERVER  | DOMAIN  | ADDRESS | METHOD |   ROUTE   |     HANDLER     | MIDDLEWARE
|---------|---------|---------|--------|-----------|-----------------|------------|
  default | default | :8199   | ALL    | /api/all  | main.main.func1 |
|---------|---------|---------|--------|-----------|-----------------|------------|
  default | default | :8199   | GET    | /api/get  | main.main.func2 |
|---------|---------|---------|--------|-----------|-----------------|------------|
  default | default | :8199   | POST   | /api/post | main.main.func3 |
|---------|---------|---------|--------|-----------|-----------------|------------|

其中，/api/get仅允许GET方式访问，/api/post仅允许POST方式访问，/api/all允许所有的方式访问。

我们使用curl工具来测试一下：

  1. /api/get

    $ curl http://127.0.0.1:8199/api/get 
get 
$ curl -X POST http://127.0.0.1:8199/api/get 
Not Found

  2. /api/post 

    $ curl http://127.0.0.1:8199/api/post 
Not Found 
$ curl -X POST http://127.0.0.1:8199/api/post post

  3.  /api/all  

    $ curl http://127.0.0.1:8199/api/all 
all 
$ curl -X POST http://127.0.0.1:8199/api/all 
all 
$ curl -X DELETE http://127.0.0.1:8199/api/all 
all 
$ curl -X OPTIONS http://127.0.0.1:8199/api/all 
all

层级注册

GoFrame框架的层级路由注册方式灵感来源于PHP Laravel框架。(wink)

推荐使用路由层级注册方式，注册的路由代码更清晰直观。GoFrame框架的分组路由注册支持更加直观优雅层级的注册方式，以便于开发者更方便地管理路由列表。路由层级注册方式也是推荐的路由注册方式。我们来看一个比较完整的示例，该示例中注册了使用到了中间件、HOOK以及不同HTTP Method绑定的路由注册：

package main

import (
	"fmt"
	"net/http"

	"github.com/gogf/gf/v2/frame/g"
	"github.com/gogf/gf/v2/net/ghttp"
)

func MiddlewareAuth(r *ghttp.Request) {
	if r.Get("token").String() != "123456" {
		r.Response.WriteStatus(http.StatusForbidden)
		return
	}
	r.Middleware.Next()
}

func MiddlewareCORS(r *ghttp.Request) {
	r.Response.CORSDefault()
	r.Middleware.Next()
}

func MiddlewareLog(r *ghttp.Request) {
	r.Middleware.Next()
	fmt.Println(r.Response.Status, r.URL.Path)
}

func main() {
	s := g.Server()
	s.Use(MiddlewareLog)
	s.Group("/api.v2", func(group *ghttp.RouterGroup) {
		group.Middleware(MiddlewareAuth, MiddlewareCORS)
		group.GET("/test", func(r *ghttp.Request) {
			r.Response.Write("test")
		})
		group.Group("/order", func(group *ghttp.RouterGroup) {
			group.GET("/list", func(r *ghttp.Request) {
				r.Response.Write("list")
			})
			group.PUT("/update", func(r *ghttp.Request) {
				r.Response.Write("update")
			})
		})
		group.Group("/user", func(group *ghttp.RouterGroup) {
			group.GET("/info", func(r *ghttp.Request) {
				r.Response.Write("info")
			})
			group.POST("/edit", func(r *ghttp.Request) {
				r.Response.Write("edit")
			})
			group.DELETE("/drop", func(r *ghttp.Request) {
				r.Response.Write("drop")
			})
		})
		group.Group("/hook", func(group *ghttp.RouterGroup) {
			group.Hook("/*", ghttp.HookBeforeServe, func(r *ghttp.Request) {
				r.Response.Write("hook any")
			})
			group.Hook("/:name", ghttp.HookBeforeServe, func(r *ghttp.Request) {
				r.Response.Write("hook name")
			})
		})
	})
	s.SetPort(8199)
	s.Run()
}

执行后，注册的路由列表如下：

SERVER  | DOMAIN  | ADDRESS | METHOD |        ROUTE         |       HANDLER       |               MIDDLEWARE
|---------|---------|---------|--------|----------------------|---------------------|-----------------------------------------|
  default | default | :8199   | ALL    | /*                   | main.MiddlewareLog  | GLOBAL MIDDLEWARE
|---------|---------|---------|--------|----------------------|---------------------|-----------------------------------------|
  default | default | :8199   | ALL    | /api.v2/hook/*       | main.main.func1.4.1 | HOOK_BEFORE_SERVE
|---------|---------|---------|--------|----------------------|---------------------|-----------------------------------------|
  default | default | :8199   | ALL    | /api.v2/hook/:name   | main.main.func1.4.2 | HOOK_BEFORE_SERVE
|---------|---------|---------|--------|----------------------|---------------------|-----------------------------------------|
  default | default | :8199   | GET    | /api.v2/order/list   | main.main.func1.2.1 | main.MiddlewareAuth,main.MiddlewareCORS
|---------|---------|---------|--------|----------------------|---------------------|-----------------------------------------|
  default | default | :8199   | PUT    | /api.v2/order/update | main.main.func1.2.2 | main.MiddlewareAuth,main.MiddlewareCORS
|---------|---------|---------|--------|----------------------|---------------------|-----------------------------------------|
  default | default | :8199   | GET    | /api.v2/test         | main.main.func1.1   | main.MiddlewareAuth,main.MiddlewareCORS
|---------|---------|---------|--------|----------------------|---------------------|-----------------------------------------|
  default | default | :8199   | DELETE | /api.v2/user/drop    | main.main.func1.3.3 | main.MiddlewareAuth,main.MiddlewareCORS
|---------|---------|---------|--------|----------------------|---------------------|-----------------------------------------|
  default | default | :8199   | POST   | /api.v2/user/edit    | main.main.func1.3.2 | main.MiddlewareAuth,main.MiddlewareCORS
|---------|---------|---------|--------|----------------------|---------------------|-----------------------------------------|
  default | default | :8199   | GET    | /api.v2/user/info    | main.main.func1.3.1 | main.MiddlewareAuth,main.MiddlewareCORS
|---------|---------|---------|--------|----------------------|---------------------|-----------------------------------------|

批量注册

Map

通过Map方法可以实现批量的分组路由注册，但是如果是相同的URI不同的HTTP Method需要按照路由规范给定HTTP Method。使用示例：

package main

import (
	"github.com/gogf/gf/v2/frame/g"
	"github.com/gogf/gf/v2/net/ghttp"
)

func UserGet(r *ghttp.Request) {
	r.Response.Write("get")
}

func UserDelete(r *ghttp.Request) {
	r.Response.Write("delete")
}

func main() {
	s := g.Server()
	s.Group("/api", func(group *ghttp.RouterGroup) {
		group.Map(g.Map{
			"GET:    /user": UserGet,
			"DELETE: /user": UserDelete,
		})
	})
	s.SetPort(8199)
	s.Run()
}

AllMap

也可以使用ALLMap方法实现批量的分组路由注册，通过该方法注册的路由将把路由函数/对象应用到所有的HTTP Method。使用示例：

s := g.Server()
// 前台系统路由注册
s.Group("/", func(group *ghttp.RouterGroup) {
	group.Middleware(service.Middleware.Ctx)
	group.ALLMap(g.Map{
		"/":            api.Index,          // 首页
		"/login":       api.Login,          // 登录
		"/register":    api.Register,       // 注册
		"/category":    api.Category,       // 栏目
		"/topic":       api.Topic,          // 主题
		"/topic/:id":   api.Topic.Detail,   // 主题 - 详情
		"/ask":         api.Ask,            // 问答
		"/ask/:id":     api.Ask.Detail,     // 问答 - 详情
		"/article":     api.Article,        // 文章
		"/article/:id": api.Article.Detail, // 文章 - 详情
		"/reply":       api.Reply,          // 回复
		"/search":      api.Search,         // 搜索
		"/captcha":     api.Captcha,        // 验证码
		"/user/:id":    api.User.Index,     // 用户 - 主页
	})
	// 权限控制路由
	group.Group("/", func(group *ghttp.RouterGroup) {
		group.Middleware(service.Middleware.Auth)
		group.ALLMap(g.Map{
			"/user":     api.User,     // 用户
			"/content":  api.Content,  // 内容
			"/interact": api.Interact, // 交互
			"/file":     api.File,     // 文件
		})
	})
})





Content Menu

  • No labels

21 Comments

  1. manong

    group.ALLMap(g.Map{
		"/":            api.Index,          // 首页
		"/login":       api.Login,          // 登录
		"/register":    api.Register,       // 注册
		"/category":    api.Category,       // 栏目
		"/topic":       api.Topic,          // 主题
		"/topic/:id":   api.Topic.Detail,   // 主题 - 详情
		"/ask":         api.Ask,            // 问答
		"/ask/:id":     api.Ask.Detail,     // 问答 - 详情
		"/article":     api.Article,        // 文章
		"/article/:id": api.Article.Detail, // 文章 - 详情
		"/reply":       api.Reply,          // 回复
		"/search":      api.Search,         // 搜索
		"/captcha":     api.Captcha,        // 验证码
		"/user/:id":    api.User.Index,     // 用户 - 主页
	})


    这种group.ALLMap方式能为每个路由指定特定的请求方法吗, 比如/login限制只能使用POST, /ask限制只能使用GET, 可以吗

    1. 郭强

      不可以

  2. sanrentai

    func (g *RouterGroup) POST(pattern string, object interface{}, params...interface{})

    params...interface{} // 这个参数有什么作用

    1. kn1011

      可选的注册对象方法路由

  3. phoenix

    那个有注解路由吗，怎么用

  4. sanrentai

    package main

import (
	"github.com/gogf/gf/v2/frame/g"
	"github.com/gogf/gf/v2/net/ghttp"
)

func main() {
	s := g.Server()
	group := s.Group("/api/get")
	group.GET("/", func(r *ghttp.Request) {
		r.Response.Write("get")
	})
	s.SetPort(8199)
	s.Run()
}


    访问 http://localhost:8199/api/get 会返回 404

    1. tigerOoo

      同问，分组路由没法设置根路由，访问直接not found

      1. 郭强

        sanrentai tigerOoo 哥哥些，问题请提issue，另外这个问题我用master分支并没有复现。

        1. tigerOoo

          测试最新版，无问题，谢了

  5. jack

    func MiddlewareAuth(r *ghttp.Request) {
	token := r.Get("token")
	if token == "123456" {
		r.Middleware.Next()
	} else {
		r.Response.WriteStatus(http.StatusForbidden)
	}
}

func MiddlewareCORS(r *ghttp.Request) {
	r.Response.CORSDefault()
	r.Middleware.Next()
}

func MiddlewareLog(r *ghttp.Request) {
	r.Middleware.Next()
	g.Log().Println(r.Response.Status, r.URL.Path)
}

    出现：

    ./g16.go:12:11: invalid operation: token == "123456" (mismatched types *gvar.Var and untyped string)

    ./g16.go:26:9: g.Log().Println undefined (type *glog.Logger has no field or method Println)


    1. 倪时鸿

      package main

      import (
         "net/http"

         "github.com/gogf/gf/v2/util/gconv"

         "github.com/gogf/gf/v2/frame/g"
         "github.com/gogf/gf/v2/net/ghttp"
      )

      func MiddlewareAuth(r *ghttp.Request) {
         token := r.Get("token")
         if gconv.String(token) == "123456" {
            r.Middleware.Next()
         } else {
            r.Response.WriteStatus(http.StatusForbidden)
         }
      }


      第一个报错，修改这个。

  6. 小兵张嘎

    如何实现 对象的注册 下面类似的 Init 功能呢?

  7. JCJC错别字检测

    本页面，层级注册的例子中，有一处代码：

    token == "123456"

    编辑器提示：Invalid operation: token == "123456" (mismatched types *gvar.Var and string)


    本页面，还有一处代码：

    g.Log().Println(r.Response.Status, r.URL.Path)

    提示：g.Log() 没有 Println 的实现。

    出现这些问题的原因是什么呢？


    1. koreanafter

      2024年了，这个错还在报

  8. 小陈

    虽然功能好多好多. 不过真的牛掰. 代码质量比gin好. 也易懂

  9. ceroot

    对路由分组批量注册ALLMap在v2版本出现一个问题，有个疑问，如下：

    输出版本：

    gf -v
    GoFrame CLI Tool v2.5.6, https://goframe.org
    GoFrame Version: v2.5.6 in current go.mod



    api代码：
    type InfoReq struct {
        g.Meta `path:"/info" tags:"info" method:"post" summary:"info"`
    }
    type InfoRes struct{}

    type EditReq struct {
        g.Meta `path:"/edit" tags:"edit" method:"post" summary:"edit"`
    }
    type EditRes struct{}

    type AddReq struct {
        g.Meta `path:"/add" tags:"add" method:"post" summary:"add"`
    }
    type AddRes struct{}



    批量注册代码：

    s.Group("/api", func(group *ghttp.RouterGroup) {
        group.ALLMap(g.Map{
           "/user": user.NewV1(), // 用户
        })
    })


    生成路由：
      ADDRESS | METHOD |   ROUTE    |                             HANDLER                             |    MIDDLEWARE
    ----------|--------|------------|-----------------------------------------------------------------|--------------------
      :8080   | POST   | /api/add   | project/internal/controller/user.(*ControllerV1).Add            |
    ----------|--------|------------|-----------------------------------------------------------------|--------------------
      :8080   | POST   | /api/edit  | project/internal/controller/user.(*ControllerV1).Edit           |
    ----------|--------|------------|-----------------------------------------------------------------|--------------------
      :8080   | POST   | /api/info  | project/internal/controller/user.(*ControllerV1).Info           |
    ----------|--------|------------|-----------------------------------------------------------------|--------------------

    疑问的是生成的路由ROUTE里没有把批量注册里的/user加进去，不知是系统这样设计的还是出现的bug。
    我的理解是应该把/user加到路由里去，比如：
    /api/add应该生成/api/user/add。

    谢谢。

    1. skyonsky

      "/user": user.NewV1
      不加括号

  10. Before80

    1. $ curl -X POST http://127.0.0.1:8199/api/post post
    2. 其中第二个 post 需要换行下。

  11. Before80

    在层级注册中有一句：“我们来看一个比较完整的示例，该示例中注册了使用到了中间件、HOOK以及不同HTTP Method绑定的路由注册：”， 语句不是很通顺，觉得可以修改成“我们来看一个比较完整的示例，该示例是一个使用到了中间件、HOOK以及不同HTTP Method绑定的路由注册：”， 即将“中注册了”修改成“是一个”。

  12. 叮当猫

    group.REST如何使用？按照绑定对象的方式写了代码，但是没任何效果。

  13. 廖国勇

    刚开始接触golang，还不太熟悉，准备对*ghttp.Request，扩展两个方法 Success和Fail，用于API里边返 回数据给客户端使用，请问该如何操作。