Gin-Gonic 框架中间件原理与应用

gin, go, web
在 Go 的世界里, web 框架简直多如牛毛.

前有自带电池的标准库(net/http), 后有简洁优雅的 Gin-Gonic(以下简称 Gin), 再有全栈开发一枝花 Beego, 等等不可胜数.

使用 Go 有一段时间了, web 开发一直用的 Gin. Gin 的思想和 Python 框架 Flask 有颇多相似之处, 可以称作 微框架 .

Gin 包括以下几个主要的部分:

  • 设计精巧的路由/中间件系统;
  • 简单好用的核心上下文 Context;
  • 附赠工具集(JSON/XML 响应, 数据绑定与校验等).

本文意在探究 Gin 中间件的执行原理. 我们先看如下的 Hello World 版 Gin 程序：

package main

import (
	"log"
	"net/http"

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

func main() {
	r := gin.Default()

	r.GET("/ping", func(c *gin.Context) {
		c.String(http.StatusOK, "%s", "pong!")
	})

	if err := r.Run("0.0.0.0:8080"); err != nil {
		log.Fatalln(err)
	}
}

这个简单的 Gin 程序默认启用了两个中间件, 分别是 Logger() 和 Recovery().我们之前说过, Context 是 Gin 的核心, 它的构造如下:

type Context struct {
	writermem responseWriter
	Request   *http.Request
	Writer    ResponseWriter

	Params   Params
	handlers HandlersChain
	index    int8

	engine   *Engine
	Keys     map[string]interface{}
	Errors   errorMsgs
	Accepted []string
}

其中 handlers 我们通过源码可以知道就是 []HandlerFunc. 而它的签名正是:

type HandlerFunc func(*Context)

所以中间件和我们普通的 HandlerFunc 没有任何区别对吧, 我们怎么写 HandlerFunc 就可以怎么写一个中间件. 那么问题来了, 我们怎么解决一个请求和一个响应经过我们的中间件呢? 我们来写个简单的中间件分析一下:

r.Use(func(c *gin.Context) {
	log.Println("Request in") // ①
	c.Next() // next handler func
	log.Println("Response out") // ②
})

神奇的语句出现了, 没错就是 c.Next(), 所有中间件都有 Request 和 Response 的分水岭, 就是这个 c.Next(), 否则没有办法传递中间件. 我们来看源码:

func (c *Context) Next() {
	c.index++
	s := int8(len(c.handlers))
	for ; c.index < s; c.index++ {
		c.handlers[c.index](c)
	}
}

一个请求过来, Gin 会主动调用 c.Next() 一次. 因为 handlers 是 slice , 所以后来者中间件会追加到尾部. 这样就形成了形如 m1(m2(f())) 的调用链. 正如上面数字① ② 标注的一样, 我们会依次执行如下的调用:

m1① -> m2① -> f -> m2② -> m1②

我们用下面一张图来来总结这种关系:

middleware stream