前言
在web應(yīng)用中經(jīng)常會(huì)遇到數(shù)據(jù)驗(yàn)證問(wèn)題,普通的驗(yàn)證方法比較繁瑣,這里介紹一個(gè)使用比較多的包validator。
原理
將驗(yàn)證規(guī)則寫(xiě)在struct對(duì)字段tag里,再通過(guò)反射(reflect)獲取struct的tag,實(shí)現(xiàn)數(shù)據(jù)驗(yàn)證。
安裝
go get github.com/go-playground/validator/v10
示例
package main import ( "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' tag return } } return }
驗(yàn)證規(guī)則
跨字段驗(yàn)證
如想實(shí)現(xiàn)比較輸入密碼和確認(rèn)密碼是否一致等類(lèi)似場(chǎng)景
示例
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"` }
示例驗(yàn)證了Passwd,和Repasswd值是否相等。如想了解更多類(lèi)型,請(qǐng)參考文檔 https://godoc.org/gopkg.in/go-playground/validator.v10
自定義驗(yàn)證類(lèi)型
示例:
package main import ( "fmt" "github.com/go-playground/validator/v10" ) type Users struct { Name string `form:"name" json:"name" validate:"required,CustomValidationErrors"`//包含自定義函數(shù) 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() //注冊(cè)自定義函數(shù) _=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' tag return } } return } func CustomValidationErrors(fl validator.FieldLevel) bool { return fl.Field().String() != "admin" }
翻譯錯(cuò)誤信息為中文
通過(guò)以上示例我們看到,validator默認(rèn)的錯(cuò)誤提示信息類(lèi)似如下
Key: 'Users.Name' Error:Field validation for 'Name' failed on the 'CustomValidationErrors' tag
顯然這并不是我們想要,如想翻譯成中文,或其他語(yǔ)言怎么辦?go-playground上提供了很好的解決方法。
先自行安裝需要的兩個(gè)包
https://github.com/go-playground/locales
https://github.com/go-playground/universal-translator
執(zhí)行:
go get github.com/go-playground/universal-translator go get github.com/go-playground/locales
示例:
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 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() //驗(yàn)證器注冊(cè)翻譯器 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必須大于18 return } } return }
輸出:
Age必須大于18
至此我們發(fā)現(xiàn)大部分錯(cuò)誤信息已經(jīng)翻譯成中文,但字段名(Age)還是沒(méi)有翻譯,為了將字段名翻譯成中文,查了一些資料,https://www.jb51.net/article/197866.htm>,
照著做沒(méi)有成功(可能有遺漏吧),最后還是翻看了一下源代碼,在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 // })
其實(shí)原理就是注冊(cè)一個(gè)函數(shù),將struct tag里添加的中文名 作為備用名。
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" "reflect" ) type Users struct { Name string `form:"name" json:"name" validate:"required" label:"用戶(hù)名"` 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() //注冊(cè)一個(gè)函數(shù),獲取struct tag里自定義的label作為字段名 validate.RegisterTagNameFunc(func(fld reflect.StructField) string { name:=fld.Tag.Get("label") return name }) //注冊(cè)翻譯器 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))//年齡必須大于18 return } } return }
輸出結(jié)果:
年齡必須大于18
gin 內(nèi)置的validator
gin已經(jīng)支持go-playground / validator / v10進(jìn)行驗(yàn)證。在此處查看有關(guān)標(biāo)簽用法的完整文檔。
以下只提供了一個(gè)綁定ShouldBindWith示例,如需了解更多方法,進(jìn)入這里。
示例
package main import ( "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:"輸入時(shí)間"` CheckOut time.Time `form:"check_out" json:"check_out" binding:"required,gtfield=CheckIn" time_format:"2006-01-02" label:"輸出時(shí)間"` } 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 { //注冊(cè)翻譯器 _= zh_translations.RegisterDefaultTranslations(v, trans) //注冊(cè)自定義函數(shù) _=v.RegisterValidation("bookabledate", bookableDate) //注冊(cè)一個(gè)函數(shù),獲取struct tag里自定義的label作為字段名 v.RegisterTagNameFunc(func(fld reflect.StructField) string { name:=fld.Tag.Get("label") return name }) //根據(jù)提供的標(biāo)記注冊(cè)翻譯 v.RegisterTranslation("bookabledate", trans, func(ut ut.Translator) error { return ut.Add("bookabledate", "{0}不能早于當(dāng)前時(shí)間或{1}格式錯(cuò)誤!", 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 Booking if 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)}) } }
運(yùn)行程序,執(zhí)行以下命令
$ curl "localhost:8085/bookable?check_in=2018-04-16check_out=2018-04-16"
結(jié)果:
{"error":{"Booking.輸入時(shí)間":"輸入時(shí)間不能早于當(dāng)前時(shí)間或輸入時(shí)間格式錯(cuò)誤!","Booking.輸出時(shí)間":"輸出時(shí)間必須大于CheckIn"}}
查看以上結(jié)果我們發(fā)現(xiàn)翻譯還是不太完美,如規(guī)則中有g(shù)tfield的情況,字段(CheckIn)并沒(méi)有被翻譯。所以通過(guò)struct添加label的方式并不能從根本上解決字段翻譯問(wèn)題。為了得到想要的結(jié)果,就需要將錯(cuò)誤信息做單獨(dú)處理再輸出。
先定義翻譯庫(kù)
var BookingTrans =map[string]string{"CheckIn":"輸入時(shí)間","CheckOut":"輸出時(shí)間"}
再定義翻譯函數(shù)
func TransTagName(libTans,err interface{}) interface{} { switch err.(type) { case validator.ValidationErrorsTranslations: var errs map[string]string errs = 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 errs case string: var errs string for key,value:=range libTans.(map[string]string) { errs=strings.Replace(errs,key,value,-1) } return errs default: return err } }
將原來(lái)翻譯錯(cuò)誤信息的地方
errs.Translate(trans)
修改為
msg:=TransTagName(BookingTrans,errs.Translate(trans)) fmt.Println(msg)
結(jié)果
{"error":{"Booking.輸入時(shí)間":"輸入時(shí)間不能早于當(dāng)前時(shí)間或輸入時(shí)間格式錯(cuò)誤!","Booking.輸出時(shí)間":"輸出時(shí)間必須大于輸入時(shí)間"}}
小結(jié):
1.gin 已經(jīng)支持validator最新的v10。
2.validator數(shù)據(jù)驗(yàn)證順序struct字段從上往下,單個(gè)字段規(guī)則(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
到此這篇關(guān)于golang之?dāng)?shù)據(jù)驗(yàn)證validator的實(shí)現(xiàn)的文章就介紹到這了,更多相關(guān)golang 數(shù)據(jù)驗(yàn)證validator內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
標(biāo)簽:宜春 鷹潭 泰安 松原 黔西 保定 武漢 河池
巨人網(wǎng)絡(luò)通訊聲明:本文標(biāo)題《golang之?dāng)?shù)據(jù)驗(yàn)證validator的實(shí)現(xiàn)》,本文關(guān)鍵詞 golang,之,數(shù)據(jù),驗(yàn)證,validator,;如發(fā)現(xiàn)本文內(nèi)容存在版權(quán)問(wèn)題,煩請(qǐng)?zhí)峁┫嚓P(guān)信息告之我們,我們將及時(shí)溝通與處理。本站內(nèi)容系統(tǒng)采集于網(wǎng)絡(luò),涉及言論、版權(quán)與本站無(wú)關(guān)。