validator庫參數校驗
1.介紹
-
validator 庫做參數校驗是否實用，包括錯誤翻譯等提示
-
下載
go get github.com/go-playground/validator/v10
2.gin內置校驗
- 先看一下gin內置validator做校驗
package main
import (
"github.com/gin-gonic/gin"
"net/http"
)
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
}
// 執行邏輯，保存db
c.JSON(http.StatusOK,"success")
})
_ = r.Run(":28282")
}
- 我們用postman 發送請求
{
"age":28,
"name":"liSir",
"email":"300202@qq.com"
}
// 會返回來錯誤信息
{
"msg": "Key: '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檢驗不通過。但都是英文。
3.如何將校驗錯誤信息翻譯成中文
- validator庫支持國際化，借助相應語言包可以實現校驗錯誤提示信息自動翻譯。
package main
import (
"fmt"
"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"
"net/http"
)
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"`
}
// 全局翻譯器T
var trans ut.Translator
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(enT,zhT,enT)
// locale通常取決於http請求'Accept-language'
var ok bool
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
}
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)
// 非validator類型錯誤直接返回
if !ok{
c.JSON(http.StatusOK,gin.H{
"message":err.Error(),
})
return
}
// valodator.ValidationErrors類型錯誤進行翻譯
c.JSON(http.StatusOK,gin.H{
"message":errs.Translate(trans),
})
}
// 執行邏輯，保存db
c.JSON(http.StatusOK,"success")
})
_ = r.Run(":28282")
}
- 返回結果
{
"message": {
"SignUpParam.Password": "Password為必填字段",
"SignUpParam.RePassword": "RePassword為必填字段"
}
}"success"
4.自定義錯誤提示信息字段名
- 錯誤信息提示中的字段用自定義的名稱，例如json tag指定的值呢？
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
})
....
- 再次發送請求
{
"message": {
"SignUpParam.password": "password為必填字段",
"SignUpParam.re_password": "re_password為必填字段"
}
}"success"
- 可以看到錯誤提示信息使用就是我們結構體中json tag設置的名稱。但是前段提示信息不需要提示SignUpParam,這里可以去掉結構體名稱前綴，
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
}
- 我們在代碼中使用上述翻譯后
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類型錯誤則進行翻譯
// 並使用removeTopStruct函數去除字段名中的結構體名稱標識
c.JSON(http.StatusOK, gin.H{
"msg": removeTopStruct(errs.Translate(trans)),
})
}
- 最終顯示效果
{
"message": {
"password": "password為必填字段",
"re_password": "re_password為必填字段"
}
}"success"
- 如果我們想將上面Password字段也改為json
// SignUpParamStructLevelValidation 自定義SignUpParam結構體校驗函數
func SignUpParamStructLevelValidation(sl validator.StructLevel) {
su := sl.Current().Interface().(SignUpParam)
if su.Password != su.RePassword {
// 輸出錯誤提示信息，最后一個參數就是傳遞的param
sl.ReportError(su.RePassword, "re_password", "RePassword", "eqfield", "password")
}
}
- 在初始化校驗器的函數中注冊自定義校驗方法即可
func InitTrans(locale string) (err error) {
// 修改gin框架中的Validator引擎屬性，實現自定制
if v, ok := binding.Validator.Engine().(*validator.Validate); ok {
// ... liwenzhou.com ...
// 為SignUpParam注冊自定義校驗方法
v.RegisterStructValidation(SignUpParamStructLevelValidation, SignUpParam{})
zhT := zh.New() // 中文翻譯器
enT := en.New() // 英文翻譯器
// ... liwenzhou.com ...
}
5.自定義校驗方法
type SignUpParam struct{
...
Date string `json:"date" binding:"required,datetime=2006-01-02,checkDate"
}
其中datetime=2006-01-02是內置的用於校驗日期類參數是否滿足指定格式要求的tag。 如果傳入的date參數不滿足2006-01-02這種格式就會提示如下錯誤：
// customFunc 自定義字段級別校驗方法
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
}
// 在校驗器注冊自定義的校驗方法
if err := v.RegisterValidation("checkDate", customFunc); err != nil {
return err
}
6.自定義翻譯方法
// 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
}
- 定義好相關翻譯方法，再初始化
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
}
// 注意！因為這里會使用到trans實例
// 所以這一步注冊要放到trans初始化的后面
if err := v.RegisterTranslation(
"checkDate",
trans,
registerTranslator("checkDate", "{0}必須要晚於當前日期"),
translate,
); err != nil {
return err
}
return
}
return
}