github.com/go-playground/validator

范围约束

• 对于字符串、切片、数组和map，约束其长度。

  len=10, min=6, max=10, gt=10。

• 对于数值，约束其取值。

  min, max, eq, ne, gt, gte, lt, lte, oneof=6 8。

Fields

网络

字符串

格式

比较

其他

简单使用

package main

import (
	"fmt"
	"github.com/go-playground/validator"
)

func fn5() {
	//创建结构体  设置校验
	type RegistRequest struct {
		UserName   string `validate:"gt=0"`             // >0 长度大于0
		PassWord   string `validate:"min=6,max=12"`     //密码长度[6, 12]
		PassRepeat string `validate:"eqfield=PassWord"` //跨字段相等校验
		Email      string `validate:"email"`            //需要满足email的格式
	}

	reg := RegistRequest{
		UserName:   "1",
		PassWord:   "abc",
		PassRepeat: "abcdef",
		Email:      "123.com",
	}
	//创建校验
	v := validator.New()
	//校验
	err := v.Struct(reg) //Struct()返回的error分为两种类型：InvalidValidationError和ValidationErrors
	//根据返回的错误，做出相应的处理
	if err != nil {
		//InvalidValidationError是传入了非法的参数
		invalid, ok := err.(*validator.InvalidValidationError)
		if ok {
			fmt.Println("传输的参数有误", "\n错误消息为:", invalid)
		}
		//ValidationErrors是对校验的不通过的返回
		validationErrs := err.(validator.ValidationErrors)
		for _, v := range validationErrs {
			fmt.Println(v.Field(), "不满足要求", v.Tag())
		}
	}
}

func main() {
	fn5()
}
/*
PassWord 不满足要求 min
PassRepeat 不满足要求 eqfield
Email 不满足要求 email
*/

要点：

• 需要先初始化校验 v := validator.New() 用返回的v来校验结构体
• 校验 将结构体传入 err := v.Struct(reg) 返回的是校验结果
• func (v *Validate) Struct(s interface{}) error返回的error分为两种类型：InvalidValidationError和ValidationErrors
  • InvalidValidationError类型的err是传参异常
  • ValidationErrors 类型则是对校验结果的返回，是一个切片
  • 需要手动的去断言

跨字段约束

• 跨字段就在范围约束的基础上加field后缀。范围约束+field。例如eqfield
• 如果还跨结构体(cross struct)就在跨字段的基础上在field前面加cs：范围约束+cs+field。例如eqcsfield

跨字段指的是不同结构体

//结构体嵌套 然后之间的字段相互校验
type User struct {
	Passwd string `validate:"min=6,max=12"`
}

type RegistRequest struct {
	UserName  string `validate:"gt=0"`                  // >0 长度大于0
	PassWord  string `validate:"eqcsfield=User.Passwd"` //跨结构体相等校验
	Rpassword string `validate:"eqfield=PassWord"`      //跨字段相等校验
	User      User
}

reg := RegistRequest{
	UserName:  "1",
	PassWord:  "abcd",
	Rpassword: "abcd",
	User:      User{Passwd: "abcdef"},
}

字符串约束

• contains包含子串。
• containsany包含任意unicode字符， containsany=abcd。
• containsrune包含rune字符， containsrune= ☻。
• excludes不包含子串。
• excludesall不包含任意的unicode字符，excludesall=abcd。
• excludesrune不包含rune字符，excludesrune=☻。
• startswith以子串为前缀。
• endswith以子串为后缀。

type RegistRequest struct {
	UserName  string `validate:"contains=abcd"`    //包含校验
	PassWord  string `validate:"excludes=abcd"`    //不包含校验
	RPassWord string `validate:"containsany=abcd"` //至少包含其中的一个
}
reg := RegistRequest{
	UserName:  "1abcd",  //通过
	PassWord:  "abcdef", //不通过
	RPassWord: "a123",   //通过
}

唯一性uniq

• 对于数组和切片，约束没有重复的元素。
• 对于map，约束没的重复的value。
• 对于元素类型为结构体的切片，unique约束结构体对象的某个字段不重复，通过unique=field指定这个字段名。
  Friends []User validate:"unique=Name"

type RegistRequest struct {
	Id       []int  `validate:"unique"` //唯一性校验
	UserName string `validate:"gt=0"`
	PassWord string `validate:"min=6,max=12"`
}
reg := RegistRequest{
	Id:       []int{1, 2, 1},
	UserName: "1",
	PassWord: "abcdef",
}

自定义约束

func validateEmail(fl validator.FieldLevel) bool {
    input := fl.Field().String()
    if pass, _ := regexp.MatchString(`^([\w\.\_]{2,10})@(\w{1,})\.([a-z]{2,4})$`, input); pass {
	  return true
 }
 return false
}

//注册一个自定义的validator
val.RegisterValidation("my_email", validateEmail)

Email string `validate:"my_email"`

例子

package main

import (
	"fmt"

	"github.com/go-playground/validator"
)

//新建校验函数
func Jiaoyan(fl validator.FieldLevel) bool {
	field := fl.Field().String()
	if field != "abc" {
		return false
	}
	return true
}

func fn5() {
	//创建结构体  设置校验
	type RegistRequest struct {
        //调用校验方法
		UserName string `validate:"jiaoyan"` //自定义校验
		Passwd   string `validate:"jiaoyan"`
	}

	reg := RegistRequest{
		UserName: "abc",  //通过
		Passwd:   "ab1c", //不通过
	}
	//创建校验
	v := validator.New()
    
    //注册校验方法
	v.RegisterValidation("jiaoyan", Jiaoyan)
	//校验
	err := v.Struct(reg) //Struct()返回的error分为两种类型：InvalidValidationError和ValidationErrors
	//根据返回的错误，做出相应的处理
	if err != nil {
		//InvalidValidationError是传入了非法的参数
		invalid, ok := err.(*validator.InvalidValidationError)
		if ok {
			fmt.Println("传输的参数有误", "\n错误消息为:", invalid)
		}
		//ValidationErrors是对校验的不通过的返回
		validationErrs := err.(validator.ValidationErrors)
		for _, v := range validationErrs {
			fmt.Println(v.Field(), "不满足要求", v.Tag())
		}
	}
}

func main() {
	fn5()
}