Gin Engine源碼詳解

gin是什麼？

Gin 是一個用 Go (Golang) 寫的 HTTP Web 框架。它具有類似 Martini 的 API，但效能比 Martini 快 40 倍。如果你需要極好的性能，使用 Gin 吧。

gin 為什麼快？

我們先來看看官方的基準測試地址^[1]

這只是其中的一部分，完整的可以自行進入上述地址進行查看。

我們透過效能測試看得出來 gin 在處理請求的效能上確實比其他的web 框架快上不少。

效能問題主要是使用httprouter^[2]，而httprouter使用Trie Tree（字典樹）作為路徑儲存結構，具有高效能的查找。

gin.Engine 原始碼

// Engine is the framework's instance, it contains the muxer, middleware and configuration settings.
// Create an instance of Engine, by using New() or Default()
type Engine struct {
   RouterGroup       // 用于注册根路由组使用
    ...
    pool             sync.Pool    // 用于 gin.context 对象池
    trees            methodTrees  // 用于保存的请求路径
    ...
}

在 gin 的Engine中，最主要的就是這3個欄位。

gin.RouterGroup 源码

// HandlerFunc defines the handler used by gin middleware as return value.
type HandlerFunc func(*Context)

// HandlersChain defines a HandlerFunc array.
type HandlersChain []HandlerFunc

// RouterGroup is used internally to configure router, a RouterGroup is associated with
// a prefix and an array of handlers (middleware).
type RouterGroup struct {
    Handlers HandlersChain
    basePath string
    engine   *Engine
    root     bool
}

在RouterGroup中Handlers存放的是当前分组的所有中间件，也可以说：请求到这个分组，那么Handlers 中的函数都会根据索引从小到大的按顺序执行。

basePath 就是存放这个分组的基础路由路径。可能直接解释过于抽象；我们来分析它的调用链来看：

1. 
2. 
3. 

在gin.New() 函数中我们可以看到 basePath 默认是 /

而新的RouterGroup是通过Engine调用Group函数产生的；也就是我们自己的Group。

那么以后在这个Group注册的路径都会自动加上/user的路径。

为什么会自动添加路径，后面还会分析相关细节。

gin.methodTree 源码

type node struct {
   path      string
   indices   string
   wildChild bool
   nType     nodeType
   priority  uint32
   children  []*node // child nodes, at most 1 :param style node at the end of the array
   handlers  HandlersChain
   fullPath  string
}

type methodTree struct {
    method string
    root   *node
}

type methodTrees []methodTree

对于node的添加和查找我就不展开讲了，如果不懂的可以自行搜索字典树和查看 httprouter^[3] 的实现。

我们刚刚在gin.New 函数中可以看到，trees是一个methodTree的切片，并在在初始化给了默认容量为9，是容量不是长度哦。

在addRoute 函数中可以看到trees的添加：

如果開始沒有對應方法的根路徑node對象，就會建立一個出來，然後再去新增對應的路由註冊。

整體的流程分析

在gin框架中，主要可以使用以下幾種註冊方式：

• #對應的http請求方法的名稱（get,post,put...）
• #透過Group分組路由減少路徑的填入
• 透過Any 註冊所有http方法路由

##這些註冊在下面其實都是召喚的同一個方法，我們接下來要來翻開她的外套看看裡面是什麼樣的。

可以看到都是呼叫的

group.handle 方法

我們來看這個方法都做了哪些事情：

• 計算路由的路徑group.calculateAbsolutePath(relativePath)
• 為目前註冊的路徑增加中間件函數，並將註冊的函數放在最後面
• 加入到全域路由表
• #回傳一個IRoutes介面

combineHandlers 支援最大的函數數量為63-1個

Group 函數

#現在來看Group的實現，透過呼叫這個方法會產生一個新的RouterGroup 並根據參數設定的基礎路徑，和全域engine實體，並把基礎的中間件也複製到其中。

使用分組路由最後也是呼叫group.handle方法進行註冊，只是其中的basePath在分組的時候已經設置好了，加上註冊函數時的路徑，就是這個請求的路由路徑。

要注意的一點，我之前想過使用·Group·後，它後面的註冊沒有使用回傳值，註冊的路由是怎麼註冊到全域路由表中的，看過原始碼才明白。

添加路由的时候，是获取的全局engine 实体，所以也是添加到全局路由表中的。

最后需要注意的

在使用注册中间件和注册路由的时候，需要注意他们注册的顺序。

上一点错误的注册方式代码：

package main

import (
 "github.com/gin-gonic/gin"
)

func main() {
 eng := gin.New()
 eng.POST("login", func(context *gin.Context) {
  // 处理登录信息
 })
 eng.Use(gin.Logger())

 userGroup := eng.Group("/user")
 userGroup.GET("info", func(context *gin.Context) {
  // 参数验证

  // 处理逻辑
 })

 adminGroup := eng.Group("/admin")
 adminGroup.GET("info", func(context *gin.Context) {
  // 参数验证

  // 处理逻辑
 })

 eng.Use(gin.Recovery())
 adminGroup.PUT("info", func(context *gin.Context) {
  // 参数验证

  // 处理逻辑
 })
 eng.GET("logout", func(context *gin.Context) {
  // 处理登录信息
 })
 eng.Run(":8080")
}

运行结果：

可以看到在注册路由之后，再注册中间件，那么前面注册过的路由是没有这个中间件的。

以上是Gin Engine源碼詳解的詳細內容。更多資訊請關注PHP中文網其他相關文章！