gin-validator參數校驗

一 背景

在web開發中一個不可避免的環節就是對請求參數進行校驗，通常我們會在代碼中定義與請求參數相對應的模型（結構體），借助模型綁定快捷地解析請求中的參數，例如 gin 框架中的Bind和ShouldBind系列方法。本文就以 gin 框架的請求參數校驗為例，介紹一些validator庫的實用技巧。

gin框架使用github.com/go-playground/validator進行參數校驗，目前已經支持github.com/go-playground/validator/v10了，我們需要在定義結構體時使用 binding tag標識相關校驗規則，可以查看validator文檔查看支持的所有 tag。

二 示例

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 } // 保存入庫等業務邏輯代碼... c.JSON(http.StatusOK, "success") }) _ = r.Run(":8999") }

我們使用curl發送一個POST請求測試下：

curl -H "Content-type: application/json" -X POST -d '{"name":"q1mi","age":18,"email":"123.com"}' http://127.0.0.1:8999/signup

輸出結果：

{"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"}

從最終的輸出結果可以看到 validator 的檢驗生效了，但是錯誤提示的字段不是特別友好，我們可能需要將它翻譯成中文。

三 翻譯驗證信息

validator庫本身是支持國際化的，借助相應的語言包可以實現校驗錯誤提示信息的自動翻譯。下面的示例代碼演示了如何將錯誤提示信息翻譯成中文，翻譯成其他語言的方法類似。

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引擎屬性，實現自定制 if v, ok := binding.Validator.Engine().(*validator.Validate); ok { zhT := zh.New() // 中文翻譯器 enT := en.New() // 英文翻譯器 // 第一個參數是備用（fallback）的語言環境 // 后面的參數是應該支持的語言環境（支持多個） // uni := ut.New(zhT, zhT) 也是可以的 uni := ut.New(enT, zhT, enT) // locale 通常取決于 http 請求頭的 'Accept-Language' var ok bool // 也可以使用 uni.FindTranslator(...) 傳入多個locale進行查找 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類型錯誤則進行翻譯 c.JSON(http.StatusOK, gin.H{ "msg":errs.Translate(trans), }) return } // 保存入庫等具體業務邏輯代碼... 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

這一次的輸出結果如下：

{"msg":{"SignUpParam.Email":"Email必須是一個有效的郵箱","SignUpParam.Password":"Password為必填字段","SignUpParam.RePassword":"RePassword為必填字段"}}

機器翻譯

版權聲明：本文內容由網絡用戶投稿，版權歸原作者所有，本站不擁有其著作權，亦不承擔相應法律責任。如果您發現本站中有涉嫌抄襲或描述失實的內容，請聯系我們jiasou666@gmail.com 處理，核實后本網站將在24小時內刪除侵權內容。

版權聲明：本文內容由網絡用戶投稿，版權歸原作者所有，本站不擁有其著作權，亦不承擔相應法律責任。如果您發現本站中有涉嫌抄襲或描述失實的內容，請聯系我們jiasou666@gmail.com 處理，核實后本網站將在24小時內刪除侵權內容。