Go語言參數校驗（go-playground / validator）——基本使用

Go語言沒有像Java一樣的注解快速進行參數的校驗，但可以通過struct tag（結構體標簽）進行序列化。常用的如：

type User struct {
ID string `json:"id"`
Name string `json:"name"`
Age string `json:"age"`
}
但需要更復雜的校驗，這時需要用一些專業的庫來完成。go-playground / validator作為一款優秀的Go語言校驗庫，基於標記為結構體和單個字段實現值驗證。使用簡單、快捷。

添加依賴
go get github.com/go-playground/validator
代碼
package main

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

var validate *validator.Validate //定義

type User struct {
Name string `validate:"required"` //非空
Age uint8 `validate:"gte=0,lte=130"` // 0<=Age<=130
Email string `validate:"required,email"` //非空，email格式
//dive關鍵字代表 進入到嵌套結構體進行判斷
Address []*Address `validate:"dive"` // 可以擁有多個地址
}
type Address struct {
Province string `validate:"required"` //非空
City string `validate:"required"` //非空
Phone string `validate:"numeric,len=11"` //數字類型，長度為11
}

func main() {
validate = validator.New() //初始化（賦值）
validateStruct() //結構體校驗
validateVariable() //變量校驗
}
func validateStruct() {
address := Address{
Province: "重慶",
City: "重慶",
Phone: "13366663333x",
}
user := User{
Name: "江洲",
Age: 23,
Email: "[e-mail]",
Address: []*Address{&address},
}
err := validate.Struct(user)
if err != nil {
//斷言為：validator.ValidationErrors，類型為：[]FieldError
for _, e := range err.(validator.ValidationErrors) {
fmt.Println("Namespace:", e.Namespace())
fmt.Println("Field:", e.Field())
fmt.Println("StructNamespace:", e.StructNamespace())
fmt.Println("StructField:", e.StructField())
fmt.Println("Tag:", e.Tag())
fmt.Println("ActualTag:", e.ActualTag())
fmt.Println("Kind:", e.Kind())
fmt.Println("Type:", e.Type())
fmt.Println("Value:", e.Value())
fmt.Println("Param:", e.Param())
fmt.Println()
}

fmt.Println("結構體輸入數據類型錯誤！")
return
} else {
fmt.Println("結構體校驗通過")
}
}
//變量校驗
func validateVariable() {
myEmail := "[e-mail]" //郵箱地址：[e-mail]
err := validate.Var(myEmail, "required,email")
if err != nil {
fmt.Println(err)
} else {
fmt.Println("變量校驗通過！")
}
}
運行效果：

————————————————
版權聲明：本文為CSDN博主「cqu_jiangzhou」的原創文章，遵循CC 4.0 BY-SA版權協議，轉載請附上原文出處鏈接及本聲明。
原文鏈接：https://blog.csdn.net/weixin_42117918/article/details/107407053

 

 

 

 

 

 

 

前言

在web應用中經常會遇到數據驗證問題，普通的驗證方法比較繁瑣，這里介紹一個使用比較多的包validator。

原理

將驗證規則寫在struct對字段tag里，再通過反射（reflect）獲取struct的tag，實現數據驗證。

安裝

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 }

驗證規則

• 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...

自定義驗證類型

示例：

package main

import (
    "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' tag return } } 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 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() //驗證器注冊翻譯器 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

至此我們發現大部分錯誤信息已經翻譯成中文，但字段名（Age）還是沒有翻譯，為了將字段名翻譯成中文，查了一些資料，https://www.jianshu.com/p/51b...，

照着做沒有成功（可能有遺漏吧），最后還是翻看了一下源代碼，在https://github.com/go-playgro...，第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 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:"用戶名"` 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))//年齡必須大於18 return } } return } 

輸出結果：

年齡必須大於18

gin 內置的validator

gin已經支持go-playground / validator / v10進行驗證。在此處查看有關標簽用法的完整文檔。

以下只提供了一個綁定ShouldBindWith示例，如需了解更多方法，進入這里。

示例

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:"輸入時間"` 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 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)}) } }

運行程序，執行以下命令

$ 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]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 } } 

將原來翻譯錯誤信息的地方

errs.Translate(trans)

修改為

msg:=TransTagName(BookingTrans,errs.Translate(trans)) fmt.Println(msg)

結果

{"error":{"Booking.輸入時間":"輸入時間不能早於當前時間或輸入時間格式錯誤!","Booking.輸出時間":"輸出時間必須大於輸入時間"}}

小結：

1. gin 已經支持validator最新的v10。
2. validator數據驗證順序struct字段從上往下，單個字段規則（binding:"gt=0,lt=2`），先左后右。

參考：

https://github.com/go-playgro...

https://github.com/gin-gonic/gin

https://gitissue.com/issues/5...

https://segmentfault.com/a/11...