在 Gin 框架中，如果多个路由有相同的处理逻辑，可以将该处理逻辑封装成一个中间件函数，然后将该中间件函数应用到需要共享该处理逻辑的路由上。这样，就可以避免代码冗余，提高代码复用性。
中间件函数是一个函数，它接收一个 *gin.Context 参数，处理完该参数后，再调用 c.Next() 将请求交给下一个处理函数继续处理。中间件函数通常用于实现一些公共的功能，比如登录验证、身份认证、日志记录等。
下面是一个示例代码，演示了如何在 Gin 框架中使用中间件函数共享相同的处理逻辑：
package main
import (
"fmt"
"net/http"
"github.com/gin-gonic/gin"
)
// 中间件函数
func loggingMiddleware() gin.HandlerFunc {
return func(c *gin.Context) {
fmt.Println("loggingMiddleware start")
c.Next()
fmt.Println("loggingMiddleware end")
}
}
func main() {
r := gin.Default()
// 将中间件函数应用到需要共享处理逻辑的路由上
r.Use(loggingMiddleware())
r.GET("/user/:id", func(c *gin.Context) {
id := c.Param("id")
c.JSON(http.StatusOK, gin.H{"user_id": id})
})
r.POST("/user", func(c *gin.Context) {
var user struct {
Name string `json:"name"`
Email string `json:"email"`
}
if err := c.ShouldBindJSON(&user); err != nil {
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}
c.JSON(http.StatusOK, gin.H{"name": user.Name, "email": user.Email})
})
r.Run(":8080")
}
在上面的代码中，定义了一个名为 loggingMiddleware 的中间件函数，它会在处理路由之前和之后分别输出日志。然后，通过 r.Use(loggingMiddleware()) 将该中间件函数应用到所有路由上。这样，无论客户端请求的是 /user/:id 路由还是 /user 路由，都会先执行中间件函数，再执行路由处理函数。
在Gin框架中，通过使用Use()方法注册中间件。Use()方法接受一个或多个函数作为参数，并将它们添加到中间件栈中。这些函数将在每个路由处理程序被调用之前按注册顺序执行。
需要注意的是，如果需要将中间件函数应用到指定的路由上，可以使用 r.GET("/user/:id", loggingMiddleware(), func(c *gin.Context) {...}) 的形式，将中间件函数作为参数传递给路由处理函数即可，例如。
r.GET("/", loggingMiddleware(), func(c *gin.Context) {
c.JSON(http.StatusOK, gin.H{"message": "Hello, World!"})
})
通过在路由处理器函数调用之前添加loggingMiddleware()函数，我们将中间件与该路由处理程序绑定。
还可以使用Group()方法将一组路由处理器分组，并将一组中间件应用于该组。
// 作用于某个组
authorizedApi := r.Group("/api")
authorizedApi.Use(AuthMiddleware())
{
authorizedApi.POST("/first", func(c *gin.Context) {
c.JSON(http.StatusOK, gin.H{
"message": "first",
})
})
authorizedApi.POST("/second", func(c *gin.Context) {
c.JSON(http.StatusOK, gin.H{
"message": "second",
})
})
}
另一个例子
Gin中间件还可以通过传递参数进行自定义。例如，我们可以将需要跟踪的路径作为参数传递给中间件。下面是一个示例：
func Logger(trackPath string) gin.HandlerFunc {
return func(c *gin.Context) {
if c.Request.URL.Path == trackPath {
log.Println("Tracking path: ", trackPath)
}
c.Next()
}
}
func main() {
r := gin.Default()
// 注册中间件
r.Use(Logger("/login"))
r.GET("/", func(c *gin.Context) {
c.JSON(http.StatusOK, gin.H{"message": "Hello, World!"})
})
r.Run(":8080")
}
在这个示例中，我们修改了Logger()函数，以接受一个trackPath参数。在函数内部，我们检查请求的URL路径是否等于trackPath。如果是，我们输出一条记录消息。在main函数中，我们使用Use()方法将Logger()函数注册为中间件，并传递"/login"作为跟踪路径。
错误处理的例子
除了在请求处理之前或之后执行某些操作外，中间件还可以用于处理错误。Gin框架内置了一些错误处理中间件，例如gin.Recovery()和gin.CustomRecovery()。这些中间件可以用于捕获和处理应用程序中的错误。在默认情况下，Gin会使用gin.Recovery()中间件捕获所有未处理的panic，并返回一个HTTP 500错误。
除此之外，我们还可以自定义错误处理中间件。以下是一个示例：
func ErrorHandler() gin.HandlerFunc {
return func(c *gin.Context) {
defer func() {
if r := recover(); r != nil {
c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{
"error": "Internal server error",
})
}
}()
c.Next()
}
}
func main() {
r := gin.Default()
// 注册自定义错误处理中间件
r.Use(ErrorHandler())
r.GET("/", func(c *gin.Context) {
// 模拟一个panic
panic("test error")
})
r.Run(":8080")
}
在这个示例中，我们创建了一个名为ErrorHandler()的中间件。在该中间件中，我们使用defer语句来捕获所有未处理的panic，并返回一个HTTP 500错误。在main函数中，我们使用Use()方法将ErrorHandler()函数注册为中间件。在"/"路由处理器中，我们使用panic()函数来模拟一个错误。
在上面的示例中，我们可以看到如何自定义一个错误处理中间件，并捕获未处理的panic。使用这种方法，我们可以更好地控制应用程序的错误处理方式，并提高应用程序的可靠性。
身份验证的例子
另一个常见的中间件是身份验证中间件。它可以用于保护需要授权访问的API端点。下面是一个示例：
func AuthMiddleware() gin.HandlerFunc {
return func(c *gin.Context) {
token := c.Request.Header.Get("Authorization")
if token == "" {
c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{
"error": "Unauthorized",
})
return
}
// TODO: 验证token
c.Next()
}
}
func main() {
r := gin.Default()
// 注册身份验证中间件
r.Use(AuthMiddleware())
r.GET("/protected", func(c *gin.Context) {
c.JSON(http.StatusOK, gin.H{
"message": "Hello, World!",
})
})
r.Run(":8080")
}
在上面的示例中，我们定义了一个名为AuthMiddleware()的中间件。该中间件检查请求标头中是否存在Authorization标头。如果不存在，则返回HTTP 401未经授权的错误响应。如果存在，则验证token，并调用Next()方法，将控制权移交给下一个中间件或路由处理器。在main函数中，我们使用Use()方法将AuthMiddleware()函数注册为中间件。在"/protected"路由处理器中，我们只允许已经通过身份验证的用户访问。
这是一个基本的身份验证中间件，它只检查请求标头中是否存在Authorization标头。在实际应用中，我们需要根据具体情况进行修改和扩展，例如验证token是否有效、判断用户是否有权限访问API等。
除了以上介绍的中间件之外，Gin框架还提供了许多其他内置中间件，如gin.Logger()、gin.Static()、gin.CORS()等。此外，你还可以编写自己的中间件来实现您需要的功能。
