golang validator庫參數(shù)校驗(yàn)實(shí)用技巧干貨
validator庫參數(shù)校驗(yàn)若干實(shí)用技巧
在web開發(fā)中一個不可避免的環(huán)節(jié)就是對請求參數(shù)進(jìn)行校驗(yàn)，通常我們會在代碼中定義與請求參數(shù)相對應(yīng)的模型（結(jié)構(gòu)體），借助模型綁定快捷地解析請求中的參數(shù)，例如 gin 框架中的Bind和ShouldBind系列方法。本文就以 gin 框架的請求參數(shù)校驗(yàn)為例，介紹一些validator庫的實(shí)用技巧。
gin框架使用github.com/go-playground/validator進(jìn)行參數(shù)校驗(yàn)，目前已經(jīng)支持github.com/go-playground/validator/v10了，我們需要在定義結(jié)構(gòu)體時(shí)使用 binding tag標(biāo)識相關(guān)校驗(yàn)規(guī)則，可以查看validator文檔查看支持的所有 tag。
基本示例
首先來看gin框架內(nèi)置使用validator做參數(shù)校驗(yàn)的基本示例。
package main
import (
"net/http"
"github.com/gin-gonic/gin"
)
type SignUpParam struct {
Age uint8 `json:"age" binding:"gte=1,lte=130"`
Name string `json:"name" binding:"required"`
Email string `json:"email" binding:"required,email"`
Password string `json:"password" binding:"required"`
RePassword string `json:"re_password" binding:"required,eqfield=Password"`
}
func main() {
r := gin.Default()
r.POST("/signup", func(c *gin.Context) {
var u SignUpParam
if err := c.ShouldBind(&u); err != nil {
c.JSON(http.StatusOK, gin.H{
"msg": err.Error(),
})
return
}
// 保存入庫等業(yè)務(wù)邏輯代碼...
c.JSON(http.StatusOK, "success")
})
_ = r.Run(":8999")
}
我們使用curl發(fā)送一個POST請求測試下：
curl -H "Content-type: application/json" -X POST -d '{"name":"q1mi","age":18,"email":"123.com"}' http://127.0.0.1:8999/signup
輸出結(jié)果：
{"msg":"Key: 'SignUpParam.Email' Error:Field validation for 'Email' failed on the 'email' tag\nKey: 'SignUpParam.Password' Error:Field validation for 'Password' failed on the 'required' tag\nKey: 'SignUpParam.RePassword' Error:Field validation for 'RePassword' failed on the 'required' tag"}
從最終的輸出結(jié)果可以看到 validator 的檢驗(yàn)生效了，但是錯誤提示的字段不是特別友好，我們可能需要將它翻譯成中文。
翻譯校驗(yàn)錯誤提示信息
validator庫本身是支持國際化的，借助相應(yīng)的語言包可以實(shí)現(xiàn)校驗(yàn)錯誤提示信息的自動翻譯。下面的示例代碼演示了如何將錯誤提示信息翻譯成中文，翻譯成其他語言的方法類似。
package main
import (
"fmt"
"net/http"
"github.com/gin-gonic/gin"
"github.com/gin-gonic/gin/binding"
"github.com/go-playground/locales/en"
"github.com/go-playground/locales/zh"
ut "github.com/go-playground/universal-translator"
"github.com/go-playground/validator/v10"
enTranslations "github.com/go-playground/validator/v10/translations/en"
zhTranslations "github.com/go-playground/validator/v10/translations/zh"
)
// 定義一個全局翻譯器T
var trans ut.Translator
// InitTrans 初始化翻譯器
func InitTrans(locale string) (err error) {
// 修改gin框架中的Validator引擎屬性，實(shí)現(xiàn)自定制
if v, ok := binding.Validator.Engine().(*validator.Validate); ok {
zhT := zh.New() // 中文翻譯器
enT := en.New() // 英文翻譯器
// 第一個參數(shù)是備用（fallback）的語言環(huán)境
// 后面的參數(shù)是應(yīng)該支持的語言環(huán)境（支持多個）
// uni := ut.New(zhT, zhT) 也是可以的
uni := ut.New(enT, zhT, enT)
// locale 通常取決于 http 請求頭的 'Accept-Language'
var ok bool
// 也可以使用 uni.FindTranslator(...) 傳入多個locale進(jìn)行查找
trans, ok = uni.GetTranslator(locale)
if !ok {
return fmt.Errorf("uni.GetTranslator(%s) failed", locale)
}
// 注冊翻譯器
switch locale {
case "en":
err = enTranslations.RegisterDefaultTranslations(v, trans)
case "zh":
err = zhTranslations.RegisterDefaultTranslations(v, trans)
default:
err = enTranslations.RegisterDefaultTranslations(v, trans)
}
return
}
return
}
type SignUpParam struct {
Age uint8 `json:"age" binding:"gte=1,lte=130"`
Name string `json:"name" binding:"required"`
Email string `json:"email" binding:"required,email"`
Password string `json:"password" binding:"required"`
RePassword string `json:"re_password" binding:"required,eqfield=Password"`
}
func main() {
if err := InitTrans("zh"); err != nil {
fmt.Printf("init trans failed, err:%v\n", err)
return
}
r := gin.Default()
r.POST("/signup", func(c *gin.Context) {
var u SignUpParam
if err := c.ShouldBind(&u); err != nil {
// 獲取validator.ValidationErrors類型的errors
errs, ok := err.(validator.ValidationErrors)
if !ok {
// 非validator.ValidationErrors類型錯誤直接返回
c.JSON(http.StatusOK, gin.H{
"msg": err.Error(),
})
return
}
// validator.ValidationErrors類型錯誤則進(jìn)行翻譯
c.JSON(http.StatusOK, gin.H{
"msg":errs.Translate(trans),
})
return
}
// 保存入庫等具體業(yè)務(wù)邏輯代碼...
c.JSON(http.StatusOK, "success")
})
_ = r.Run(":8999")
}
同樣的請求再來一次：
curl -H "Content-type: application/json" -X POST -d '{"name":"q1mi","age":18,"email":"123.com"}' http://127.0.0.1:8999/signup
這一次的輸出結(jié)果如下：
{"msg":{"SignUpParam.Email":"Email必須是一個有效的郵箱","SignUpParam.Password":"Password為必填字段","SignUpParam.RePassword":"RePassword為必填字段"}}
自定義錯誤提示信息的字段名
上面的錯誤提示看起來是可以了，但是還是差點(diǎn)意思，首先是錯誤提示中的字段并不是請求中使用的字段，例如：RePassword是我們后端定義的結(jié)構(gòu)體中的字段名，而請求中使用的是re_password字段。如何是錯誤提示中的字段使用自定義的名稱，例如jsontag指定的值呢？
只需要在初始化翻譯器的時(shí)候像下面一樣添加一個獲取json tag的自定義方法即可。
// InitTrans 初始化翻譯器
func InitTrans(locale string) (err error) {
// 修改gin框架中的Validator引擎屬性，實(shí)現(xiàn)自定制
if v, ok := binding.Validator.Engine().(*validator.Validate); ok {
// 注冊一個獲取json tag的自定義方法
v.RegisterTagNameFunc(func(fld reflect.StructField) string {
name := strings.SplitN(fld.Tag.Get("json"), ",", 2)[0]
if name == "-" {
return ""
}
return name
})
zhT := zh.New() // 中文翻譯器
enT := en.New() // 英文翻譯器
// 第一個參數(shù)是備用（fallback）的語言環(huán)境
// 后面的參數(shù)是應(yīng)該支持的語言環(huán)境（支持多個）
// uni := ut.New(zhT, zhT) 也是可以的
uni := ut.New(enT, zhT, enT)
// ... liwenzhou.com ...
}
再嘗試發(fā)請求，看一下效果：
{"msg":{"SignUpParam.email":"email必須是一個有效的郵箱","SignUpParam.password":"password為必填字段","SignUpParam.re_password":"re_password為必填字段"}}
可以看到現(xiàn)在錯誤提示信息中使用的就是我們結(jié)構(gòu)體中jsontag設(shè)置的名稱了。
但是還是有點(diǎn)瑕疵，那就是最終的錯誤提示信息中心還是有我們后端定義的結(jié)構(gòu)體名稱——SignUpParam，這個名稱其實(shí)是不需要隨錯誤提示返回給前端的，前端并不需要這個值。我們需要想辦法把它去掉。
這里參考https://github.com/go-playground/validator/issues/633#issuecomment-654382345提供的方法，定義一個去掉結(jié)構(gòu)體名稱前綴的自定義方法：
func removeTopStruct(fields map[string]string) map[string]string {
res := map[string]string{}
for field, err := range fields {
res[field[strings.Index(field, ".")+1:]] = err
}
return res
}
我們在代碼中使用上述函數(shù)將翻譯后的errors做一下處理即可：
if err := c.ShouldBind(&u); err != nil {
// 獲取validator.ValidationErrors類型的errors
errs, ok := err.(validator.ValidationErrors)
if !ok {
// 非validator.ValidationErrors類型錯誤直接返回
c.JSON(http.StatusOK, gin.H{
"msg": err.Error(),
})
return
}
// validator.ValidationErrors類型錯誤則進(jìn)行翻譯
// 并使用removeTopStruct函數(shù)去除字段名中的結(jié)構(gòu)體名稱標(biāo)識
c.JSON(http.StatusOK, gin.H{
"msg": removeTopStruct(errs.Translate(trans)),
})
return
}
看一下最終的效果：
{"msg":{"email":"email必須是一個有效的郵箱","password":"password為必填字段","re_password":"re_password為必填字段"}}
這一次看起來就比較符合我們預(yù)期的標(biāo)準(zhǔn)了。
自定義結(jié)構(gòu)體校驗(yàn)方法
上面的校驗(yàn)還是有點(diǎn)小問題，就是當(dāng)涉及到一些復(fù)雜的校驗(yàn)規(guī)則，比如re_password字段需要與password字段的值相等這樣的校驗(yàn)規(guī)則，我們的自定義錯誤提示字段名稱方法就不能很好解決錯誤提示信息中的其他字段名稱了。
curl -H "Content-type: application/json" -X POST -d '{"name":"q1mi","age":18,"email":"123.com","password":"123","re_password":"321"}' http://127.0.0.1:8999/signup
最后輸出的錯誤提示信息如下：
{"msg":{"email":"email必須是一個有效的郵箱","re_password":"re_password必須等于Password"}}
可以看到re_password字段的提示信息中還是出現(xiàn)了Password這個結(jié)構(gòu)體字段名稱。這有點(diǎn)小小的遺憾，畢竟自定義字段名稱的方法不能影響被當(dāng)成param傳入的值。
此時(shí)如果想要追求更好的提示效果，將上面的Password字段也改為和json tag一致的名稱，就需要我們自定義結(jié)構(gòu)體校驗(yàn)的方法。
例如，我們?yōu)?code>SignUpParam自定義一個校驗(yàn)方法如下：
// SignUpParamStructLevelValidation 自定義SignUpParam結(jié)構(gòu)體校驗(yàn)函數(shù)
func SignUpParamStructLevelValidation(sl validator.StructLevel) {
su := sl.Current().Interface().(SignUpParam)
if su.Password != su.RePassword {
// 輸出錯誤提示信息，最后一個參數(shù)就是傳遞的param
sl.ReportError(su.RePassword, "re_password", "RePassword", "eqfield", "password")
}
}
然后在初始化校驗(yàn)器的函數(shù)中注冊該自定義校驗(yàn)方法即可：
func InitTrans(locale string) (err error) {
// 修改gin框架中的Validator引擎屬性，實(shí)現(xiàn)自定制
if v, ok := binding.Validator.Engine().(*validator.Validate); ok {
// ... liwenzhou.com ...
// 為SignUpParam注冊自定義校驗(yàn)方法
v.RegisterStructValidation(SignUpParamStructLevelValidation, SignUpParam{})
zhT := zh.New() // 中文翻譯器
enT := en.New() // 英文翻譯器
// ... liwenzhou.com ...
}
最終再請求一次，看一下效果：
{"msg":{"email":"email必須是一個有效的郵箱","re_password":"re_password必須等于password"}}
這一次re_password字段的錯誤提示信息就符合我們預(yù)期了。
自定義字段校驗(yàn)方法
除了上面介紹到的自定義結(jié)構(gòu)體校驗(yàn)方法，validator還支持為某個字段自定義校驗(yàn)方法，并使用RegisterValidation()注冊到校驗(yàn)器實(shí)例中。
接下來我們來為SignUpParam添加一個需要使用自定義校驗(yàn)方法checkDate做參數(shù)校驗(yàn)的字段Date。
type SignUpParam struct {
Age uint8 `json:"age" binding:"gte=1,lte=130"`
Name string `json:"name" binding:"required"`
Email string `json:"email" binding:"required,email"`
Password string `json:"password" binding:"required"`
RePassword string `json:"re_password" binding:"required,eqfield=Password"`
// 需要使用自定義校驗(yàn)方法checkDate做參數(shù)校驗(yàn)的字段Date
Date string `json:"date" binding:"required,datetime=2006-01-02,checkDate"`
}
其中datetime=2006-01-02是內(nèi)置的用于校驗(yàn)日期類參數(shù)是否滿足指定格式要求的tag。 如果傳入的date參數(shù)不滿足2006-01-02這種格式就會提示如下錯誤：
{"msg":{"date":"date的格式必須是2006-01-02"}}
針對date字段除了內(nèi)置的datetime=2006-01-02提供的格式要求外，假設(shè)我們還要求該字段的時(shí)間必須是一個未來的時(shí)間（晚于當(dāng)前時(shí)間），像這樣針對某個字段的特殊校驗(yàn)需求就需要我們使用自定義字段校驗(yàn)方法了。
首先我們要在需要執(zhí)行自定義校驗(yàn)的字段后面添加自定義tag，這里使用的是checkDate，注意使用英文分號分隔開。
// customFunc 自定義字段級別校驗(yàn)方法
func customFunc(fl validator.FieldLevel) bool {
date, err := time.Parse("2006-01-02", fl.Field().String())
if err != nil {
return false
}
if date.Before(time.Now()) {
return false
}
return true
}
定義好了字段及其自定義校驗(yàn)方法后，就需要將它們聯(lián)系起來并注冊到我們的校驗(yàn)器實(shí)例中。
// 在校驗(yàn)器注冊自定義的校驗(yàn)方法
if err := v.RegisterValidation("checkDate", customFunc); err != nil {
return err
}
這樣，我們就可以對請求參數(shù)中date字段執(zhí)行自定義的checkDate進(jìn)行校驗(yàn)了。 我們發(fā)送如下請求測試一下：
curl -H "Content-type: application/json" -X POST -d '{"name":"q1mi","age":18,"email":"123@qq.com","password":"123", "re_password": "123", "date":"2020-01-02"}' http://127.0.0.1:8999/signup
此時(shí)得到的響應(yīng)結(jié)果是：
{"msg":{"date":"Key: 'SignUpParam.date' Error:Field validation for 'date' failed on the 'checkDate' tag"}}
這…自定義字段級別的校驗(yàn)方法的錯誤提示信息很“簡單粗暴”，和我們上面的中文提示風(fēng)格有出入，必須想辦法搞定它呀！
自定義翻譯方法
我們現(xiàn)在需要為自定義字段校驗(yàn)方法提供一個自定義的翻譯方法，從而實(shí)現(xiàn)該字段錯誤提示信息的自定義顯示。
// registerTranslator 為自定義字段添加翻譯功能
func registerTranslator(tag string, msg string) validator.RegisterTranslationsFunc {
return func(trans ut.Translator) error {
if err := trans.Add(tag, msg, false); err != nil {
return err
}
return nil
}
}
// translate 自定義字段的翻譯方法
func translate(trans ut.Translator, fe validator.FieldError) string {
msg, err := trans.T(fe.Tag(), fe.Field())
if err != nil {
panic(fe.(error).Error())
}
return msg
}
定義好了相關(guān)翻譯方法之后，我們在InitTrans函數(shù)中通過調(diào)用RegisterTranslation()方法來注冊我們自定義的翻譯方法。
// InitTrans 初始化翻譯器
func InitTrans(locale string) (err error) {
// ...liwenzhou.com...
// 注冊翻譯器
switch locale {
case "en":
err = enTranslations.RegisterDefaultTranslations(v, trans)
case "zh":
err = zhTranslations.RegisterDefaultTranslations(v, trans)
default:
err = enTranslations.RegisterDefaultTranslations(v, trans)
}
if err != nil {
return err
}
// 注意！因?yàn)檫@里會使用到trans實(shí)例
// 所以這一步注冊要放到trans初始化的后面
if err := v.RegisterTranslation(
"checkDate",
trans,
registerTranslator("checkDate", "{0}必須要晚于當(dāng)前日期"),
translate,
); err != nil {
return err
}
return
}
return
}
這樣再次嘗試發(fā)送請求，就能得到想要的錯誤提示信息了。
{"msg":{"date":"date必須要晚于當(dāng)前日期"}}以上就是validator庫參數(shù)校驗(yàn)實(shí)用技巧干貨的詳細(xì)內(nèi)容，更多關(guān)于validator庫參數(shù)校驗(yàn)的資料請關(guān)注腳本之家其它相關(guān)文章！
相關(guān)文章
這篇文章主要為大家介紹了GORM不定參數(shù)的用法最佳實(shí)踐,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-12-12
Go語言RPC Authorization進(jìn)行簡單ip安全驗(yàn)證的方法
這篇文章主要介紹了Go語言RPC Authorization進(jìn)行簡單ip安全驗(yàn)證的方法,實(shí)例分析了Go語言進(jìn)行ip驗(yàn)證的技巧,需要的朋友可以參考下2015-03-03
Go語言開發(fā)實(shí)現(xiàn)查詢IP信息的MCP服務(wù)器
隨著?MCP?的快速普及和廣泛應(yīng)用,MCP?服務(wù)器也層出不窮,本文將詳細(xì)介紹如何在?Go?語言中使用?go-mcp?庫來開發(fā)一個查詢?IP?信息的?MCP?服務(wù)器,有需要的小伙伴可以參考下2025-04-04
本文主要介紹了解決go獲取文件md5值不正確的問題,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2024-01-01
GOLANG使用Context管理關(guān)聯(lián)goroutine的方法
這篇文章主要介紹了GOLANG使用Context管理關(guān)聯(lián)goroutine的方法，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2019-01-01
singleflight官方解釋其為：singleflight提供了一個重復(fù)的函數(shù)調(diào)用抑制機(jī)制。通俗的解釋其作用是，若有多個協(xié)程運(yùn)行某函數(shù)時(shí)，只讓一個協(xié)程去處理，然后批量返回。非常適合來做并發(fā)控制。常見用于緩存穿透的情況2023-01-01
golang使用viper加載配置文件實(shí)現(xiàn)自動反序列化到結(jié)構(gòu)
這篇文章主要為大家介紹了golang使用viper加載配置文件實(shí)現(xiàn)自動反序列化到結(jié)構(gòu)示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2023-08-08
這篇文章主要為大家介紹了Go??import下劃線_使用小技巧,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-12-12
這篇文章主要為大家介紹了Go ORM的封裝解決方式詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2023-01-01
Redis?BloomFilter布隆過濾器原理與實(shí)現(xiàn)
你在開發(fā)或者面試過程中，有沒有遇到過?海量數(shù)據(jù)需要查重，緩存穿透怎么避免等等這樣的問題呢？下面這個東西超棒，好好了解下，面試過關(guān)斬將，凸顯你的不一樣2022-10-10