Gin 的启动过程、路由及上下文源码解读

Posted 2023-03-09

参考技术A

Engine 是 gin 框架的一个实例，它包含了多路复用器、中间件和配置中心。

gin 通过 Engine.Run(addr ...string) 来启动服务，最终调用的是 http.ListenAndServe(address, engine) ，其中第二个参数应当是一个 Handler 接口的实现，即 engine 实现了此接口：

Engine.ServeHTTP() 会先初始化一个空的上下文，然后挂上请求 c.Reuqest = req ，随后执行 engine.handlerHTTPRequest(c) （包含主要处理逻辑的函数）。

以上就是正常处理一个请求的主要逻辑，其他的就现阶段来说先忽略了。

Engine 组合了 RouterGroup。

RouterGroup 实现了 IRouter 接口，IRouter 接口是 IRoutes 接口和 Group 函数组合而成。

RouterGroup 的结构体只有四个属性：

当新建 Engine 时，会初始化一个 RouterGroup 结构，RouterGroup 是组合在 Engine 中的（所以 Engine 可以调用 RouterGroup 的所有方法），同时 Engine 的引用也记录在了 RouterGroup 上。

如上，RouterGroup 实现了 IRouter 接口，下面是一些方法的实现。

gin 通过上方 RouterGroup 暴露的几个方法添加路由，底层使用的方法是 Engine.addRoute(method, path string, handlers HandlerChain) 。

Engine.trees 属性是存储所有路由信息的总入口。它是一个切片，其中每个元素对应一种 method 并且是一个多叉树的根节点。

当 addRoute 时，先根据 method 找到对应的 tree （Engine.trees[i]）。然后会比较 加入者 的 path 和 node 中的 path 相似的部分， 相似的部分 作为 父结点，不同的部分作为 子结点。以 多叉树 的方式存储下来。

这里会把 URL 中的路由变量也当作字符串存入树中，因为相同 URL 他们的变量也是一样的。

当请求进来时，因为 Engine 实现了 Handler 接口，所以最后会调用到 Engine.ServeHTTP 内。

找路径在

root.getValue() 比较复杂，这里就不多解释了。

gin@v1.7.7 context.go

Context 中定义了一些属性和方法，用于扩展一些功能。

可以看到，这些方法主要用来获取 gin 自身 Context 的一些信息。

Context 中保存了所有 handlers 列表，存在 Context.handlers 数组中，并用下标 Context.index 标记当前执行的位置。
当主动取消调用链时，会将 index 设置成一个最大值 63（ math.MaxInt8 / 2 ），也即调用链最大支持 64 个函数。
Context 中还提供了其他一些函数，当取消调用链的时候，可以设置请求返回的状态码和返回数据信息等。

Context 中的 httpWriter 整理一下。

gin 在 Context 中定义了错误信息字段 Context.Errors 切片，可以链式存储错误信息。

Go 原生的 Context 是通过 ValueContext 来存储元数据信息的，每个 ValueContext 只能存储一对信息，存储多个信息对需要将许多 ValueContext 组成链条，读写很不高效。
gin 的 Context 中存的元数据数据是存在 Context.Keys map[string]interface 属性中的，比起原生的 Context 使用起来会更高效。

是指用在 URL 路径中设置的参数，如 /user/:id 的 id 参数。
存储在 Context.Params 属性中，其本质是一个切片，每一个元素是一个 K/V 元组。
因此，在 URL 中是可以使用重复的变量名的（如 /test/:id/case/:id ），但获取值就需要自己从属性中获取了（如： c.Params[0] ）。

Query 类是用在 URL 后的参数部分（如： ?id=1 ）。

gin 通过 Context.queryCache 属性存储 query 参数，在调用获取 Query 参数时以懒加载的方式初始化： c.queryCache = c.Request.URL.Query() 。

需要注意的是它也支持传入 map 和 array，map 的传入需要像这样 ?m[k1]=v1&m[k2]=v2 ，array 的传入像这样 ?a=1&a=2 。

包含 PostForm、FormFile、MultipartForm 等。
先略

gin 为方便使用，通过绑定引擎设置了自动绑定用户输入和结构数据的方法。

这里包含设置状态码、设置响应头以及等信息。

只说一些值得注意的

这些方法除了 .Value() 方法外，其他都是返回的默认空值，略。