在Gin框架中,中间件(Middleware)指的是可以拦截http请求-响应生命周期的特殊函数,在请求-响应生命周期中可以注册多个中间件,每个中间件执行不同的功能,一个中间执行完再轮到下一个中间件执行。作用等同于java中的拦截器。
中间件的常见应用场景如下:
- 统一错误处理
- 统一日志处理
- 接口签名处理
- 权限校验
- 请求限速
提示:如果你想拦截所有请求做一些事情,那么可以开发一个中间件函数去统一集中处理。
Gin支持设置全局中间件和针对路由分组设置中间件,设置全局中间件意思就是会拦截所有请求,针对分组路由设置中间件,意思就是仅对这个分组下的路由起作用。
1.使用系统中间件
func main() {
r := gin.New()
// 通过use设置全局中间件,gin.Default()与gin.New()的区别就是,gin.Default()包含以下两个中间件。
// 设置日志中间件,主要用于打印请求日志
r.Use(gin.Logger())
// 设置Recovery中间件,主要用于拦截paic错误,不至于导致进程崩掉
r.Use(gin.Recovery())
// 忽略后面代码...
}
2.自定义中间件
下面通过一个例子,了解自定义一个中间件,并使用。
package main
import (
"fmt"
"github.com/gin-gonic/gin"
"net/http"
"time"
)
func main() {
// 1.创建实例
r := gin.Default()
// 2.设置自定义中件间
r.Use(MyMiddleware())
// 3.路由
r.GET("/", func(c *gin.Context) {
// 读取中件间设置的值
req, _ := c.Get("middleware_value")
fmt.Println("4.Handler执行,读取middleware_value:", req)
c.JSON(http.StatusOK, gin.H{
"message": req,
})
})
// 4.启动
r.Run(":8080")
}
// 自定义中间件
func MyMiddleware() gin.HandlerFunc {
return func(c *gin.Context) {
t := time.Now()
fmt.Println("1.中间件开始执行:设置middleware_value")
// 设置变量到Context的key中,可以通过Get()取
c.Set("middleware_value", "from middleware")
// 读取Context中的值
status := c.Writer.Status()
fmt.Println("2.中间件执行完毕:", status)
t2 := time.Since(t)
fmt.Println("3.中间件执行时间:", t2)
}
}