4.2. 表单验证器

1.0

1.0

简介

基于 gin 框架验证参数, 绑定参数优化的验证器

路由验证

在 gin-pro 中使用验证器非常简单, 只分两步完成即可, 且不分开发顺序

1. 路由添加验证器

func LoadDemoRouter(e *gin.Engine) {

    d := e.Group("/open/demo").Use(cors.Next())
    {
        // demo.NewIndexValidator().CheckParams 为验证器
        // open.NewDemoController().Index 为控制器
        d.GET("/index", demo.NewIndexValidator().CheckParams, open.NewDemoController().Index)
    }
}

2. 自定义验证规则

用户根据需求场景在app/http/validator自定义验证器类, 并实现CheckParams方法, 在标签binding中使用验证规则, 多个验证规则之间使用,分割, 即可完成验证

type IndexValidator struct {
    Id float64 `form:"id" json:"id" binding:"required,min=1"` // 必填，最小值为1
}

func (c IndexValidator) CheckParams(context *gin.Context) {

    if err := context.ShouldBind(&c); err != nil {
        response.ValidatorError(context, err)
        return
    }

    if http.BindContext(c, consts.Param, context) == nil {
        response.ErrorSystem(context, " index 表单验证器json化失败", "")
    } else {
        context.Next()
    }
}

验证通过后把参数绑定到 context 中, 在 controller 中直接使用 context 获取参数

func (d DemoController) Index(c *gin.Context) {

    id := c.GetInt(consts.Param + "id")

    fmt.Printf("参数值为 : %d", id)

}

控制器验证

如果你不喜欢这种方法, 也可以在控制器定义一个结构体, 在获取参数前验证:
注意在验证失败后 response后要有return否则代码会继续执行

if err := context.ShouldBind(&c); err != nil {
        response.ValidatorError(context, err)
        return
    }

公共参数

在app/http/validator/common_data中预制了一些常用验证规则, 分页参数, ID 参数 使用方法:

type IndexValidator struct {
    common_data.IntId
}

验证规则