Go语言通用HTTP请求验证中间件实现方案问询

需求分析 #

需要实现一个通用的Gin中间件，能够接收指定的结构体类型，自动将HTTP请求的JSON体反序列化为该结构体，并使用github.com/go-playground/validator/v10进行验证，达到类似Node.js Joi包的灵活验证效果。

实现思路 #

直接传递结构体名称字符串（如示例中的"LoginRequestBody"）并不安全且难以维护，更合理的方式是传递结构体的反射类型（reflect.Type） 或者一个能创建结构体实例的函数，这样中间件可以动态创建对应类型的实例来绑定请求数据。

完整代码实现 #

1. 定义请求结构体 #

package main

import (
    "github.com/gin-gonic/gin"
    "github.com/go-playground/validator/v10"
    "reflect"
    "net/http"
)

type LoginRequestBody struct {
    Username string `json:"username" validate:"required"`
    Password string `json:"password" validate:"required"`
}

type SignupReqBody struct {
    Username string `json:"username" validate:"required"`
    Password string `json:"password" validate:"required,min=6"`
    Age      int    `json:"age" validate:"required,gte=18"`
}

2. 初始化全局验证器 #

var validate *validator.Validate

func init() {
    validate = validator.New()
    // 可在这里注册自定义验证规则，比如手机号、邮箱格式等
}

3. 实现通用验证中间件 #

这里使用reflect.Type作为参数，中间件内部动态创建结构体实例：

func ReqValidate(t reflect.Type) gin.HandlerFunc {
    return func(c *gin.Context) {
        // 创建对应类型的零值实例（指针类型）
        instance := reflect.New(t).Interface()

        // 绑定请求JSON到结构体
        if err := c.ShouldBindJSON(instance); err != nil {
            c.JSON(http.StatusBadRequest, gin.H{
                "error": "请求格式错误: " + err.Error(),
            })
            c.Abort()
            return
        }

        // 验证结构体字段
        if err := validate.Struct(instance); err != nil {
            // 整理验证错误信息
            var errMsg []string
            for _, err := range err.(validator.ValidationErrors) {
                errMsg = append(errMsg, err.Field() + "字段验证失败: " + err.Tag())
            }
            c.JSON(http.StatusBadRequest, gin.H{
                "errors": errMsg,
            })
            c.Abort()
            return
        }

        // 将验证后的实例存入上下文，供后续控制器使用
        c.Set("validatedReq", instance)
        c.Next()
    }
}

4. 路由与控制器使用 #

func LoginController(c *gin.Context) {
    // 从上下文获取验证后的请求结构体
    req := c.MustGet("validatedReq").(*LoginRequestBody)
    // 处理登录逻辑...
    c.JSON(http.StatusOK, gin.H{
        "message": "登录成功",
        "username": req.Username,
    })
}

func SignupController(c *gin.Context) {
    req := c.MustGet("validatedReq").(*SignupReqBody)
    // 处理注册逻辑...
    c.JSON(http.StatusOK, gin.H{
        "message": "注册成功",
        "username": req.Username,
        "age": req.Age,
    })
}

func main() {
    router := gin.Default()

    // 路由注册，传递结构体的反射类型
    router.POST("/login", ReqValidate(reflect.TypeOf(LoginRequestBody{})), LoginController)
    router.POST("/signup", ReqValidate(reflect.TypeOf(SignupReqBody{})), SignupController)

    router.Run(":8080")
}

优化与扩展 #

• 更简洁的调用方式：可以封装一个辅助函数，直接接收结构体实例，自动获取其反射类型：

  func ValidateReq(req interface{}) gin.HandlerFunc {
      return ReqValidate(reflect.TypeOf(req).Elem())
  }
  // 调用时：router.POST("/login", ValidateReq(&LoginRequestBody{}), LoginController)
  

• 自定义错误信息：可以通过validator.RegisterTranslation为验证标签设置自定义错误提示，提升用户体验。
• 支持其他请求类型：如果需要支持表单数据，可以将ShouldBindJSON替换为ShouldBind，自动根据请求头判断绑定方式。

内容的提问来源于stack exchange，提问作者sajal arora