大话图解gin源码

前言

最近在网上搜了一下，对于gin框架用的人还是比较多的，我自己之前也在使用，但是对于源码解析这块，我没有看到自己想看到的那种从框架入手的解析图，所以嘿嘿嘿，我的机会就来了，今天就带来最完整的gin源码图解。希望通过这篇博客你也能自己学会拆轮子。

PS：本文建立在你已经能熟练使用gin的基础之上，如果还没用过可以去官网看一下：
https://gin-gonic.com/zh-cn/docs/
然后gin是对golang的http包的封装，所以最好对http包也要有了解。

整体分析逻辑

先来说明一下我整体拆解的逻辑，对于一个框架，我喜欢从下面几个方面去入手拆解：

1. 启动方式
2. 如何使用
3. 实现与特点
   针对于gin，我也将从这几个方面去入手，就会得到下面几个问题，带着问题看源码是必备条件。
   首先启动的时候gin做了些什么？
   gin封装了什么然后怎么去实现的？
   gin整体结构是怎么样的，有哪些结构？
   ...

然后使用一个比较小的demo，然后先从方法入手，进源码看。

func main() {
    router := gin.Default()
    
    router.Use(gin.Recovery())
    
    router.GET("/test", func(context *gin.Context) {
        context.JSON(http.StatusOK, gin.H{
            "code" : 1,
            "message" : "xxx",
        })
    })

    if err := router.Run(); err != nil {
        panic(err)
    }
}

整体结构认识

image

Engine是一个总的引擎，保存了各个组件的信息
RouterGroup是一个路由组，保存了路由信息
trees是一棵树，保存了url与handle的映射关系
engine中的pool用于复用Context
Context用于request中传递值

这样你就对gin的整个结构有了大致的认识，当然有一些细节字段我这里就不展开了。

每个方法分析

gin.Default()

image

调用过程大概是这样，这是一个gin的初始化方法，目的是为了创建整个引擎，并初始化相关参数。初始化RouterGroup、pool等

router.Use()

image

这个是一个使用中间件的方法，当然中间件也有别的方法，这边使用use举例，其实就是将请求过程中需要调用的中间件放入到HandlersChain，这个是一个数组
PS：你不知道中间件？那你用一下就知道了，我们很多时候再请求前后需要加入通用方法如鉴权等，就会用到它

router.GET

image

这个就是构建url和具体处理请求的handle的关系了，其实目标很明确，就是要将这组关系存入到最终的trees中去，这里先这样，后面会有详细解释。

router.Run()

image

这个就非常简单了，就是调用golang中http包下的方法监听服务端口而已，没啥好说的，启动了嘛。

func (engine *Engine) ServeHTTP

你以为这就完了？？？上面只是启动的时候，那么请求过来的时候怎么办呢？
我们知道如果要接收请求，那么就需要实现下面这个接口

type Handler interface {
    ServeHTTP(ResponseWriter, *Request)
}

接口中ServeHTTP就是用来处理请求的，所有请求都会经过这个方法去处理。
那么gin是怎么实现这个方法的呢？

image

这个就是调用过程，总的来说就是根据请求的url和method找到对应的handle去处理，还记得之前那棵树吗？对，就是去里面找。同时利用context进行参数传递，最后注意很隐秘的用c.Next进行递归的调用（我已开始都没找到）为啥要递归？因为有中间件鸭！handle是一个链式过程而非只有一个handle

至此所有gin的框架里面的内容应该都包括了，包括整个实现过程，其实并不复杂，你可以根据上面的过程在源码中找到对应的地方详细查看。

好在哪里？

我们看源码肯定不能看完，哦，知道怎么实现就完事了，我们最终的目的是要学习其中的优点，那么这个框架有哪些好的地方呢？我个人总结了以下三点供你参考。

context

使用context包含了Request，Writer等信息，用它来传递参数，也算是利用golang的一个特性去做的，我没想到。

sync.pool

利用pool来重复利用对象，因为请求很多，所以会产生很多数量的context，利用sync.pool进行复用，从而减少内存的分配也提高了效率，值得学习。

trees

用什么数据结构存放的url和handle的映射关系呢？
我一开始想到的就是map，直接弄个hashmap存一下不就好了嘛，没想到gin用了一颗树来进行存放，内部实现很复杂，这里不做展开，据说是radix tree，我就是把它理解成字典树，从而提高存储和查询，棒。

总结

其实gin框架本身实现好像并不是很复杂，很适合新手进行学习，其中也有一些设计思想可以借鉴。