Categories: GoFrame 教程

GoFrame 路由注册-分组路由

分组路由

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

接口文档：

https://pkg.go.dev/github.com/gogf/gf/v2/v2/net/ghttp#RouterGroup

// 创建分组路由
func (s *Server) Group(prefix string, groups ...func(g *RouterGroup)) *RouterGroup
func (d *Domain) 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) PATCH(pattern string, object interface{}, params...interface{})
func (g *RouterGroup) HEAD(pattern string, object interface{}, params...interface{})
func (g *RouterGroup) CONNECT(pattern string, object interface{}, params...interface{})
func (g *RouterGroup) OPTIONS(pattern string, object interface{}, params...interface{})
func (g *RouterGroup) TRACE(pattern string, object interface{}, params...interface{})

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

// REST路由
func (g *RouterGroup) REST(pattern string, object interface{})

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

// 规范化路由方式，自动绑定Handler或者路由对象
func (g *RouterGroup) Bind(handlerOrObject ...interface{}) *RouterGroup

简要介绍：

  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()
 group := s.Group("/api")
 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​工具来测试一下：

/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

/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

/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​框架

推荐使用路由层级注册方式，注册的路由代码更清晰直观。

​GoFrame​框架的分组路由注册支持更加直观优雅层级的注册方式，以便于开发者更方便地管理路由列表。路由层级注册方式也是推荐的路由注册方式。

我们来看一个比较完整的示例，该示例中注册了使用到了中间件、​HOOK​以及不同​HTTP Method​绑定的路由注册：

package main

import (
 "net/http"

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

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)
}

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
|---------|---------|---------|--------|----------------------|---------------------|-----------------------------------------|

批量注册

可以使用​ALLMap​方法实现批量的路由注册，例如：

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,     // 文件
  })
 })
})

唐伯虎点蚊香

前端小白，想各位学习！

Leave a Comment
Share
Published by
唐伯虎点蚊香
1 年 ago

Recent Posts

聊聊vue3中的defineProps

在Vue 3中，defineP…

1 周 ago

在 Chrome 中删除、允许和管理 Cookie

您可以选择删除现有 Cooki…

2 周 ago

自定义指令：聊聊vue中的自定义指令应用法则

今天我们来聊聊vue中的自定义…

3 周 ago

聊聊Vue中@click.stop和@click.prevent

一起来学下聊聊Vue中@cli…

4 周 ago

Nginx 基本操作：启动、停止、重启命令。

我们来学习Nginx基础操作：…

1 月 ago

Vue3：手动清理keep-alive组件缓存的方法

Vue3中手动清理keep-a…

1 月 ago