分组路由

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

接口文档

https://godoc.org/github.com/gogf/gf/net/ghttp#RouterGroup

  1. // 创建分组路由
  2. func (s *Server) Group(prefix string, groups ...func(g *RouterGroup)) *RouterGroup
  3. func (d *Domain) Group(prefix string, groups ...func(g *RouterGroup)) *RouterGroup
  4. // 注册Method路由
  5. func (g *RouterGroup) ALL(pattern string, object interface{}, params...interface{})
  6. func (g *RouterGroup) GET(pattern string, object interface{}, params...interface{})
  7. func (g *RouterGroup) PUT(pattern string, object interface{}, params...interface{})
  8. func (g *RouterGroup) POST(pattern string, object interface{}, params...interface{})
  9. func (g *RouterGroup) DELETE(pattern string, object interface{}, params...interface{})
  10. func (g *RouterGroup) PATCH(pattern string, object interface{}, params...interface{})
  11. func (g *RouterGroup) HEAD(pattern string, object interface{}, params...interface{})
  12. func (g *RouterGroup) CONNECT(pattern string, object interface{}, params...interface{})
  13. func (g *RouterGroup) OPTIONS(pattern string, object interface{}, params...interface{})
  14. func (g *RouterGroup) TRACE(pattern string, object interface{}, params...interface{})
  15. // 中间件绑定
  16. func (g *RouterGroup) Middleware(handlers ...HandlerFunc) *RouterGroup
  17. // REST路由
  18. func (g *RouterGroup) REST(pattern string, object interface{})
  19. // 批量注册
  20. func (g *RouterGroup) Bind(items []GroupItem)

其中:

  1. Group方法用户创建一个分组路由对象,并且支持在指定域名对象上创建。
  2. HTTP Method命名的方法用以绑定指定的HTTP Method路由;其中ALL方法用于注册所有的HTTP Method到指定的函数/对象/控制器上;REST方法用户注册RESTful风格的路由,需给定一个执行对象或者控制器对象。
  3. Middleware方法用于绑定一个或多个中间件到当前分组的路由上,具体详见中间件章节。
  4. Bind方法用于批量路由注册,每一个路由注册项为Slice类型的参数,且参数数量应该>=3个,具体使用请见后续示例。

我们来看一个简单的示例:

  1. package main
  2. import (
  3. "github.com/gogf/gf/frame/g"
  4. "github.com/gogf/gf/net/ghttp"
  5. )
  6. func main() {
  7. s := g.Server()
  8. group := s.Group("/api")
  9. group.ALL("/all", func(r *ghttp.Request) {
  10. r.Response.Write("all")
  11. })
  12. group.GET("/get", func(r *ghttp.Request) {
  13. r.Response.Write("get")
  14. })
  15. group.POST("/post", func(r *ghttp.Request) {
  16. r.Response.Write("post")
  17. })
  18. s.SetPort(8199)
  19. s.Run()
  20. }

执行后,终端打印出路由表如下:

  1. SERVER | DOMAIN | ADDRESS | METHOD | ROUTE | HANDLER | MIDDLEWARE
  2. |---------|---------|---------|--------|-----------|-----------------|------------|
  3. default | default | :8199 | ALL | /api/all | main.main.func1 |
  4. |---------|---------|---------|--------|-----------|-----------------|------------|
  5. default | default | :8199 | GET | /api/get | main.main.func2 |
  6. |---------|---------|---------|--------|-----------|-----------------|------------|
  7. default | default | :8199 | POST | /api/post | main.main.func3 |
  8. |---------|---------|---------|--------|-----------|-----------------|------------|

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

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

  1. /api/get
    1. $ curl http://127.0.0.1:8199/api/get
    2. get
    3. $ curl -X POST http://127.0.0.1:8199/api/get
    4. Not Found
  2. /api/post
    1. $ curl http://127.0.0.1:8199/api/post
    2. Not Found
    3. $ curl -X POST http://127.0.0.1:8199/api/post
    4. post
  3. /api/all
    1. $ curl http://127.0.0.1:8199/api/all
    2. all
    3. $ curl -X POST http://127.0.0.1:8199/api/all
    4. all
    5. $ curl -X DELETE http://127.0.0.1:8199/api/all
    6. all
    7. $ curl -X OPTIONS http://127.0.0.1:8199/api/all
    8. all