gin中间件

Gin 中间件（Middleware）是 Gin 框架中非常重要的概念，它允许你在请求处理流程中插入自定义逻辑。中间件可以用于日志记录、认证、权限控制、请求和响应的处理等。

中间件的基本概念

中间件是一个函数，它接收一个 gin.Context 对象作为参数，并在处理请求前后执行一些逻辑。中间件可以按顺序堆叠，形成一个中间件链。每个中间件都可以决定是否继续调用下一个中间件或直接结束请求。

中间件的常见用途

日志记录：记录请求的详细信息，用于调试和性能分析。
认证和授权：验证请求的认证信息，确保只有授权用户可以访问特定的资源。
请求和响应处理：修改请求或响应的数据，例如添加 CORS 头、压缩响应等。
错误处理：捕获和处理请求过程中出现的错误，提供统一的错误响应格式。
性能监控：记录请求的处理时间，用于性能分析和优化。
数据验证：在处理请求之前验证请求数据的有效性，确保数据符合预期格式。

定义中间件

在 Gin 中，中间件通常是一个函数，其签名如下：

func (c *gin.Context) {// 中间件逻辑
}

使用中间件

Gin 提供了几种方式来使用中间件：

全局中间件：应用于所有路由。
组中间件：应用于某个路由组。
单个路由中间件：应用于特定的路由。

示例代码

1. 全局中间件

全局中间件会在所有路由请求处理之前和之后执行。

package mainimport ("github.com/gin-gonic/gin""log""time"
)// Logger 是一个全局中间件，用于记录请求的时间、方法和路径
func Logger() gin.HandlerFunc {return func(c *gin.Context) {// 记录请求开始时间start := time.Now()// 记录请求开始的信息log.Println("Request started:", c.Request.Method, c.Request.URL.Path)// 调用下一个中间件或处理函数c.Next()// 记录请求完成的时间duration := time.Since(start)log.Println("Request completed:", c.Request.Method, c.Request.URL.Path, duration)}
}func main() {// 创建一个新的 Gin 路由器r := gin.Default()// 注册全局中间件r.Use(Logger())// 定义一个简单的路由r.GET("/", func(c *gin.Context) {c.String(200, "Hello, World!")})// 启动 HTTP 服务器，监听 8080 端口r.Run(":8080")
}

2. 组中间件

组中间件应用于特定的路由组。

package mainimport ("github.com/gin-gonic/gin""log"
)// AuthMiddleware 是一个组中间件，用于验证请求的认证信息
func AuthMiddleware() gin.HandlerFunc {return func(c *gin.Context) {// 获取请求头中的 Authorization 字段authToken := c.GetHeader("Authorization")// 检查是否有认证信息if authToken == "" {// 如果没有认证信息，返回 401 Unauthorized 错误c.JSON(401, gin.H{"error": "Unauthorized"})c.Abort() // 中断请求处理链return}// 继续处理请求c.Next()}
}func main() {// 创建一个新的 Gin 路由器r := gin.Default()// 创建一个路由组，并注册组中间件protected := r.Group("/api", AuthMiddleware()){// 定义一个受保护的路由protected.GET("/profile", func(c *gin.Context) {c.JSON(200, gin.H{"message": "Profile page"})})}// 启动 HTTP 服务器，监听 8080 端口r.Run(":8080")
}

3. 单个路由中间件

单个路由中间件应用于特定的路由。

package mainimport ("github.com/gin-gonic/gin""log"
)// LoggingMiddleware 是一个单个路由中间件，用于记录请求的信息
func LoggingMiddleware() gin.HandlerFunc {return func(c *gin.Context) {// 记录请求开始的信息log.Println("Logging middleware: Request started")// 调用下一个中间件或处理函数c.Next()// 记录请求完成的信息log.Println("Logging middleware: Request completed")}
}func main() {// 创建一个新的 Gin 路由器r := gin.Default()// 定义一个带有单个路由中间件的路由r.GET("/ping", LoggingMiddleware(), func(c *gin.Context) {c.String(200, "Pong")})// 启动 HTTP 服务器，监听 8080 端口r.Run(":8080")
}

4.综合示例

package mainimport ("github.com/gin-gonic/gin""log""time"
)// Logger 是一个全局中间件，用于记录请求的时间、方法和路径
func Logger() gin.HandlerFunc {return func(c *gin.Context) {// 记录请求开始时间start := time.Now()// 记录请求开始的信息log.Println("Request started:", c.Request.Method, c.Request.URL.Path)// 调用下一个中间件或处理函数c.Next()// 记录请求完成的时间duration := time.Since(start)log.Println("Request completed:", c.Request.Method, c.Request.URL.Path, duration)}
}// AuthMiddleware 是一个组中间件，用于验证请求的认证信息
func AuthMiddleware() gin.HandlerFunc {return func(c *gin.Context) {// 获取请求头中的 Authorization 字段authToken := c.GetHeader("Authorization")// 检查是否有认证信息if authToken == "" {// 如果没有认证信息，返回 401 Unauthorized 错误c.JSON(401, gin.H{"error": "Unauthorized"})c.Abort() // 中断请求处理链return}// 继续处理请求c.Next()}
}// LoggingMiddleware 是一个单个路由中间件，用于记录请求的信息
func LoggingMiddleware() gin.HandlerFunc {return func(c *gin.Context) {// 记录请求开始的信息log.Println("Logging middleware: Request started")// 调用下一个中间件或处理函数c.Next()// 记录请求完成的信息log.Println("Logging middleware: Request completed")}
}func main() {// 创建一个新的 Gin 路由器r := gin.Default