上一篇簡單介紹了gin, 以及net/http是如何數據流轉的, 本篇將詳細介紹gin
數據如何在gin中流轉
package main
import "github.com/gin-gonic/gin"
func main() {
r := gin.Default()
r.GET("/ping", func(c *gin.Context) {
c.JSON(200, gin.H{
"message": "pong",
})
})
r.Run() // listen and serve on 0.0.0.0:8080
}
這段代碼的大概流程:
-
r := gin.Default()初始化了相關的參數 -
/ping將路由及處理handler注冊到路由樹中 - 啟動服務
r.Run()其實調用的是err = http.ListenAndServe(address, engine), 結合上一篇文章可以看出來, gin其實利用了net/http的處理過程
ServeHTTP的作用
上一篇文章有提到DefaultServeMux, 其實DefaultServeMux實現了ServeHTTP(ResponseWriter, *Request), 在request執行到server.go的serverHandler{c.server}.ServeHTTP(w, w.req)這一行的時候, 從DefaultServeMux取到了相關路由的處理handler.
因此, gin框架的Engine最重要的函數就是func (engine *Engine) ServeHTTP(w http.ResponseWriter, req *http.Request). Engine實現了Handler(server.go#L84-86), 讓net/http請求數據最終流回到gin中, 從gin的route tree中取到相關的中間件及handler, 來處理客戶端的request
Engine
在整個gin框架中最重要的一個struct就是Engine, 它包含路由, 中間件, 相關配置信息等. Engine的代碼主要就在gin.go中
Engine中比較重要的幾個屬性, 其他的屬性暫時全部省略掉
type Engine struct {
RouterGroup // 路由
pool sync.Pool // context pool
trees methodTrees // 路由樹
// html template及其他相關屬性先暫時忽略
}
Engine有幾個比較主要的函數:
New(), Default()
func New() *Engine {
// ...
engine := &Engine{
RouterGroup: RouterGroup{
Handlers: nil,
basePath: "/",
root: true,
},
// ...
trees: make(methodTrees, 0, 9),
}
engine.RouterGroup.engine = engine
engine.pool.New = func() interface{} {
return engine.allocateContext()
}
return engine
}
New()主要干的事情:
- 初始化了Engine
- 將RouterGroup的Handlers(數組)設置成nil, basePath設置成
/ - 為了使用方便, RouteGroup里面也有一個Engine指針, 這里將剛剛初始化的engine賦值給了RouterGroup的engine指針
- 為了防止頻繁的context GC造成效率的降低, 在Engine里使用了
sync.Pool, 專門存儲gin的Context
func Default() *Engine {
debugPrintWARNINGDefault()
engine := New()
engine.Use(Logger(), Recovery())
return engine
}
Default()跟New()幾乎一模一樣, 就是調用了gin內置的Logger(), Recovery()中間件.
Use()
func (engine *Engine) Use(middleware ...HandlerFunc) IRoutes {
engine.RouterGroup.Use(middleware...)
engine.rebuild404Handlers()
engine.rebuild405Handlers()
return engine
}
Use()就是gin的引入中間件的入口了. 仔細分析這個函數, 不難發現Use()其實是在給RouteGroup引入中間件的. 具體是如何讓中間件在RouteGroup上起到作用的, 等說到RouteGroup再具體說.
engine.rebuild404Handlers()
engine.rebuild405Handlers()
這兩句函數其實在這里沒有任何用處. 我感覺這里是給gin的測試代碼用的. 我們在使用gin的時候, 要想在404, 405添加處理過程, 可以通過NoRoute(), NoMethod()來處理.
addRoute()
func (engine *Engine) addRoute(method, path string, handlers HandlersChain) {
...
root := engine.trees.get(method)
if root == nil {
root = new(node)
engine.trees = append(engine.trees, methodTree{method: method, root: root})
}
root.addRoute(path, handlers)
}
這段代碼就是利用method, path, 將handlers注冊到engine的trees中. 注意這里為什么是HandlersChain呢, 可以簡單說一下, 就是將中間件和處理函數都注冊到method, path的tree中了.
Run系列函數
Run, RunTLS, RunUnix, RunFd 這些函數其實都是最終在調用net/http的http服務.
ServeHTTP
這個函數相當重要了, 主要有這個函數的存在, 才能將請求轉到gin中, 使用gin的相關函數處理request請求.
...
t := engine.trees
for i, tl := 0, len(t); i < tl; i++ {
if t[i].method != httpMethod {
continue
}
root := t[i].root
handlers, params, tsr := root.getValue(path, c.Params, unescape)
if handlers != nil {
c.handlers = handlers
c.Params = params
c.Next()
c.writermem.WriteHeaderNow()
return
}
...
}
利用request中的path, 從Engine的trees中獲取已經注冊的handler
func (c *Context) Next() {
c.index++
for c.index < int8(len(c.handlers)) {
c.handlers[c.index](c)
c.index++
}
}
在Next()執行handler的操作. 其實也就是下面的函數
func(c *gin.Context) {
c.JSON(200, gin.H{
"message": "pong",
})
}
如果在trees中沒有找到對應的路由, 則會執行serveError函數, 也就是404相關的.
