路由設定

尹成發表於2018-11-14

beego 存在三種方式的路由:固定路由、正則路由、自動路由。
#基礎路由
從 beego 1.2 版本開始支援了基本的 RESTful 函式式路由,應用中的大多數路由都會定義在 routers/router.go 檔案中。最簡單的 beego 路由由 URI 和閉包函式組成。

##基本 GET 路由

beego.Get("/",func(ctx *context.Context){
     ctx.Output.Body([]byte("hello world"))
})

##基本 POST 路由

beego.Post("/alice",func(ctx *context.Context){
     ctx.Output.Body([]byte("bob"))
})

##註冊一個可以響應任何 HTTP 的路由

beego.Any("/foo",func(ctx *context.Context){
     ctx.Output.Body([]byte("bar"))
})

所有的支援的基礎函式如下所示

beego.Get(router, beego.FilterFunc)
beego.Post(router, beego.FilterFunc)
beego.Put(router, beego.FilterFunc)
beego.Patch(router, beego.FilterFunc)
beego.Head(router, beego.FilterFunc)
beego.Options(router, beego.FilterFunc)
beego.Delete(router, beego.FilterFunc)
beego.Any(router, beego.FilterFunc)

#RESTful Controller 路由
在介紹這三種 beego 的路由實現之前先介紹 RESTful,我們知道 RESTful 是一種目前 API 開發中廣泛採用的形式,beego 預設就是支援這樣的請求方法,也就是使用者 Get 請求就執行 Get 方法,Post 請求就執行 Post 方法。因此預設的路由是這樣 RESTful 的請求方式。
REST 指的是一組約束條件和原則,滿足這些約束條件和原則的應用程式或設計就是 RESTful。Web 應用程式最重要的原則是,客戶端和伺服器之間的互動在請求之間是無狀態的。從客戶端到伺服器的每個請求都必須包含理解請求所必需的資訊。如果伺服器在請求之間的任何時間點重啟,客戶端不會得到通知。此外,無狀態請求可以由任何可用伺服器回答,客戶端可以通過快取資料的形式來提高效能。
##固定路由
固定路由也就是全匹配的路由,如下所示:

beego.Router("/", &controllers.MainController{})
beego.Router("/admin", &admin.UserController{})
beego.Router("/admin/index", &admin.ArticleController{})
beego.Router("/admin/addpkg", &admin.AddController{})

如上所示的路由就是我們最常用的路由方式,一個固定的路由,一個控制器,然後根據使用者請求方法不同請求控制器中對應的方法,典型的 RESTful 方式。

##正則路由
為了使用者更加方便的路由設定,beego 參考了 sinatra 的路由實現,支援多種方式的路由:

beego.Router(“/api/?:id”, &controllers.RController{})

預設匹配 //例如對於URL”/api/123”可以匹配成功,此時變數”:id”值為”123”

beego.Router(“/api/:id”, &controllers.RController{})

預設匹配 //例如對於URL”/api/123”可以匹配成功,此時變數”:id”值為”123”,但URL”/api/“匹配失敗

beego.Router(“/api/:id([0-9]+)“, &controllers.RController{})

自定義正則匹配 //例如對於URL”/api/123”可以匹配成功,此時變數”:id”值為”123”

beego.Router(“/user/:username([\\w]+)“, &controllers.RController{})

正則字串匹配 //例如對於URL”/user/astaxie”可以匹配成功,此時變數”:username”值為”astaxie”

beego.Router(“/download/*.*”, &controllers.RController{})

*匹配方式 //例如對於URL”/download/file/api.xml”可以匹配成功,此時變數”:path”值為”file/api”, “:ext”值為”xml”

beego.Router(“/download/ceshi/*“, &controllers.RController{})

*全匹配方式 //例如對於URL”/download/ceshi/file/api.json”可以匹配成功,此時變數”:splat”值為”file/api.json”

beego.Router(“/:id:int”, &controllers.RController{})

int 型別設定方式,匹配 :id為int 型別,框架幫你實現了正則 ([0-9]+)

beego.Router(“/:hi:string”, &controllers.RController{})

string 型別設定方式,匹配 :hi 為 string 型別。框架幫你實現了正則 ([\w]+)

beego.Router(“/cms_:id([0-9]+).html”, &controllers.CmsController{})

帶有字首的自定義正則 //匹配 :id 為正則型別。匹配 cms_123.html 這樣的 url :id = 123

可以在 Controller 中通過如下方式獲取上面的變數:

this.Ctx.Input.Param(":id")
this.Ctx.Input.Param(":username")
this.Ctx.Input.Param(":splat")
this.Ctx.Input.Param(":path")
this.Ctx.Input.Param(":ext")

##自定義方法及 RESTful 規則
上面列舉的是預設的請求方法名(請求的 method 和函式名一致,例如 GET 請求執行 Get 函式,POST 請求執行 Post 函式),如果使用者期望自定義函式名,那麼可以使用如下方式:

beego.Router("/",&IndexController{},"*:Index")

使用第三個引數,第三個引數就是用來設定對應 method 到函式名,定義如下

*表示任意的 method 都執行該函式
使用 httpmethod:funcname 格式來展示
多個不同的格式使用 ; 分割
多個 method 對應同一個 funcname,method 之間通過 , 來分割
以下是一個 RESTful 的設計示例:

beego.Router("/api/list",&RestController{},"*:ListFood")
beego.Router("/api/create",&RestController{},"post:CreateFood")
beego.Router("/api/update",&RestController{},"put:UpdateFood")
beego.Router("/api/delete",&RestController{},"delete:DeleteFood")

以下是多個 HTTP Method 指向同一個函式的示例:

beego.Router("/api",&RestController{},"get,post:ApiFunc")

以下是不同的 method 對應不同的函式,通過 ; 進行分割的示例:

beego.Router("/simple",&SimpleController{},"get:GetFunc;post:PostFunc")

可用的 HTTP Method:

*: 包含以下所有的函式

get: GET 請求
post: POST 請求
put: PUT 請求
delete: DELETE 請求
patch: PATCH 請求
options: OPTIONS 請求
head: HEAD 請求

如果同時存在 * 和對應的 HTTP Method,那麼優先執行 HTTP Method 的方法,例如同時註冊瞭如下所示的路由:

beego.Router("/simple",&SimpleController{},"*:AllFunc;post:PostFunc")

那麼執行 POST 請求的時候,執行 PostFunc 而不執行 AllFunc。

##自動匹配
使用者首先需要把需要路由的控制器註冊到自動路由中:

beego.AutoRouter(&controllers.ObjectController{})

那麼 beego 就會通過反射獲取該結構體中所有的實現方法,你就可以通過如下的方式訪問到對應的方法中:

/object/login   呼叫 ObjectController 中的 Login 方法
/object/logout  呼叫 ObjectController 中的 Logout 方法

除了字首兩個 /:controller/:method 的匹配之外,剩下的 url beego 會幫你自動化解析為引數,儲存在 this.Ctx.Input.Params 當中:

/object/blog/2013/09/12  呼叫 ObjectController 中的 Blog 方法,引數如下:map[0:2013 1:09 2:12]

方法名在內部是儲存了使用者設定的,例如 Login,url 匹配的時候都會轉化為小寫,所以,/object/LOGIN 這樣的 url 也一樣可以路由到使用者定義的 Login 方法中。

現在已經可以通過自動識別出來下面類似的所有 url,都會把請求分發到 controller 的 simple 方法:

/controller/simple
/controller/simple.html
/controller/simple.json
/controller/simple.xml

可以通過 this.Ctx.Input.Param(":ext") 獲取字尾名。

##註解路由
從 beego 1.3 版本開始支援了註解路由,使用者無需在 router 中註冊路由,只需要 Include 相應地 controller,然後在 controller 的 method 方法上面寫上 router 註釋(// @router)就可以了,詳細的使用請看下面的例子:

// CMS API
type CMSController struct {
    beego.Controller
}

func (c *CMSController) URLMapping() {
    c.Mapping("StaticBlock", c.StaticBlock)
    c.Mapping("AllBlock", c.AllBlock)
}


// @router /staticblock/:key [get]
func (this *CMSController) StaticBlock() {

}

// @router /all/:key [get]
func (this *CMSController) AllBlock() {

}

可以在 router.go 中通過如下方式註冊路由:

beego.Include(&CMSController{})

beego 自動會進行原始碼分析,注意只會在 dev 模式下進行生成,生成的路由放在 “/routers/commentsRouter.go” 檔案中。

這樣上面的路由就支援瞭如下的路由:

GET /staticblock/:key
GET /all/:key

其實效果和自己通過 Router 函式註冊是一樣的:

beego.Router("/staticblock/:key", &CMSController{}, "get:StaticBlock")
beego.Router("/all/:key", &CMSController{}, "get:AllBlock")

學院Go語言視訊主頁
https://edu.csdn.net/lecturer/1928

清華團隊帶你實戰區塊鏈開發
掃碼獲取海量視訊及原始碼 QQ群:721929980
在這裡插入圖片描述

相關文章