开发过程中，我们往往需要对用户提交的数据进行验证，以保证数据的合法性和完整性。今天我们就来介绍 Go 语言社区推出的一个验证包 —— validator。

validator 包根据 tags 对结构体和单个字段的值进行验证。它具备以下优秀的功能：

1. 提供了一系列验证规则用于验证，并且支持自定义验证规则；
2. 支持跨字段、跨结构体进行验证；
3. 支持多维字段如 array、slice、map 等；
4. 在验证接口类型前会先确定它的底层数据类型；
5. 支持自定义字段类型比如 sql 驱动程序 Valuer；
6. 可以自定义并支持国际化（i18n）的错误信息；
7. 是 gin 框架的默认验证器。

1.安装

使用 go get：

go get github.com/go-playground/validator/v10 

然后在你的源码中引入 validator 包：

讯享网import "github.com/go-playground/validator/v10" 

2.使用

2.1 基本使用

package main import ( "fmt" "github.com/go-playground/validator/v10" ) type User struct { 
    FirstName string `validate:"required"` LastName string `validate:"required"` Age uint8 `validate:"gte=0,lte=130"` } var validate *validator.Validate func main() { 
    validate = validator.New() validateStruct() } func validateStruct() { 
    user := &User{ 
    FirstName: "Badger", LastName: "Smith", Age: 135, } err := validate.Struct(user) if err != nil { 
    for _, err := range err.(validator.ValidationErrors) { 
    fmt.Println(err.Namespace()) // User.Age fmt.Println(err.Field()) // Age fmt.Println(err.StructNamespace()) // User.Age fmt.Println(err.StructField()) // Age fmt.Println(err.Tag()) // lte fmt.Println(err.ActualTag()) // lte fmt.Println(err.Kind()) // uint8 fmt.Println(err.Type()) // uint8 fmt.Println(err.Value()) // 135 fmt.Println(err.Param()) // 130 fmt.Println(err.Error()) // Key: 'User.Age' Error:Field validation for 'Age' failed on the 'lte' tag fmt.Println() } } } 

2.2 跨字段验证

跨字段的验证规则有很多，具体可以查看文末规则表。下面的示例使用了 eqfield 规则，它表示当前字段必须等于指定的字段。

讯享网package main import ( "fmt" "github.com/go-playground/validator/v10" ) type User struct { 
    Password string `validate:"required"` ConfirmPassword string `validate:"required,eqfield=Password"` } var validate *validator.Validate func main() { 
    validate = validator.New() validateStruct() } func validateStruct() { 
    user := User{ 
    Password: "password", ConfirmPassword: "pass", } err := validate.Struct(user) if err != nil { 
    for _, err := range err.(validator.ValidationErrors) { 
    fmt.Println(err.Error()) // Key: 'User.ConfirmPassword' Error:Field validation for 'ConfirmPassword' failed on the 'eqfield' tag } } } 

2.3 跨结构体验证

除了跨字段验证，validator 还支持跨结构体验证，在规则表中你会发现，跨结构体的验证规则通常是在跨字段的验证规则的 field 前加上 cs，可以理解为 cross-struct。所以下面示例的 eacsfield 就是用来验证当前字段是否等于制定结构体的字段：

package main import ( "fmt" "github.com/go-playground/validator/v10" ) type User struct { 
    Uid string `validate:"required,eqcsfield=Account.PayUid"` Account Account } type Account struct { 
    PayUid string `validate:"required"` } var validate *validator.Validate func main() { 
    validate = validator.New() validateStruct() } func validateStruct() { 
    account := Account{ 
    PayUid: "uid-1025", } user := User{ 
    Uid: "uid-1024", Account: account, } err := validate.Struct(user) if err != nil { 
    for _, err := range err.(validator.ValidationErrors) { 
    fmt.Println(err.Error()) // Key: 'User.Uid' Error:Field validation for 'Uid' failed on the 'eqcsfield' tag } } } 

2.4 验证 slice、map

验证 slice 和 map 等复合数据类型时，通常需要加上 dive 表示递归验证，否则将不会深入验证数据类型内部元素。

讯享网package main import ( "fmt" "github.com/go-playground/validator/v10" ) type User struct { 
    // 第一个 required 规则用于确保切片本身不为零值（即不为 nil）。 // dive 规则指定了对切片元素进行递归验证。 // 第二个 required 规则用于验证切片中的每个元素是否不为空。 Accounts []string `validate:"required,dive,required"` // 第一个 required 规则用于确保 map 本身不为零值（即不为 nil）。 // dive 规则指定了对 map 值进行递归验证。 // gt=0 规则用于验证 map 中的每个值是否大于 0。 // 第二个 required 规则用于验证 map 中的每个值是否不为空。 Balance map[string]int `validate:"required,dive,gt=0,required"` } var validate *validator.Validate func main() { 
    validate = validator.New() validateStruct() } func validateStruct() { 
    user := User{ 
    Accounts: []string{ 
   "account-1", "", "account-3"}, Balance: map[string]int{ 
    "key1": 1, "key2": -1, }, } err := validate.Struct(user) if err != nil { 
    for _, err := range err.(validator.ValidationErrors) { 
    // Key: 'User.Accounts[1]' Error:Field validation for 'Accounts[1]' failed on the 'required' tag // Key: 'User.Balance[key2]' Error:Field validation for 'Balance[key2]' failed on the 'gt' tag fmt.Println(err.Error()) } } } 

2.5 自定义类型验证器

package main import ( "database/sql" "database/sql/driver" "fmt" "reflect" "github.com/go-playground/validator/v10" ) type DbBackedUser struct { 
    Name sql.NullString `validate:"required"` Age sql.NullInt64 `validate:"required"` } var validate *validator.Validate func main() { 
    validate = validator.New() // 注册所有的 sql.Null* 类型，使用 ValidateValuer 自定义类型函数进行验证 validate.RegisterCustomTypeFunc(ValidateValuer, sql.NullString{ 
   }, sql.NullInt64{ 
   }, sql.NullBool{ 
   }, sql.NullFloat64{ 
   }) x := DbBackedUser{ 
    Name: sql.NullString{ 
   String: "", Valid: true}, Age: sql.NullInt64{ 
   Int64: 0, Valid: false}, } err := validate.Struct(x) if err != nil { 
    fmt.Printf("Err(s):\n%+v\n", err) } } // ValidateValuer 实现了 validator.CustomTypeFunc 接口 func ValidateValuer(field reflect.Value) interface{ 
   } { 
    // 如果字段的类型实现了 driver.Valuer 接口（即支持向数据库写入值），则进行验证 if valuer, ok := field.Interface().(driver.Valuer); ok { 
    val, err := valuer.Value() // 获取字段的值 if err == nil { 
    return val } // 处理错误 } return nil } 

最终输出：

讯享网

讯享网Err(s): Key: 'DbBackedUser.Name' Error:Field validation for 'Name' failed on the 'required' tag Key: 'DbBackedUser.Age' Error:Field validation for 'Age' failed on the 'required' tag 

2.6 国际化/翻译

在前面的示例中，我们可以看到返回的信息都是英文的，如果需要翻译成中文信息，首先需要安装翻译包：

go get -u github.com/go-playground/locales go get -u github.com/go-playground/universal-translator 

接着我们修改 2.1 的代码，实现翻译：

讯享网package main import ( "fmt" "github.com/go-playground/locales/zh" ut "github.com/go-playground/universal-translator" "github.com/go-playground/validator/v10" zhTrans "github.com/go-playground/validator/v10/translations/zh" ) type User struct { 
    FirstName string `validate:"required"` LastName string `validate:"required"` Age uint8 `validate:"gte=0,lte=130"` } var validate *validator.Validate var trans ut.Translator func main() { 
    validate = validator.New() // 中文翻译器 uniTrans := ut.New(zh.New()) trans, _ = uniTrans.GetTranslator("zh") // 注册翻译器到验证器 err := zhTrans.RegisterDefaultTranslations(validate, trans) if err != nil { 
    panic(fmt.Sprintf("registerDefaultTranslations fail: %s\n", err.Error())) } validateStruct() } func validateStruct() { 
    user := &User{ 
    FirstName: "Badger", LastName: "Smith", Age: 135, } err := validate.Struct(user) if err != nil { 
    for _, err := range err.(validator.ValidationErrors) { 
    // 翻译 fmt.Println(err.Translate(trans)) // Age必须小于或等于130 } } } 

3.错误处理

通过源码，我们可以发现 validator 返回的错误类型有两种，分别是参数错误 InvalidValidationError 和验证错误 ValidationErrors：

// $GOPATH/pkg/mod/github.com/go-playground/validator/v10/errors.go // InvalidValidationError describes an invalid argument passed to // `Struct`, `StructExcept`, StructPartial` or `Field` type InvalidValidationError struct { 
    Type reflect.Type } // Error returns InvalidValidationError message func (e *InvalidValidationError) Error() string { 
    if e.Type == nil { 
    return "validator: (nil)" } return "validator: (nil " + e.Type.String() + ")" } // ValidationErrors is an array of FieldError's // for use in custom error messages post validation. type ValidationErrors []FieldError // Error is intended for use in development + debugging and not intended to be a production error message. // It allows ValidationErrors to subscribe to the Error interface. // All information to create an error message specific to your application is contained within // the FieldError found within the ValidationErrors array func (ve ValidationErrors) Error() string { 
    buff := bytes.NewBufferString("") for i := 0; i < len(ve); i++ { 
    buff.WriteString(ve[i].Error()) buff.WriteString("\n") } return strings.TrimSpace(buff.String()) } 

通常情况下一般会忽略对 InvalidValidationError 的判断/处理。

4.常用验证规则

完整的验证规则表可以参阅这里。

详细的验证规则介绍可以参阅这里

4.1 比较

4.2 跨字段校验

4.3 跨结构体跨字段校验

「跨结构体跨字段校验」规则与「跨字段校验」规则类似，一般是在「跨字段校验」规则的 field 前加上 cs 字符。

4.4 字符串相关验证

4.5 格式化验证

4.6 其他验证