在Gin框架中,中间件(Middleware)指的是可以拦截http请求-响应生命周期的特殊函数,在请求-响应生命周期中可以注册多个中间件,每个中间件执行不同的功能,一个中间执行完再轮到下一个中间件执行。
中间件的常见应用场景如下:
- 请求限速
- api接口签名处理
- 权限校验
- 统一错误处理
提示:如果你想拦截所有请求做一些事情都可以开发一个中间件函数去实现。
Gin支持设置全局中间件和针对路由分组设置中间件,设置全局中间件意思就是会拦截所有请求,针对分组路由设置中间件,意思就是仅对这个分组下的路由起作用。
1.使用中间件
func main() {
r := gin.New()
// 通过use设置全局中间件
// 设置日志中间件,主要用于打印请求日志
r.Use(gin.Logger())
// 设置Recovery中间件,主要用于拦截paic错误,不至于导致进程崩掉
r.Use(gin.Recovery())
// 忽略后面代码
}
2.自定义中间件
下面通过一个例子,了解如果自定义一个中间件
package main
// 导入gin包
import (
"github.com/gin-gonic/gin"
"log"
"time"
)
// 自定义个日志中间件
func Logger() gin.HandlerFunc {
return func(c *gin.Context) {
t := time.Now()
// 可以通过上下文对象,设置一些依附在上下文对象里面的键/值数据
c.Set("example", "12345")
// 在这里处理请求到达控制器函数之前的逻辑
/* c.Next() 是一个方法,通常用于执行注册在当前处理函数之后的中间件
具体来说,c.Next() 的作用是将控制权传递给链中的下一个处理函数或中间件。
当一个请求到达时,Gin框架会依次执行注册在路由处理函数之前的中间件,
而 c.Next() 则用于在中间件中将控制权传递给下一个中间件或路由处理函数。*/
c.Next()
// 在这里可以处理请求返回给用户之前的逻辑,例如这里输出代码执行时长
latency := time.Since(t)
log.Print(latency)
// 例如,查询请求状态吗
status := c.Writer.Status()
log.Println(status)
}
}
func main() {
r := gin.New()
// 注册上面自定义的日志中间件
r.Use(Logger())
// 如这边还有下一个中间件,中间依旧需要c.Next()传递控制权,执行顺序是有序的
// 中间件2
/* r.Use(func(c *gin.Context) {
println("Middleware 2 - Before Request")
c.Next() //控制权传递给下一个函数
println("Middleware 2 - After Request")
})
*/
r.GET("/test", func(c *gin.Context) {
// 查询我们之前在日志中间件,注入的键值数据,c.MustGet()方法用于获取上下文c值储存的值数据
example := c.MustGet("example").(string)
// it would print: "12345"
log.Println(example)
})
// Listen and serve on 0.0.0.0:8080
r.Run(":8080")
}