golang之数据验证validator
前言
在web应用中经常会遇到数据验证问题,普通的验证方法比较繁琐,这里介绍一个使用比较多的包validator。
原理
将验证规则写在struct对字段tag里,再通过反射(reflect)获取struct的tag,实现数据验证。
安装
go get github.com/go-playground/validator/v10
示例
package mainimport ("fmt""github.com/go-playground/validator/v10"
)type Users struct {Phone string `form:"phone" json:"phone" validate:"required"`Passwd string `form:"passwd" json:"passwd" validate:"required,max=20,min=6"`Code string `form:"code" json:"code" validate:"required,len=6"`
}func main() {users := &Users{Phone: "1326654487",Passwd: "123",Code: "123456",}validate := validator.New()err := validate.Struct(users)if err != nil {for _, err := range err.(validator.ValidationErrors) {fmt.Println(err)//Key: 'Users.Passwd' Error:Field validation for 'Passwd' failed on the 'min' tagreturn}}return
}
验证规则
- required :必填
- email:验证字符串是email格式;例:“email”
- url:这将验证字符串值包含有效的网址;例:“url”
- max:字符串最大长度;例:“max=20”
- min:字符串最小长度;例:“min=6”
- excludesall:不能包含特殊字符;例:“excludesall=0x2C”//注意这里用十六进制表示。
- len:字符长度必须等于n,或者数组、切片、map的len值为n,即包含的项目数;例:“len=6”
- eq:数字等于n,或者或者数组、切片、map的len值为n,即包含的项目数;例:“eq=6”
- ne:数字不等于n,或者或者数组、切片、map的len值不等于为n,即包含的项目数不为n,其和eq相反;例:“ne=6”
- gt:数字大于n,或者或者数组、切片、map的len值大于n,即包含的项目数大于n;例:“gt=6”
- gte:数字大于或等于n,或者或者数组、切片、map的len值大于或等于n,即包含的项目数大于或等于n;例:“gte=6”
- lt:数字小于n,或者或者数组、切片、map的len值小于n,即包含的项目数小于n;例:“lt=6”
- lte:数字小于或等于n,或者或者数组、切片、map的len值小于或等于n,即包含的项目数小于或等于n;例:“lte=6”
跨字段验证
如想实现比较输入密码和确认密码是否一致等类似场景
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 的值;
示例
type UserReg struct {Passwd string `form:"passwd" json:"passwd" validate:"required,max=20,min=6"`Repasswd string `form:"repasswd" json:"repasswd" validate:"required,max=20,min=6,eqfield=Passwd"`
}
示例验证了Passwd,和Repasswd值是否相等。如想了解更多类型,请参考文档 https://godoc.org/gopkg.in/go-playground/validator.v10
自定义验证类型
示例:
package mainimport ("fmt""github.com/go-playground/validator/v10"
)type Users struct {Name string `form:"name" json:"name" validate:"required,CustomValidationErrors"`//包含自定义函数Age uint8 `form:"age" json:"age" validate:"required,gt=18"`Passwd string `form:"passwd" json:"passwd" validate:"required,max=20,min=6"`Code string `form:"code" json:"code" validate:"required,len=6"`
}func main() {users := &Users{Name: "admin",Age: 12,Passwd: "123",Code: "123456",}validate := validator.New()//注册自定义函数_=validate.RegisterValidation("CustomValidationErrors", CustomValidationErrors)err := validate.Struct(users)if err != nil {for _, err := range err.(validator.ValidationErrors) {fmt.Println(err)//Key: 'Users.Name' Error:Field validation for 'Name' failed on the 'CustomValidationErrors' tagreturn}}return
}func CustomValidationErrors(fl validator.FieldLevel) bool {
return fl.Field().String() != "admin"
}
翻译错误信息为中文
通过以上示例我们看到,validator默认的错误提示信息类似如下
Key: 'Users.Name' Error:Field validation for 'Name' failed on the 'CustomValidationErrors' tag
显然这并不是我们想要,如想翻译成中文,或其他语言怎么办?go-playground上提供了很好的解决方法。
先自行安装需要的两个包
https://github.com/go-playground/locales
https://github.com/go-playground/universal-translator
执行:
go get github.com/go-playground/universal-translator
go get github.com/go-playground/locales
示例:
package mainimport ("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 Users struct {Name string `form:"name" json:"name" validate:"required"`Age uint8 `form:"age" json:"age" validate:"required,gt=18"`Passwd string `form:"passwd" json:"passwd" validate:"required,max=20,min=6"`Code string `form:"code" json:"code" validate:"required,len=6"`
}func main() {users := &Users{Name: "admin",Age: 12,Passwd: "123",Code: "123456",}uni := ut.New(zh.New())trans, _ := uni.GetTranslator("zh")validate := validator.New()//验证器注册翻译器err := zh_translations.RegisterDefaultTranslations(validate, trans)if err!=nil {fmt.Println(err)}err = validate.Struct(users)if err != nil {for _, err := range err.(validator.ValidationErrors) {fmt.Println(err.Translate(trans))//Age必须大于18return}}return
}
输出:
Age必须大于18
至此我们发现大部分错误信息已经翻译成中文,但字段名(Age)还是没有翻译,为了将字段名翻译成中文,查了一些资料,https://www.jianshu.com/p/51b9cd2006a8>,
照着做没有成功(可能有遗漏吧),最后还是翻看了一下源代码,在<https://github.com/go-playground/validator/blob/master/validator_instance.go,第137行
// RegisterTagNameFunc registers a function to get alternate names for StructFields.
//
// eg. to use the names which have been specified for JSON representations of structs, rather than normal Go field names:
//
// validate.RegisterTagNameFunc(func(fld reflect.StructField) string {
// name := strings.SplitN(fld.Tag.Get("json"), ",", 2)[0]
// if name == "-" {
// return ""
// }
// return name
// })
其实原理就是注册一个函数,将struct tag里添加的中文名 作为备用名。
package mainimport ("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""reflect"
)type Users struct {Name string `form:"name" json:"name" validate:"required" label:"用户名"`Age uint8 `form:"age" json:"age" validate:"required,gt=18" label:"年龄"`Passwd string `form:"passwd" json:"passwd" validate:"required,max=20,min=6"`Code string `form:"code" json:"code" validate:"required,len=6"`
}func main() {users := &Users{Name: "admin",Age: 12,Passwd: "123",Code: "123456",}uni := ut.New(zh.New())trans, _ := uni.GetTranslator("zh")validate := validator.New()//注册一个函数,获取struct tag里自定义的label作为字段名validate.RegisterTagNameFunc(func(fld reflect.StructField) string {name:=fld.Tag.Get("label")return name})//注册翻译器err := zh_translations.RegisterDefaultTranslations(validate, trans)if err!=nil {fmt.Println(err)}err = validate.Struct(users)if err != nil {for _, err := range err.(validator.ValidationErrors) {fmt.Println(err.Translate(trans))//年龄必须大于18return}}return
}
输出结果:
年龄必须大于18
gin 内置的validator
gin已经支持go-playground / validator / v10进行验证。在此处查看有关标签用法的完整文档。
以下只提供了一个绑定ShouldBindWith示例,如需了解更多方法,进入这里。
示例
package mainimport ("fmt""github.com/go-playground/locales/zh"ut "github.com/go-playground/universal-translator""github.com/go-playground/validator/v10""net/http""reflect""strings""time""github.com/gin-gonic/gin""github.com/gin-gonic/gin/binding"zh_translations "github.com/go-playground/validator/v10/translations/zh"
)
var trans ut.Translator
// Booking contains binded and validated data.
type Booking struct {CheckIn time.Time `form:"check_in" json:"check_in" binding:"required,bookabledate" time_format:"2006-01-02" label:"输入时间"`CheckOut time.Time `form:"check_out" json:"check_out" binding:"required,gtfield=CheckIn" time_format:"2006-01-02" label:"输出时间"`
}var bookableDate validator.Func = func(fl validator.FieldLevel) bool {date, ok := fl.Field().Interface().(time.Time)if ok {today := time.Now()if today.After(date) {return false}}return true
}func main() {route := gin.Default()uni := ut.New(zh.New())trans, _ = uni.GetTranslator("zh")if v, ok := binding.Validator.Engine().(*validator.Validate); ok {//注册翻译器_= zh_translations.RegisterDefaultTranslations(v, trans)//注册自定义函数_=v.RegisterValidation("bookabledate", bookableDate)//注册一个函数,获取struct tag里自定义的label作为字段名v.RegisterTagNameFunc(func(fld reflect.StructField) string {name:=fld.Tag.Get("label")return name})//根据提供的标记注册翻译v.RegisterTranslation("bookabledate", trans, func(ut ut.Translator) error {return ut.Add("bookabledate", "{0}不能早于当前时间或{1}格式错误!", true)}, func(ut ut.Translator, fe validator.FieldError) string {t, _ := ut.T("bookabledate", fe.Field(), fe.Field())return t})}route.GET("/bookable", getBookable)route.Run(":8085")
}func getBookable(c *gin.Context) {var b Bookingif err := c.ShouldBindWith(&b, binding.Query); err == nil {c.JSON(http.StatusOK, gin.H{"message": "Booking dates are valid!"})} else {errs := err.(validator.ValidationErrors)fmt.Println(errs.Translate(trans))//for _, e := range errs {// // can translate each error one at a time.// fmt.Println(e.Translate(trans))//}c.JSON(http.StatusBadRequest, gin.H{"error": errs.Translate(trans)})}
}
运行程序,执行以下命令
$ curl "localhost:8085/bookable?check_in=2018-04-16&check_out=2018-04-16"
结果:
{"error":{"Booking.输入时间":"输入时间不能早于当前时间或输入时间格式错误!","Booking.输出时间":"输出时间必须大于CheckIn"}}
查看以上结果我们发现翻译还是不太完美,如规则中有gtfield的情况,字段(CheckIn)并没有被翻译。所以通过struct添加label的方式并不能从根本上解决字段翻译问题。为了得到想要的结果,就需要将错误信息做单独处理再输出。
先定义翻译库
var BookingTrans =map[string]string{"CheckIn":"输入时间","CheckOut":"输出时间"}
再定义翻译函数
func TransTagName(libTans,err interface{}) interface{} {switch err.(type) {case validator.ValidationErrorsTranslations:var errs map[string]stringerrs = make(map[string]string,0)for k,v:=range err.(validator.ValidationErrorsTranslations){for key,value:=range libTans.(map[string]string) {v=strings.Replace(v,key,value,-1)}errs[k] = v}return errscase string:var errs stringfor key,value:=range libTans.(map[string]string) {errs=strings.Replace(errs,key,value,-1)}return errsdefault:return err}
}
将原来翻译错误信息的地方
errs.Translate(trans)
修改为
msg:=TransTagName(BookingTrans,errs.Translate(trans))
fmt.Println(msg)
结果
{"error":{"Booking.输入时间":"输入时间不能早于当前时间或输入时间格式错误!","Booking.输出时间":"输出时间必须大于输入时间"}}
小结:
gin 已经支持validator最新的v10。
validator数据验证顺序struct字段从上往下,单个字段规则(binding:"gt=0,lt=2`),先左后右。
参考:
https://github.com/go-playground/validator
https://github.com/gin-gonic/gin
https://gitissue.com/issues/5d06a73965d56f73569b825f
https://segmentfault.com/a/1190000022527284
links
- 目录
golang之数据验证validator相关推荐
- 【Go】数据验证-validator
Go数据验证-validator 前言 安装 使用方法 验证规则 跨字段验证 前言 在web后端开发中经常会遇到数据验证的问题,对于前后端分离的web应用来说,后端对前端传来的数据应持有完全不信任的态 ...
- Springmvc的服务端数据验证-----Hibernate Validator
导入Hibernate validator的Jar包 hibernate-validator-4.3.0.Final.jar jboss-logging-3.1.0.CR2.jar validatio ...
- ExtJs 备忘录(3)—— Form表单(三) [ 数据验证 ]
正文 一.资料 1.1. 表单提示的方式设置,如: Ext.form.Field.prototype.msgTarget='side' 该设置为枚举值:'qtip','side','title','u ...
- Silverlight实例教程 - Validation数据验证开篇
Silverlight 4 Validation验证实例系列 Silverlight实例教程 - Validation数据验证开篇 Silverlight实例教程 - Validation数据验证基础 ...
- 基于jquery,bootstrap数据验证插件bootstrapValidator 教程
ootstrap:能够增加兼容性的强大框架. 因为项目需要数据验证,看bootstrapValidator 还不错,就上手一直,完美兼容,话不多说. 需要引用css: bootstrap.min.cs ...
- Spring MVC 数据验证——validate注解方式
1.说明 学习注解方式之前,应该先学习一下编码方式的spring注入.这样便于理解验证框架的工作原理.在出错的时候,也能更好的解决这个问题.所以本次博客教程也是基于编码方式.仅仅是在原来的基础加上注解 ...
- 自定义注解做数据验证
为了工作也为了更加深入了解掌握java注解的使用,决定自定义注解来实现数据验证. 最开始也考虑使用jsr-303规范来实现功能,但是对于开发人员来说比较累,因为要去实体类对象中添加验证字段注解,而且要 ...
- springmvc数据验证
当提交表单时,前台js会做一些验证,某些情况下后台验证也是必不可少的. 今天实现了一个JSR-303规范的数据验证. 使用jar包:hibernate-validator-4.3.0.Final.ja ...
- Active Record 数据验证
数据验证概览 为什么要做数据验证 数据验证确保只有有效的数据才能存入数据库,在模型中做验证是最有保障的,只有通过验证的数据才能存入数据库.数据验证和使用的数据库种类无关,终端用户也无法跳过,而且容易测 ...
最新文章
- 您的用户界面是您产品不会因心灵感应而谦卑的补偿
- Samba-上课内容
- linux sockaddr_in头文件,linux网络编程常用头文件
- 用IJ和gradle启动elasticsearch5.4.3
- 每天学一点儿shell:正则表达式
- 网络边缘(接入网和物理介质)
- Boost:bimap双图的序列化的测试程序
- 《Scala机器学习》一一3.3 应用
- JavaScript DOM 6 - 节点的创建,插入,替换,删除
- python cli_click python cli 开发包
- 第一模块:开发基础 第1章·Python基础语法
- pcc定义_PCC介绍——智能管道
- 移动开发者走向全能开发者的五大技能
- matlab 计算矩阵a的离散余弦变换
- Android TV开发总结(一)构建一个TV app前要知道的事儿
- 深入浅出设计模式---1、设计模式原则和分类
- kibana报错-Login is currently disabled.
- 丰密面单打印 隐私面单 C#开发
- Java判断邮箱格式是否正确
- 查询一个表中的两个字段值相同的数据
热门文章
- 注塑模具的五大特点,你知道吗?
- 掘金Filecoin的方法与注意事项 |链捕手
- 【工厂方法模式】将原有的电视机工厂进行分割,为每种品牌的电视机提供一个子工厂,海尔工厂专门负责生产海尔电视机,海信工厂专门负责生产海信电视机,如果需要生产其他电视,只需要对应增加一个新的工厂即可
- 数字劳工与下一代互联网 1
- 细节决定ERP项目启动会的成败
- SpringAop切面中获取方法的返回值
- linux 微代码下载,英特尔放出Linux微代码以修复Meltdown和Spectre漏洞
- Web前端开发实验作业 - 网页计算器
- 嵌入式学习代码总结(一)
- phpinfo查看可以解析的后缀_phpinfo详解