GoFrame 路由注冊-分組路由

2022-04-13 11:31 更新

分組路由

?GoFrame?框架支持分組路由的注冊方式，可以給分組路由指定一個?prefix?前綴（也可以直接給定?/?前綴，表示注冊在根路由下），在該分組下的所有路由注冊都將注冊在該路由前綴下。分組路由注冊方式也是推薦的路由注冊方式。

接口文檔：

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

// 創(chuàng)建分組路由
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{}) 

// 規(guī)范化路由方式，自動綁定Handler或者路由對象
func (g *RouterGroup) Bind(handlerOrObject ...interface{}) *RouterGroup

簡要介紹：

  1. ?Group?方法用于創(chuàng)建一個分組路由對象，并且支持在指定域名對象上創(chuàng)建。
  2. 以?HTTP Method?命名的方法用于綁定指定的?HTTP Method?路由；其中?ALL?方法用于注冊所有的?HTTP Method?到指定的函數(shù)/對象/控制器上；?REST?方法用于注冊?RESTful?風(fēng)格的路由，需給定一個執(zhí)行對象或者控制器對象。
  3. ?Middleware?方法用于綁定一個或多個中間件到當(dāng)前分組的路由上。

我們來看一個簡單的示例：

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

執(zhí)行后，終端打印出路由表如下：

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?框架的分組路由注冊支持更加直觀優(yōu)雅層級的注冊方式，以便于開發(fā)者更方便地管理路由列表。路由層級注冊方式也是推薦的路由注冊方式。

我們來看一個比較完整的示例，該示例中注冊了使用到了中間件、?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()
}

執(zhí)行后，注冊的路由列表如下：

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?方法實現(xiàn)批量的路由注冊，例如：

s := g.Server()
// 前臺系統(tǒng)路由注冊
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,          // 回復(fù)
		"/search":      api.Search,         // 搜索
		"/captcha":     api.Captcha,        // 驗證碼
		"/user/:id":    api.User.Index,     // 用戶 - 主頁
	})
	// 權(quán)限控制路由
	group.Group("/", func(group *ghttp.RouterGroup) {
		group.Middleware(service.Middleware.Auth)
		group.ALLMap(g.Map{
			"/user":     api.User,     // 用戶
			"/content":  api.Content,  // 內(nèi)容
			"/interact": api.Interact, // 交互
			"/file":     api.File,     // 文件
		})
	})
})


以上內(nèi)容是否對您有幫助：
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號