golang自定义路由器设计
HTTP路由組件負責將HTTP請求交到對應的函數處理(或者是一個struct的方法),如前面小節所描述的結構圖,路由在框架中相當于一個事件處理器,而這個事件包括:
- 用戶請求的路徑(path)(例如:/user/123,/article/123),當然還有查詢串信息(例如?id=11)
- HTTP的請求方法(method)(GET、POST、PUT、DELETE、PATCH等)
路由器就是根據用戶請求的事件信息轉發到相應的處理函數(控制層)。
默認的路由實現
func fooHandler(w http.ResponseWriter, r *http.Request) {fmt.Fprintf(w, "Hello, %q", html.EscapeString(r.URL.Path)) }http.HandleFunc("/foo", fooHandler)http.HandleFunc("/bar", func(w http.ResponseWriter, r *http.Request) {fmt.Fprintf(w, "Hello, %q", html.EscapeString(r.URL.Path)) })log.Fatal(http.ListenAndServe(":8080", nil))上面的例子調用了http默認的DefaultServeMux來添加路由,需要提供兩個參數,第一個參數是希望用戶訪問此資源的URL路徑(保存在r.URL.Path),第二參數是即將要執行的函數,以提供用戶訪問的資源。路由的思路主要集中在兩點:
- 添加路由信息
- 根據用戶請求轉發到要執行的函數
Go默認的路由添加是通過函數http.Handle和http.HandleFunc等來添加,底層都是調用了DefaultServeMux.Handle(pattern string, handler Handler),這個函數會把路由信息存儲在一個map信息中map[string]muxEntry,這就解決了上面說的第一點。
Go監聽端口,然后接收到tcp連接會扔給Handler來處理,上面的例子默認nil即為http.DefaultServeMux,通過DefaultServeMux.ServeHTTP函數來進行調度,遍歷之前存儲的map路由信息,和用戶訪問的URL進行匹配,以查詢對應注冊的處理函數,這樣就實現了上面所說的第二點。
for k, v := range mux.m {if !pathMatch(k, path) {continue}if h == nil || len(k) > n {n = len(k)h = v.h} }beego框架路由實現
目前幾乎所有的Web應用路由實現都是基于http默認的路由器,但是Go自帶的路由器有幾個限制:
- 不支持參數設定,例如/user/:uid 這種泛類型匹配
- 無法很好的支持REST模式,無法限制訪問的方法,例如上面的例子中,用戶訪問/foo,可以用GET、POST、DELETE、HEAD等方式訪問
- 一般網站的路由規則太多了,編寫繁瑣。我前面自己開發了一個API應用,路由規則有三十幾條,這種路由多了之后其實可以進一步簡化,通過struct的方法進行一種簡化
beego框架的路由器基于上面的幾點限制考慮設計了一種REST方式的路由實現,路由設計也是基于上面Go默認設計的兩點來考慮:存儲路由和轉發路由
存儲路由
針對前面所說的限制點,我們首先要解決參數支持就需要用到正則,第二和第三點我們通過一種變通的方法來解決,REST的方法對應到struct的方法中去,然后路由到struct而不是函數,這樣在轉發路由的時候就可以根據method來執行不同的方法。
根據上面的思路,我們設計了兩個數據類型controllerInfo(保存路徑和對應的struct,這里是一個reflect.Type類型)和ControllerRegistor(routers是一個slice用來保存用戶添加的路由信息,以及beego框架的應用信息)
type controllerInfo struct {regex *regexp.Regexpparams map[int]stringcontrollerType reflect.Type }type ControllerRegistor struct {routers []*controllerInfoApplication *App }ControllerRegistor對外的接口函數有
func (p *ControllerRegistor) Add(pattern string, c ControllerInterface)詳細的實現如下所示:
func (p *ControllerRegistor) Add(pattern string, c ControllerInterface) {parts := strings.Split(pattern, "/")j := 0params := make(map[int]string)for i, part := range parts {if strings.HasPrefix(part, ":") {expr := "([^/]+)"//a user may choose to override the defult expression// similar to expressjs: ‘/user/:id([0-9]+)’if index := strings.Index(part, "("); index != -1 {expr = part[index:]part = part[:index]}params[j] = partparts[i] = exprj++}}//recreate the url pattern, with parameters replaced//by regular expressions. then compile the regexpattern = strings.Join(parts, "/")regex, regexErr := regexp.Compile(pattern)if regexErr != nil {//TODO add error handling here to avoid panicpanic(regexErr)return}//now create the Routet := reflect.Indirect(reflect.ValueOf(c)).Type()route := &controllerInfo{}route.regex = regexroute.params = paramsroute.controllerType = tp.routers = append(p.routers, route)}靜態路由實現
上面我們實現的動態路由的實現,Go的http包默認支持靜態文件處理FileServer,由于我們實現了自定義的路由器,那么靜態文件也需要自己設定,beego的靜態文件夾路徑保存在全局變量StaticDir中,StaticDir是一個map類型,實現如下:
func (app *App) SetStaticPath(url string, path string) *App {StaticDir[url] = pathreturn app }應用中設置靜態路徑可以使用如下方式實現:
beego.SetStaticPath("/img","/static/img")轉發路由
轉發路由是基于ControllerRegistor里的路由信息來進行轉發的,詳細的實現如下代碼所示:
// AutoRoute func (p *ControllerRegistor) ServeHTTP(w http.ResponseWriter, r *http.Request) {defer func() {if err := recover(); err != nil {if !RecoverPanic {// go back to panicpanic(err)} else {Critical("Handler crashed with error", err)for i := 1; ; i += 1 {_, file, line, ok := runtime.Caller(i)if !ok {break}Critical(file, line)}}}}()var started boolfor prefix, staticDir := range StaticDir {if strings.HasPrefix(r.URL.Path, prefix) {file := staticDir + r.URL.Path[len(prefix):]http.ServeFile(w, r, file)started = truereturn}}requestPath := r.URL.Path//find a matching Routefor _, route := range p.routers {//check if Route pattern matches urlif !route.regex.MatchString(requestPath) {continue}//get submatches (params)matches := route.regex.FindStringSubmatch(requestPath)//double check that the Route matches the URL pattern.if len(matches[0]) != len(requestPath) {continue}params := make(map[string]string)if len(route.params) > 0 {//add url parameters to the query param mapvalues := r.URL.Query()for i, match := range matches[1:] {values.Add(route.params[i], match)params[route.params[i]] = match}//reassemble query params and add to RawQueryr.URL.RawQuery = url.Values(values).Encode() + "&" + r.URL.RawQuery//r.URL.RawQuery = url.Values(values).Encode()}//Invoke the request handlervc := reflect.New(route.controllerType)init := vc.MethodByName("Init")in := make([]reflect.Value, 2)ct := &Context{ResponseWriter: w, Request: r, Params: params}in[0] = reflect.ValueOf(ct)in[1] = reflect.ValueOf(route.controllerType.Name())init.Call(in)in = make([]reflect.Value, 0)method := vc.MethodByName("Prepare")method.Call(in)if r.Method == "GET" {method = vc.MethodByName("Get")method.Call(in)} else if r.Method == "POST" {method = vc.MethodByName("Post")method.Call(in)} else if r.Method == "HEAD" {method = vc.MethodByName("Head")method.Call(in)} else if r.Method == "DELETE" {method = vc.MethodByName("Delete")method.Call(in)} else if r.Method == "PUT" {method = vc.MethodByName("Put")method.Call(in)} else if r.Method == "PATCH" {method = vc.MethodByName("Patch")method.Call(in)} else if r.Method == "OPTIONS" {method = vc.MethodByName("Options")method.Call(in)}if AutoRender {method = vc.MethodByName("Render")method.Call(in)}method = vc.MethodByName("Finish")method.Call(in)started = truebreak}//if no matches to url, throw a not found exceptionif started == false {http.NotFound(w, r)} }使用入門
基于這樣的路由設計之后就可以解決前面所說的三個限制點,使用的方式如下所示:
基本的使用注冊路由:
beego.BeeApp.RegisterController("/", &controllers.MainController{})參數注冊:
beego.BeeApp.RegisterController("/:param", &controllers.UserController{})正則匹配:
beego.BeeApp.RegisterController("/users/:uid([0-9]+)", &controllers.UserController{})總結
以上是生活随笔為你收集整理的golang自定义路由器设计的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: golang备份和恢复
- 下一篇: golang中的Session支持