GoFrame数据校验之校验对象

持续创作，加速成长！这是我参与「掘金日新计划 · 6 月更文挑战」的第22天，点击查看活动详情

校验对象

数据校验组件同时提供了数据校验对象，常用于数据校验的统一的配置管理、便捷的链式操作。

type Validator
    func New() *Validator
    func (v *Validator) CheckMap(params interface{}) Error
    func (v *Validator) CheckStruct(object interface{}) Error
    func (v *Validator) CheckValue(value interface{}) Error
    func (v *Validator) Clone() *Validator
    func (v *Validator) Ctx(ctx context.Context) *Validator
    func (v *Validator) Data(data interface{}) *Validator
    func (v *Validator) I18n(i18nManager *gi18n.Manager) *Validator
    func (v *Validator) Messages(messages interface{}) *Validator
    func (v *Validator) Rules(rules interface{}) *Validator
复制代码

简要说明

1. New方法用于创建一个新的校验对象。
2. CheckValue/CheckMap/CheckStruct方法同之前介绍的包方法，用于特定参数类型的数据校验。
3. Ctx方法用于传递Context上下文变量，作用也同之前介绍的每个包方法的第一个Context参数。
4. I18n方法用于设置当前校验对象的I18N国际化组件，默认情况下，校验组件使用的是框架全局默认的i18n组件对象。
5. Data方法用于传递需要联合校验的数据集合，往往传递的是map类型或者struct类型。
6. Rules方法用于传递当前链式操作校验的自定义校验规则，往往使用[]string类型或者map类型。
7. Messages方法用于传递当前链式操作校验的自定义错误提示信息，往往使用map类型传递，具体看后续代码示例。
8. 可以看到，在数据校验对象的CheckValue/CheckMap/CheckStruct方法中，不存在Context上下文变量参数，而是转由链式操作的Ctx方法来控制。

由于数据校验对象也是一个非常常用的对象，因此g模块中定义了Validator方法来快捷创建校验对象。大部分场景下我们推荐使用g模块的g.Validator()方式来快捷创建一个校验对象。

链式操作

示例1、单数据校验

err := g.Validator().Rules("min:18").Messages("未成年人不允许注册").CheckValue(16)
    fmt.Println(err.String()) //打印结果：未成年人不允许注册
复制代码

data := g.Map{
	"password": "123",
}
err := g.Validator().Data(data).Rules("required-with:password").Messages("请输入确认密码").CheckValue("")
fmt.Println(err.String()) // 请输入确认密码
复制代码

示例2、Map数据校验

params := map[string]interface{}{
	"passport":  "",
	"password":  "123456",
	"password2": "1234567",
}
rules := map[string]string{
	"passport":  "required|length:6,16",
	"password":  "required|length:6,16|same:password2",
	"password2": "required|length:6,16",
}
messages := map[string]interface{}{
	"passport": "账号不能为空|账号长度应当在:min到:max之间",
	"password": map[string]string{
		"required": "密码不能为空",
		"same":     "两次密码输入不相等",
	},
}
err := g.Validator().Messages(messages).Rules(rules).CheckMap(params)
if err != nil {
	g.Dump(err.Maps())
}
复制代码

执行后，终端输出：

{
    "passport": {
        "length": "账号长度应当在6到16之间",
        "required": "账号不能为空"
    },
    "password": {
        "same": "两次密码输入不相等"
    }
}
复制代码

示例3、Struct数据校验

type User struct {
	Name string `v:"required#请输入用户姓名"`
	Type int    `v:"required#请选择用户类型"`
}
data := g.Map{
	"name": "john",
}
user := User{}
if err := gconv.Scan(data, &user); err != nil {
	panic(err)
}
err := g.Validator().Data(data).CheckStruct(user)
if err != nil {
	fmt.Println(err.Items())
}

// Output:
// [map[Type:map[required:请选择用户类型]]]
复制代码

最后

感谢阅读，欢迎大家三连：点赞、收藏、投币（关注）！！！