Golang验证器之validator是使用详解
目录
前言
对于HTTP请求，我们要在脑子里有一个根深蒂固的概念，那就是任何客户端传过来的数据都是不可信任的。那么开发接口的时候需要对客户端传提交的参数进行参数校验，如果提交的参数只有一个两个，这样我们可以简单写个if判断，那么要是有很多的参数校验，那么满屏都是参数校验的if判断，效率不仅低还不美观，接下来我们介绍一个参数校验器。
什么是validator
是一个 Golang 的第三方库，用于对数据进行校验，常用于 API 的开发中，对客户端发出的请求数据进行严格校验，防止恶意请求。
安装
validator包安装：
go get -u github.com/go-playground/validator/v10
使用方法
导入validator：
import "github.com/go-playground/validator/v10"
validator 应用了 的 和 机制，基本思想是：在 中为不同的字段定义各自类型的约束，然后通过 获取这些约束的类型信息并在校验器中进行数据校验。
示例：
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))
}
}
}
执行输出：
校验规则
下面列举一部分我们开发中经常用到的验证规则，详细验证规则可以参考文档：
https://pkg.go.dev/gopkg.in/go-playground/validator.v10
Tag说明示例required必填Field或Struct validate:"required"omitempty空时忽略Field或Struct validate:"omitempty"len长度Field validate:"len=0"eq等于Field validate:"eq=0"gt大于Field validate:"gt=0"gte大于等于Field validate:"gte=0"lt小于Field validate:"lt=0"lte小于等于Field validate:"lte=0"min最小值Field validate:"min=1"max最大值Field validate:"max=2"required_with其他字段其中一个不为空且当前字段不为空Field validate:"required_with=Field1 Field2"required_without其他字段其中一个为空且当前字段不为空Field `validate:“required_without=Field1 Field2”lowercase符串值是否只包含小写字符Field validate:"lowercase"uppercase符串值是否只包含大写字符Field validate:"uppercase"email字符串值包含一个有效的电子邮件Field validate:"email"json字符串值是否为有效的JSONField validate:"json"url符串值是否包含有效的urlField validate:"url"uri符串值是否包含有效的 uriField validate:"uri"contains字符串值包含子字符串值Field validate:"contains=@"excludes字符串值不包含子字符串值字符串值不包含子字符串值 Field validate:"excludes=@"ip字符串值是否包含有效的 IP 地址Field validate:"ip"datetime字符串值是否包含有效的日期Field validate:"datetime"startswith字符串以提供的字符串值开始Field validate:"startswith=abc"endswith字符串以提供的字符串值结束Field validate:"endswith=abc"
跨字段验证
validator 允许定义跨字段验证，即：验证某个字段与其他字段之间的关系。这种验证实际上分为两种：
验证语法很简单，如果是验证同一个结构中的字段，则在基础的 Tags 后面添加一个 field 后缀，例如：eqfield 定义字段间的相等（eq）约束。如果是更深层次的字段，在 field 之前还需要加上 cs（Cross-Struct），eq 就变为了 eqcsfield。
另外还有几个常用的 Tag：
错误处理
通过看源码，我们可以看到validator 返回的错误有两种，一种是参数错误，一种是校验错误，它们都实现了 error 接口。
所以 validator 校验返回的结果有 3 种情况：
validator 返回的错误有两种，一种是参数错误，一种是校验错误，它们都实现了 error 接口。
参数错误时，返回 InvalidValidationError 类型；
校验错误时，返回 ValidationErrors 类型。ValidationErrors 是一个错误切片，保存了每个字段违反的每个约束信息。
所以 validator 校验返回的结果只有 3 种情况：
nil：没有错误；
InvalidValidationError：输入参数错误；
ValidationErrors：字段违反约束。
我们可以在程序中判断 时，可以依次将 err转换为 和 以获取更详细的信息：
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)
}
}
小结
通过以上的内容我们了解了一些基本的功能和用法，在我们开发中大大提高了开发效率。
功能非常丰富，使用较为简单方便。它的应用非常广泛，建议了解一下。
到此这篇关于Golang验证器之validator是使用详解的文章就介绍到这了,更多相关Golang validator内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
您可能感兴趣的文章: