在go语言中Gin框架中间件原理及自定义中间件代码示例

Go  /  管理员 发布于 2个月前   72

你知道什么是中间件？什么场景能用中间件？在此之前我们先来看一下Gin实例化server,我们在之前是使用router := gin.Default()，但其实我们是可以直接使用router := gin.New(), 

那么在之前是实例中我们为什么不使用gin.New()呢？

别急，我们先来看看gin.Default()的源码：

// Default returns an Engine instance with the Logger and Recovery middleware already attached.
    func Default() *Engine {
    debugPrintWARNINGDefault()
    engine := New()
    engine.Use(Logger(), Recovery())
    return engine
}

我们可以看到Default()其实是对gin.New()做了一层封装，并且做了其他事情，

这里的其他事情就有“中间件”

即：

engine.Use(Logger(), Recovery())他调用两两个中间件（ Logger()用来输出日志信息，
Recovery 中间件会恢复(recovers) 任何恐慌(panics) 如果存在恐慌，中间件将会写入500）

Gin中间件原理

我们来看看：engine.Use()

func (engine *Engine) Use(middleware ...HandlerFunc) IRoutes {
    engine.RouterGroup.Use(middleware...)
    engine.rebuild404Handlers()
    engine.rebuild405Handlers()
    return engine
}

入参是HandlerFunc类型，那么我们接着往下看HandlerFunc

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

其实HandlerFunc 是func(*Context)类型

到这里中间件我们就可以自定义了

Gin自定义中间件

我们定义一个监控服务运行时间，运行状态的中间件：

//自定义中间件，这里我们以函数调用的形式，对中间件进一步封装
func MyTimeLogger() gin.HandlerFunc {
    return func(c *gin.Context) {  //真正的中间件类型
        t := time.Now()
        c.Set("msg", "This is a test of middleware")
        //它执行调用处理程序内链中的待处理处理程序
        //让原本执行的逻辑继续执行
        c.Next()
        end := time.Since(t)
        fmt.Printf("耗时：%D\n", end.Seconds())
        status := c.Writer.Status()
        fmt.Println("状态监控:", status)
    }
}

我们在main函数中：

func main() {
    router := gin.Default()
    router.Use(MyTimeLogger())   //这里使用函数调用
    router.GET("/ping", func(c *gin.Context) {
        c.JSON(http.StatusOK, gin.H{
        "msg": "Pong",
        })
    })
    
    router.Run(":8083")
}

访问：

http://localhost:8083/ping

返回 ：

{"msg":"Pong"}