位置：首页-资讯-后端开发

GoFrame框架数据校验之校验对象校验结构体

2024-04-02 19:55

短信预约 -IT技能 免费直播动态提醒

前言摘要

这篇文章将会为大家介绍GoFrame数据校验中校验对象的知识点，包括：Validator对象常用方法的介绍、单数据校验、校验Map、校验结构体的示例。

基本概念

数据校验组件提供了数据校验对象：用于数据校验统一的配置管理，支持我们便捷的进行链式操作。

方法介绍

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

简要说明

New()方法用于创建一个新的校验对象。
CheckValue/CheckMap/CheckStruct方法用于特定参数类型的数据校验，我们在项目开发中使用比较多的是CheckStruct，也建议大家使用CheckStruct。
Ctx()方法用于传递Context上下文变量。
I18n()方法用于设置当前校验对象的I18N国际化组件，默认情况下，校验组件使用的是框架全局默认的i18n组件对象。
Data()方法用于设置需要校验的数据集合，支持map类型或者struct类型。
Rules()方法用于传递当前链式操作校验的自定义校验规则，支持使用[]string类型或者map类型。
Messages()方法用于传递当前链式操作校验的自定义错误提示信息，往往使用map类型传递，具体看后续代码示例。

注意问题TIPS

在数据校验对象的CheckValue/CheckMap/CheckStruct方法中，不存在Context上下文变量参数，而是通过链式操作的Ctx方法来控制。

GoFrame的g模块中定义了Validator方法来快捷创建校验对象：官方也推荐我们使用g模块的g.Validator()方式来快捷创建一个校验对象。

链式操作

示例1：单数据校验

简单示例

err := g.Validator().Rules("min:60").Messages("考试不及格").CheckValue(16)
    fmt.Println(err.String()) //打印结果：考试不及格

进阶示例

package main
import (
   "fmt"
   "github.com/gogf/gf/frame/g"
)
func main() {
   data := g.Map{
      "password": "123", //这个的作用仅是定义了这个结构设置了默认值，并不代表着传入了值
   }
   //Data()中的参数是需要进行校验的数据集合，常用于map或者结构体类型。
   //CheckValue()是输入的参数
   err := g.Validator().Data(data).Rules("required-with:password").Messages("请输入确认密码").CheckValue("")
   if err != nil {
      fmt.Println("CheckValue传入为空时：" + err.String()) // 请输入确认密码
   } else {
      fmt.Println("CheckValue传入为空时：校验通过")
   }
   err = g.Validator().Data(data).Rules("required-with:password").Messages("请输入确认密码").CheckValue("1")
   if err != nil {
      fmt.Println("CheckValue传入不为空时：" + err.String()) // 请输入确认密码
   } else {
      fmt.Println("CheckValue传入不为空时：校验通过")
   }
}

进阶示例打印结果

示例2：Map数据校验

params := map[string]interface{}{
	"passport":  "",
	"password":  "wangzhongyang",
	"password2": "zhongyang",
}
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": "wangzhongyang",
}
user := User{}
if err := gconv.Scan(data, &amp;user); err != nil {
	panic(err)
}
err := g.Validator().Data(data).CheckStruct(user)
if err != nil {
	fmt.Println(err.Items()) //[map[Type:map[required:请选择用户类型]]]
}