Golang validator

前言

对于HTTP请求，我们要在脑子里有一个根深蒂固的概念，那就是任何客户端传过来的数据都是不可信任的。那么开发接口的时候需要对客户端传提交的参数进行参数校验，如果提交的参数只有一个两个，这样我们可以简单写个if判断，那么要是有很多的参数校验，那么满屏都是参数校验的if判断，效率不仅低还不美观，接下来我们介绍一个参数校验器validator。

什么是validator

Validator 是一个 Golang 的第三方库，用于对数据进行校验，常用于 API 的开发中，对客户端发出的请求数据进行严格校验，防止恶意请求。

安装

validator包安装：

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

使用方法

导入validator：

import "github.com/go-playground/validator/v10"

validator 应用了 Golang 的 Struct Tag 和 Reflect机制，基本思想是：在 Struct Tag 中为不同的字段定义各自类型的约束，然后通过 Reflect 获取这些约束的类型信息并在校验器中进行数据校验。

示例：

package main

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

type User struct {
	UserName string `json:"user_name" validate:"required"`
	Password string `json:"password" validate:"required,min=6,max=20"`
}
func main() {
	example := User{
		Password: "123",
	}
 
	//实例化验证器
	validate  := validator.New() 

	errs := validate.Struct(example)
	if errs != nil {
		for _, err := range errs.(validator.ValidationErrors) {
			fmt.Println(err)
		}
	}

}

validator包的验证提示默认是英文的，输出如下：

这样看可能不太清楚，如果需要翻译成中文则还需安装验证提示翻译包：

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

修改后如下:

package main

import (
	"fmt"
	"github.com/go-playground/locales/zh"
	ut "github.com/go-playground/universal-translator"
	"github.com/go-playground/validator/v10"
	zh_translations "github.com/go-playground/validator/v10/translations/zh"
)

type User struct {
	UserName string `json:"user_name" validate:"required"`
	Password string `json:"password" validate:"required,min=6,max=20"`
}
func main() {
	example := User{
		Password: "123",
	}
	// 中文翻译器
	uni := ut.New(zh.New())
	trans, _ := uni.GetTranslator("zh")

	//实例化验证器
	validate  := validator.New()
	// 注册翻译器到校验器
	err := zh_translations.RegisterDefaultTranslations(validate, trans)
	if err!=nil {
		fmt.Println(err)
		return
	}

	errs := validate.Struct(example)
	if errs != nil {
		for _, err := range errs.(validator.ValidationErrors) {
			fmt.Println(err.Translate(trans))
		}
	}

}

执行输出：

校验规则

下面列举一部分我们开发中经常用到的验证规则，详细验证规则可以参考文档：

http://pkg.go.dev/gopkg.in/go-playground/validator.v10

跨字段验证

validator 允许定义跨字段验证，即：验证某个字段与其他字段之间的关系。这种验证实际上分为两种：

• 一种是参数字段就是同一个结构体中的平级字段。
• 另一种是参数字段为结构中其他字段的字段。

验证语法很简单，如果是验证同一个结构中的字段，则在基础的 Tags 后面添加一个 field 后缀，例如：eqfield 定义字段间的相等（eq）约束。如果是更深层次的字段，在 field 之前还需要加上 cs（Cross-Struct），eq 就变为了 eqcsfield。

• eqfield=Field：必须等于 Field 的值。
• nefield=Field：必须不等于 Field 的值。
• gtfield=Field：必须大于 Field 的值。
• gtefield=Field： 必须大于等于 Field 的值。
• ltfield=Field：必须小于 Field 的值。
• ltefield=Field：必须小于等于 Field 的值。
• eqcsfield=Other.Field：必须等于 struct Other 中 Field 的值。
• necsfield=Other.Field：必须不等于 struct Other 中 Field 的值。
• gtcsfield=Other.Field：必须大于 struct Other 中 Field 的值；
• gtecsfield=Other.Field：必须大于等于 struct Other 中 Field 的值。
• ltcsfield=Other.Field：必须小于 struct Other 中 Field 的值。
• ltecsfield=Other.Field：必须小于等于 struct Other 中 Field 的值。

另外还有几个常用的 Tag：

• required_with=Field1 Field2：在 Field1 或者 Field2 存在时，必须；
• required_with_all=Field1 Field2：在 Field1 与 Field2 都存在时，必须；
• required_without=Field1 Field2：在 Field1 或者 Field2 不存在时，必须；
• required_without_all=Field1 Field2：在 Field1 与 Field2 都存在时，必须；

错误处理

通过看源码，我们可以看到validator 返回的错误有两种，一种是参数错误，一种是校验错误，它们都实现了 error 接口。

• 参数错误时，返回 InvalidValidationError 类型；
• 校验错误时，返回 ValidationErrors 类型。ValidationErrors 是一个错误切片，保存了每个字段违反的每个约束信息。

所以 validator 校验返回的结果有 3 种情况：

• nil：没有错误；
• InvalidValidationError：输入参数错误；
• ValidationErrors：字段违反约束。

validator 返回的错误有两种，一种是参数错误，一种是校验错误，它们都实现了 error 接口。

参数错误时，返回 InvalidValidationError 类型；

校验错误时，返回 ValidationErrors 类型。ValidationErrors 是一个错误切片，保存了每个字段违反的每个约束信息。

所以 validator 校验返回的结果只有 3 种情况：

nil：没有错误；

InvalidValidationError：输入参数错误；

ValidationErrors：字段违反约束。

我们可以在程序中判断 err != nil 时，可以依次将 err转换为 InvalidValidationError 和 ValidationErrors 以获取更详细的信息：

err := validate.Struct(user)
if err != nil {
    invalid, ok := err.(*validator.InvalidValidationError)
      if ok {
        fmt.Println("param error:", invalid)
        return
    }
    
    validationErrs := err.(validator.ValidationErrors)
    for _, validationErr := range validationErrs {
        fmt.Println(validationErr)
    }
}

小结

通过以上的内容我们了解了validator一些基本的功能和用法，在我们开发中大大提高了开发效率。

validator功能非常丰富，使用较为简单方便。它的应用非常广泛，建议了解一下。