Beego AutoRouter工作原理解析
一、前言 ??
Beego Web框架應(yīng)該是國(guó)內(nèi)Go語(yǔ)言社區(qū)第一個(gè)框架，個(gè)人覺(jué)得十分適合新手入門(mén)Go Web。筆者半年前寫(xiě)過(guò)一篇搭建Beego項(xiàng)目并實(shí)習(xí)簡(jiǎn)單功能的文章，大家有興趣可以先看看。
其實(shí)我接觸的大部分人都在學(xué)校學(xué)過(guò)Java Web，其實(shí)有Java Web的經(jīng)驗(yàn)，上手Beego也會(huì)很舒服。
本文著重講講Beego的AutoRouter模塊，會(huì)結(jié)合源碼來(lái)講講，不過(guò)由于筆者技術(shù)水平有限，如有錯(cuò)誤，煩請(qǐng)指出。??
二、從一個(gè)例子入手?
Beego的路由設(shè)計(jì)靈感是sinatra，剛開(kāi)始并不支持自動(dòng)路由，項(xiàng)目的每一個(gè)路由都需要開(kāi)發(fā)者配置。
?? 不過(guò)，在Beego里面注冊(cè)一個(gè)路由是十分簡(jiǎn)單的，不信你看：
import "github.com/beego/beego/v2/server/web"
type ReganYueController struct {
web.Controller
}
接下來(lái)我們可以添加一個(gè)方法，也可以重寫(xiě)Get，Post，Delete等方法來(lái)響應(yīng)客戶(hù)端不同的請(qǐng)求方式。
import "github.com/beego/beego/v2/server/web"
type ReganYueController struct {
web.Controller
}
func (u *ReganYueController) HelloWorld() {
u.Ctx.WriteString("Welcome, Regan Yue")
}
func main() {
web.AutoRouter(&ReganYueController{})
web.Run()
}
該處web.AutoRouter(&ReganYueController{})就是使用的自動(dòng)路由，如果是以前的話(huà)，我們還需要配置路由?? 。例如以下這種形式：
beego.Router("/", &IndexController{})
對(duì)于下面這段代碼，有幾點(diǎn)需要注意：
func (u *ReganYueController) HelloWorld() {
u.Ctx.WriteString("Welcome, Regan Yue")
}
?這個(gè)處理HTTP請(qǐng)求的方法必須是公共方法（首字母要大寫(xiě)），并且不能有參數(shù)，不能有返回值，若非如此，可能會(huì)發(fā)生Panic。
??AutoRouter的解析規(guī)則：
影響因素有三：
RouterCaseSensitive的值。Controller的名字- 方法名字
比如我們上面ReganYueController的名字是ReganYue，而方法名字是HelloWorld，那么就會(huì)有以下幾種情況出現(xiàn)：
- 如果
RouterCaseSensitive為true，那么AutoRouter就會(huì)注冊(cè)兩個(gè)路由，其中一個(gè)是/ReganYue/HelloWorld/*，另一個(gè)是/reganyue/helloworld/*。 - 如果
RouterCaseSensitive為false，那么AutoRouter只會(huì)注冊(cè)一個(gè)路由，即/reganyue/helloworld/*。
三、AutoRouter是如何工作的
先看看web.AutoRouter()
// AutoRouter see HttpServer.AutoRouter
func AutoRouter(c ControllerInterface) *HttpServer {
return BeeApp.AutoRouter(c)
}
web.AutoRouter()馬上又指向(app *HttpServer) AutoRouter(c ControllerInterface)
// AutoRouter adds defined controller handler to BeeApp.
// it's same to HttpServer.AutoRouter.
// if beego.AddAuto(&MainContorlller{}) and MainController has methods List and Page,
// visit the url /main/list to exec List function or /main/page to exec Page function.
func (app *HttpServer) AutoRouter(c ControllerInterface) *HttpServer {
app.Handlers.AddAuto(c)
return app
}
前面?zhèn)鱽?lái)的主語(yǔ)BeeApp執(zhí)行該處程序：
BeeApp是一個(gè)應(yīng)用實(shí)例，使用NewHttpSever()創(chuàng)建，繼續(xù)跟進(jìn)，發(fā)現(xiàn)是根據(jù)Bconfig這個(gè)配置文件創(chuàng)建的，
// NewHttpServerWithCfg will create an sever with specific cfg
func NewHttpServerWithCfg(cfg *Config) *HttpServer {
cr := NewControllerRegisterWithCfg(cfg)
app := &HttpServer{
Handlers: cr,
Server: &http.Server{},
Cfg: cfg,
}
return app
}
上圖即配置Bconfig的主要結(jié)構(gòu)。
到此我們對(duì)于BeeApp已經(jīng)有一定了解了，下面我們回過(guò)頭來(lái)看看app.Handlers.AddAuto(c)。
先看看這個(gè)c是什么，它的類(lèi)型是ControllerInterface，我們現(xiàn)在進(jìn)去看看。
這個(gè)c是用來(lái)統(tǒng)一所有controller handler的接口。
根據(jù)上圖我們可以知道，這個(gè)app.Handles就是ControllerRegister，再來(lái)看看ControllerRegister的AddAuto方法：
func (p *ControllerRegister) AddAuto(c ControllerInterface) {
p.AddAutoPrefix("/", c)
}
AddAuto又指向AddAutoPrefix，這個(gè)AddAutoPrefix有什么用，我們先給出一個(gè)例子，然后再來(lái)看源碼。
beego.AddAutoPrefix("/admin",&MainContorlller{})
如果MainContorlller有兩個(gè)方法List、Page。那么我們可以訪(fǎng)問(wèn)/admin/main/list來(lái)執(zhí)行List函數(shù)，訪(fǎng)問(wèn)/admin/main/page來(lái)執(zhí)行Page函數(shù)
來(lái)看看ControllerRegister的AddAutoPrefix方法：
func (p *ControllerRegister) AddAutoPrefix(prefix string, c ControllerInterface) {
//對(duì)傳入的Controller做反射
reflectVal := reflect.ValueOf(c)
//獲取傳入的Controller的類(lèi)型
rt := reflectVal.Type()
//因?yàn)閏是指針，所以要用Indirect方法獲取指針指向的變量類(lèi)型
ct := reflect.Indirect(reflectVal).Type()
//使用Beego注冊(cè)controller的名稱(chēng)后面有Controller，這里把它去掉得到controllerName。
controllerName := strings.TrimSuffix(ct.Name(), "Controller")
//
for i := 0; i < rt.NumMethod(); i++ {
if !utils.InSlice(rt.Method(i).Name, exceptMethod) {
route := &ControllerInfo{}
route.routerType = routerTypeBeego
route.methods = map[string]string{"*": rt.Method(i).Name}
route.controllerType = ct
pattern := path.Join(prefix, strings.ToLower(controllerName), strings.ToLower(rt.Method(i).Name), "*")
patternInit := path.Join(prefix, controllerName, rt.Method(i).Name, "*")
patternFix := path.Join(prefix, strings.ToLower(controllerName), strings.ToLower(rt.Method(i).Name))
patternFixInit := path.Join(prefix, controllerName, rt.Method(i).Name)
route.pattern = pattern
for m := range HTTPMETHOD {
p.addToRouter(m, pattern, route)
p.addToRouter(m, patternInit, route)
p.addToRouter(m, patternFix, route)
p.addToRouter(m, patternFixInit, route)
}
}
}
}
reflectVal.Type()直接的獲取傳入的Controller的類(lèi)型，而reflect.Indirect(reflectVal).Type()，interface其實(shí)就是兩個(gè)指針，一個(gè)指向類(lèi)型信息，一個(gè)指向?qū)嶋H的對(duì)象，用Indirect方法獲取指針指向的實(shí)際變量的類(lèi)型。
在runtime/runtime2.go可以了解interface其實(shí)就是兩個(gè)指針：
type iface struct {
tab *itab //類(lèi)型信息
data unsafe.Pointer //實(shí)際對(duì)象指針
}
type itab struct {
inter *interfacetype //接口類(lèi)型
_type *_type //實(shí)際對(duì)象類(lèi)型
hash uint32
_ [4]byte
fun [1]uintptr //實(shí)際對(duì)象方法地址
}
接下來(lái)是for i := 0; i < rt.NumMethod(); i++，我們來(lái)看看這個(gè)NumMethod()，可以看到這個(gè)方法獲得interface類(lèi)型的方法數(shù)量。
utils.InSlice()方法正如其名：
func InSlice(v string, sl []string) bool {
for _, vv := range sl {
if vv == v {
return true
}
}
return false
}
該方法是用來(lái)判斷字符串v是不是在字符串切片sl里面。
此處判斷方法名是不是在exceptMethod里面。
下面是exceptMethod的內(nèi)容：
exceptMethod = []string{"Init", "Prepare", "Finish", "Render", "RenderString",
"RenderBytes", "Redirect", "Abort", "StopRun", "UrlFor", "ServeJSON", "ServeJSONP",
"ServeYAML", "ServeXML", "Input", "ParseForm", "GetString", "GetStrings", "GetInt", "GetBool",
"GetFloat", "GetFile", "SaveToFile", "StartSession", "SetSession", "GetSession",
"DelSession", "SessionRegenerateID", "DestroySession", "IsAjax", "GetSecureCookie",
"SetSecureCookie", "XsrfToken", "CheckXsrfCookie", "XsrfFormHtml",
"GetControllerAndAction", "ServeFormatted"}
接下來(lái)創(chuàng)建了一個(gè)結(jié)構(gòu)體，記錄了controller的信息，下面幾行代碼就生成了每個(gè)方法對(duì)應(yīng)的controller信息。
controller的pattern這里生成了4個(gè)模式：
- prefix/全小寫(xiě)的controllerName/全小寫(xiě)的方法名/*
- prefix/controllerName/方法名/*
- prefix/全小寫(xiě)的controllerName/全小寫(xiě)的方法名
- prefix/controllerName/方法名
然后對(duì)每一種HTTP方法：
都使用addToRouter方法用四種模式執(zhí)行一遍。
下面看看addToRouter。
func (p *ControllerRegister) addToRouter(method, pattern string, r *ControllerInfo) {
if !p.cfg.RouterCaseSensitive {
pattern = strings.ToLower(pattern)
}
if t, ok := p.routers[method]; ok {
t.AddRouter(pattern, r)
} else {
t := NewTree()
t.AddRouter(pattern, r)
p.routers[method] = t
}
}
- 如果
RouterCaseSensitive為true，那么AutoRouter就會(huì)注冊(cè)兩個(gè)路由，其中一個(gè)是/ReganYue/HelloWorld/*，另一個(gè)是/reganyue/helloworld/*。 - 如果
RouterCaseSensitive為false，那么AutoRouter只會(huì)注冊(cè)一個(gè)路由，即/reganyue/helloworld/*。
然后將method傳給ControllerRegister，看是不是注冊(cè)成功。
成功就執(zhí)行：t.AddRouter(pattern, r)添加路由。
否則就執(zhí)行：
t := NewTree() t.AddRouter(pattern, r) p.routers[method] = t
那就到此為止吧,
再愛(ài)就不禮貌了...
結(jié)語(yǔ)
本文通過(guò)源碼解析，從一個(gè)例子入手，了解Beego的AutoRouter模塊是如何工作的，以上就是Beego AutoRouter工作原理解析的詳細(xì)內(nèi)容，更多關(guān)于Beego AutoRouter工作原理的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！
相關(guān)文章
一文帶你了解Go語(yǔ)言中的指針和結(jié)構(gòu)體
前面的兩篇文章對(duì)?Go?語(yǔ)言的基礎(chǔ)語(yǔ)法和基本數(shù)據(jù)類(lèi)型以及幾個(gè)復(fù)合數(shù)據(jù)類(lèi)型進(jìn)行介紹，本文將對(duì)?Go?里面的指針和結(jié)構(gòu)體進(jìn)行介紹，也為后續(xù)文章做鋪墊，感興趣的可以了解一下2022-11-11
golang validator參數(shù)校驗(yàn)的實(shí)現(xiàn)
這篇文章主要介紹了golang validator參數(shù)校驗(yàn)的實(shí)現(xiàn)，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2020-10-10
這篇文章主要介紹了Golang中泛型的使用，Go和Python語(yǔ)言不同，處理不同數(shù)據(jù)類(lèi)型非常嚴(yán)格。如Python可以定義函數(shù)帶兩個(gè)數(shù)值類(lèi)型并返回較大的數(shù)值，但可以不嚴(yán)格指定參數(shù)類(lèi)型為float或integer2022-12-12
舉例詳解Go語(yǔ)言中os庫(kù)的常用函數(shù)用法
Go語(yǔ)言實(shí)現(xiàn)的web爬蟲(chóng)實(shí)例
golang協(xié)程與線(xiàn)程區(qū)別簡(jiǎn)要介紹
基于golang channel實(shí)現(xiàn)的輕量級(jí)異步任務(wù)分發(fā)器示例代碼
Go語(yǔ)言實(shí)現(xiàn)本地緩存的策略詳解