beego 路由詳解

beego路由設(shè)置

beego存在三種方式的路由:固定路由、正則路由寞缝、自動(dòng)路由符欠。下面就詳細(xì)說(shuō)一下如何使用這三種路由。

基礎(chǔ)路由

從 beego 1.2 版本開(kāi)始支持了基本的 RESTful 函數(shù)式路由,應(yīng)用中的大多數(shù)路由都會(huì)定義在 routers/router.go 文件中衙荐。最簡(jiǎn)單的 beego 路由由 URI 和閉包函數(shù)組成捞挥。

基本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"))
})

可以響應(yīng)任何HTTP請(qǐng)求的路由

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

所有的支持的基礎(chǔ)函數(shù):

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)


固定路由

固定路由也就是全匹配的路由,如下所示:

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

如上所示的路由就是我們最常用的路由方式忧吟,一個(gè)固定的路由砌函,一個(gè)控制器,然后根據(jù)用戶(hù)請(qǐng)求方法不同請(qǐng)求控制器中對(duì)應(yīng)的方法溜族,典型的 RESTful 方式讹俊。

RESTful 是一種目前 API 開(kāi)發(fā)中廣泛采用的形式,beego 默認(rèn)就是支持這樣的請(qǐng)求方法煌抒,也就是用戶(hù) Get 請(qǐng)求就執(zhí)行 Get 方法仍劈,Post 請(qǐng)求就執(zhí)行 Post 方法。因此默認(rèn)的路由是這樣 RESTful 的請(qǐng)求方式寡壮。


正則路由

為了用戶(hù)更加方便的路由設(shè)置贩疙,beego 參考了 sinatra 的路由實(shí)現(xiàn),支持多種方式的路由:

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

默認(rèn)匹配 //例如對(duì)于URL"/api/123"可以匹配成功况既,此時(shí)變量":id"值為"123"

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

默認(rèn)匹配 //例如對(duì)于URL"/api/123"可以匹配成功这溅,此時(shí)變量":id"值為"123",但URL"/api/"匹配失敗

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

自定義正則匹配 //例如對(duì)于URL"/api/123"可以匹配成功棒仍,此時(shí)變量":id"值為"123"

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

正則字符串匹配 //例如對(duì)于URL"/user/astaxie"可以匹配成功悲靴,此時(shí)變量":username"值為"astaxie"

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

*匹配方式 //例如對(duì)于URL"/download/file/api.xml"可以匹配成功,此時(shí)變量":path"值為"file/api"降狠, ":ext"值為"xml"

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

*全匹配方式 //例如對(duì)于URL"/download/ceshi/file/api.json"可以匹配成功对竣,此時(shí)變量":splat"值為"file/api.json"

beego.Router("/??int", &controllers.RController{})

int 類(lèi)型設(shè)置方式庇楞,匹配 :id為int 類(lèi)型,框架幫你實(shí)現(xiàn)了正則 ([0-9]+)

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

string 類(lèi)型設(shè)置方式否纬,匹配 :hi 為 string 類(lèi)型吕晌。框架幫你實(shí)現(xiàn)了正則 ([\w]+)

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

帶有前綴的自定義正則 //匹配 :id 為正則類(lèi)型临燃。匹配 cms_123.html 這樣的 url :id = 123

可以在 Controller 中通過(guò)如下方式獲取上面的變量:

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 規(guī)則

上面列舉的是默認(rèn)的請(qǐng)求方法名(請(qǐng)求的 method 和函數(shù)名一致睛驳,例如 GET 請(qǐng)求執(zhí)行 Get 函數(shù),POST 請(qǐng)求執(zhí)行 Post 函數(shù))膜廊,如果用戶(hù)期望自定義函數(shù)名乏沸,那么可以使用如下方式:

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

使用第三個(gè)參數(shù),第三個(gè)參數(shù)就是用來(lái)設(shè)置對(duì)應(yīng) method 到函數(shù)名爪瓜,定義如下

  • *表示任意的 method 都執(zhí)行該函數(shù)
  • 使用 httpmethod:funcname 格式來(lái)展示
  • 多個(gè)不同的格式使用 ; 分割
  • 多個(gè) method 對(duì)應(yīng)同一個(gè) funcname蹬跃,method 之間通過(guò) , 來(lái)分割

以下是一個(gè) RESTful 的設(shè)計(jì)示例:

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

以下是多個(gè) HTTP Method 指向同一個(gè)函數(shù)的示例:

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

以下是不同的 method 對(duì)應(yīng)不同的函數(shù),通過(guò) ; 進(jìn)行分割的示例:

beego.Router("/simple",&SimpleController{},"get:GetFunc;post:PostFunc")
可用的 HTTP Method:

*: 包含以下所有的函數(shù)

  • get: GET 請(qǐng)求
  • post: POST 請(qǐng)求
  • put: PUT 請(qǐng)求
  • delete: DELETE 請(qǐng)求
  • patch: PATCH 請(qǐng)求
  • options: OPTIONS 請(qǐng)求
  • head: HEAD 請(qǐng)求
    如果同時(shí)存在 * 和對(duì)應(yīng)的 HTTP Method铆铆,那么優(yōu)先執(zhí)行 HTTP Method 的方法蝶缀,例如同時(shí)注冊(cè)了如下所示的路由:
beego.Router("/simple",&SimpleController{},"*:AllFunc;post:PostFunc")

那么執(zhí)行 POST 請(qǐng)求的時(shí)候,執(zhí)行 PostFunc 而不執(zhí)行 AllFunc薄货。

自定義函數(shù)的路由默認(rèn)不支持 RESTful 的方法翁都,也就是如果你設(shè)置了 beego.Router("/api",&RestController{},"post:ApiFunc") 這樣的路由,如果請(qǐng)求的方法是 POST谅猾,那么不會(huì)默認(rèn)去執(zhí)行 Post 函數(shù)柄慰。


自動(dòng)路由

用戶(hù)首先需要把需要路由的控制器注冊(cè)到自動(dòng)路由中:

beego.AutoRouter(&controllers.ObjectController{})

那么 beego 就會(huì)通過(guò)反射獲取該結(jié)構(gòu)體中所有的實(shí)現(xiàn)方法,你就可以通過(guò)如下的方式訪問(wèn)到對(duì)應(yīng)的方法中:

/object/login 調(diào)用 ObjectController 中的 Login 方法
/object/logout 調(diào)用 ObjectController 中的 Logout 方法

除了前綴兩個(gè) /:controller/:method 的匹配之外税娜,剩下的 url beego 會(huì)幫你自動(dòng)化解析為參數(shù)坐搔,保存在 this.Ctx.Input.Params 當(dāng)中:

/object/blog/2013/09/12 調(diào)用 ObjectController 中的 Blog 方法,參數(shù)如下:

map[0:2013 1:09 2:12]

方法名在內(nèi)部是保存了用戶(hù)設(shè)置的敬矩,例如 Login薯蝎,url 匹配的時(shí)候都會(huì)轉(zhuǎn)化為小寫(xiě),所以谤绳,/object/LOGIN 這樣的 url 也一樣可以路由到用戶(hù)定義的 Login 方法中。

現(xiàn)在已經(jīng)可以通過(guò)自動(dòng)識(shí)別出來(lái)下面類(lèi)似的所有 url袒哥,都會(huì)把請(qǐng)求分發(fā)到 controller 的 simple 方法:

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

可以通過(guò) this.Ctx.Input.Param(":ext") 獲取后綴名缩筛。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市堡称,隨后出現(xiàn)的幾起案子瞎抛,更是在濱河造成了極大的恐慌,老刑警劉巖却紧,帶你破解...
    沈念sama閱讀 218,122評(píng)論 6 505
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件桐臊,死亡現(xiàn)場(chǎng)離奇詭異胎撤,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)断凶,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,070評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門(mén)伤提,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人认烁,你說(shuō)我怎么就攤上這事肿男。” “怎么了却嗡?”我有些...
    開(kāi)封第一講書(shū)人閱讀 164,491評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵舶沛,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我窗价,道長(zhǎng)如庭,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,636評(píng)論 1 293
  • 正文 為了忘掉前任撼港,我火速辦了婚禮坪它,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘餐胀。我一直安慰自己哟楷,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,676評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布否灾。 她就那樣靜靜地躺著卖擅,像睡著了一般。 火紅的嫁衣襯著肌膚如雪墨技。 梳的紋絲不亂的頭發(fā)上惩阶,一...
    開(kāi)封第一講書(shū)人閱讀 51,541評(píng)論 1 305
  • 那天,我揣著相機(jī)與錄音扣汪,去河邊找鬼断楷。 笑死,一個(gè)胖子當(dāng)著我的面吹牛崭别,可吹牛的內(nèi)容都是我干的冬筒。 我是一名探鬼主播,決...
    沈念sama閱讀 40,292評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼茅主,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼舞痰!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起诀姚,我...
    開(kāi)封第一講書(shū)人閱讀 39,211評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤响牛,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體呀打,經(jīng)...
    沈念sama閱讀 45,655評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡矢赁,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,846評(píng)論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了贬丛。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片撩银。...
    茶點(diǎn)故事閱讀 39,965評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖瘫寝,靈堂內(nèi)的尸體忽然破棺而出蜒蕾,到底是詐尸還是另有隱情,我是刑警寧澤焕阿,帶...
    沈念sama閱讀 35,684評(píng)論 5 347
  • 正文 年R本政府宣布咪啡,位于F島的核電站,受9級(jí)特大地震影響暮屡,放射性物質(zhì)發(fā)生泄漏撤摸。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,295評(píng)論 3 329
  • 文/蒙蒙 一褒纲、第九天 我趴在偏房一處隱蔽的房頂上張望准夷。 院中可真熱鬧,春花似錦莺掠、人聲如沸衫嵌。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,894評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)楔绞。三九已至,卻和暖如春唇兑,著一層夾襖步出監(jiān)牢的瞬間酒朵,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,012評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工扎附, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留蔫耽,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,126評(píng)論 3 370
  • 正文 我出身青樓留夜,卻偏偏與公主長(zhǎng)得像匙铡,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子碍粥,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,914評(píng)論 2 355

推薦閱讀更多精彩內(nèi)容