Go語(yǔ)言結(jié)合validator包實(shí)現(xiàn)表單驗(yàn)證
在現(xiàn)代 Web 開(kāi)發(fā)中,表單驗(yàn)證和錯(cuò)誤處理是至關(guān)重要的環(huán)節(jié),尤其是在多語(yǔ)言環(huán)境下。
本文將通過(guò)一個(gè)實(shí)際的示例,演示如何使用 Go 語(yǔ)言的 Gin 框架結(jié)合 validator
包,實(shí)現(xiàn)高級(jí)的表單驗(yàn)證功能,并且支持國(guó)際化(i18n)的錯(cuò)誤信息提示。
背景與需求
假設(shè)我們正在開(kāi)發(fā)一個(gè)用戶(hù)注冊(cè)功能,需要對(duì)用戶(hù)提交的信息進(jìn)行嚴(yán)格的驗(yàn)證。例如,用戶(hù)名不能為空、郵箱格式必須正確、密碼和確認(rèn)密碼必須一致、用戶(hù)年齡應(yīng)在合理范圍內(nèi)(如 1 到 130 歲),并且日期字段不能早于當(dāng)前日期。除此之外,系統(tǒng)還需要根據(jù)用戶(hù)的語(yǔ)言偏好提供相應(yīng)語(yǔ)言的錯(cuò)誤提示信息。
代碼示例
我們將從以下幾個(gè)方面展開(kāi):
- 表單數(shù)據(jù)的結(jié)構(gòu)定義
- 表單驗(yàn)證器的初始化與自定義
- 多語(yǔ)言支持的實(shí)現(xiàn)
- 處理表單提交與錯(cuò)誤返回
package main import ( "fmt" "net/http" "reflect" "strings" "time" "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" ) // 定義一個(gè)全局翻譯器 var trans ut.Translator
表單數(shù)據(jù)結(jié)構(gòu)定義
首先,我們定義用戶(hù)提交的表單數(shù)據(jù)結(jié)構(gòu) SignUpParam
。這個(gè)結(jié)構(gòu)體中包含了用戶(hù)注冊(cè)時(shí)所需的各個(gè)字段,并通過(guò)結(jié)構(gòu)標(biāo)簽(tags)指定了驗(yàn)證規(guī)則。
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"` Date string `json:"date" binding:"required,datetime=2006-01-02,checkDate"` }
Age
字段必須在 1 到 130 歲之間。Name
字段不能為空。Email
字段必須是有效的電子郵件地址。Password
和RePassword
字段必須一致。Date
字段需要使用自定義校驗(yàn)方法checkDate
,確保輸入日期晚于當(dāng)前日期。
初始化與自定義表單驗(yàn)證器
在 Gin 框架中,我們可以通過(guò) binding.Validator.Engine()
獲取到內(nèi)置的驗(yàn)證器,并對(duì)其進(jìn)行自定義。
在下面的代碼中,我們完成了翻譯器的初始化,并注冊(cè)了自定義的標(biāo)簽名稱(chēng)和驗(yàn)證方法。
func InitTrans(locale string) (err error) { if v, ok := binding.Validator.Engine().(*validator.Validate); ok { // 注冊(cè)獲取 JSON tag 的自定義方法 v.RegisterTagNameFunc(func(fld reflect.StructField) string { name := strings.SplitN(fld.Tag.Get("json"), ",", 2)[0] if name == "-" { return "" } return name }) // 注冊(cè)結(jié)構(gòu)體級(jí)別的驗(yàn)證函數(shù) v.RegisterStructValidation(SignUpParamStructLevelValidation, SignUpParam{}) // 注冊(cè)自定義校驗(yàn)方法 if err := v.RegisterValidation("checkDate", customFunc); err != nil { return err } // 初始化多語(yǔ)言支持 zhT := zh.New() enT := en.New() uni := ut.New(enT, zhT, enT) var ok bool trans, ok = uni.GetTranslator(locale) if !ok { return fmt.Errorf("uni.GetTranslator(%s) failed", locale) } // 注冊(cè)語(yǔ)言翻譯 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 } // 注冊(cè)自定義翻譯 if err := v.RegisterTranslation( "checkDate", trans, registerTranslator("checkDate", "{0}必須晚于當(dāng)前日期"), translate, ); err != nil { return err } return } return }
實(shí)現(xiàn)自定義校驗(yàn)邏輯
在上面的代碼中,我們自定義了兩個(gè)校驗(yàn)函數(shù):
- customFunc:用于校驗(yàn)日期是否晚于當(dāng)前日期。
- SignUpParamStructLevelValidation:用于校驗(yàn)兩個(gè)密碼字段是否一致。
func customFunc(fl validator.FieldLevel) bool { date, err := time.Parse("2006-01-02", fl.Field().String()) if err != nil { return false } return date.After(time.Now()) } func SignUpParamStructLevelValidation(sl validator.StructLevel) { su := sl.Current().Interface().(SignUpParam) if su.Password != su.RePassword { sl.ReportError(su.RePassword, "re_password", "RePassword", "eqfield", "password") } }
處理多語(yǔ)言錯(cuò)誤提示
為了確保錯(cuò)誤信息能夠根據(jù)用戶(hù)的語(yǔ)言偏好正確返回,我們注冊(cè)了一個(gè)自定義的翻譯函數(shù) registerTranslator
,并在驗(yàn)證失敗時(shí)使用該函數(shù)對(duì)錯(cuò)誤信息進(jì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 }
主程序邏輯
最后,我們?cè)?Gin 中處理用戶(hù)的注冊(cè)請(qǐng)求。當(dāng)用戶(hù)提交的數(shù)據(jù)驗(yàn)證失敗時(shí),系統(tǒng)會(huì)自動(dòng)返回翻譯后的錯(cuò)誤提示信息。
// removeTopStruct 去除字段名中的結(jié)構(gòu)體名稱(chēng)標(biāo)識(shí) // refer from:https://github.com/go-playground/validator/issues/633#issuecomment-654382345 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 } func main() { // 初始化翻譯器 if err := InitTrans("zh"); err != nil { fmt.Printf("初始化翻譯器失敗: %v\n", err) return } r := gin.Default() r.POST("/signup", func(c *gin.Context) { var u SignUpParam if err := c.ShouldBind(&u); err != nil { errs, ok := err.(validator.ValidationErrors) if !ok { c.JSON(http.StatusOK, gin.H{"msg": err.Error()}) return } c.JSON(http.StatusOK, gin.H{"msg": removeTopStruct(errs.Translate(trans))}) return } // 其他的一些業(yè)務(wù)邏輯操作…… c.JSON(http.StatusOK, gin.H{"msg": "success"}) }) err := r.Run(":8080") if err != nil { fmt.Printf("服務(wù)器運(yùn)行失敗: %v\n", err) } }
總結(jié)
本文通過(guò)一個(gè)完整的示例,展示了如何在 Go 語(yǔ)言中使用 Gin 框架實(shí)現(xiàn)多語(yǔ)言的表單驗(yàn)證。
我們不僅探討了基礎(chǔ)的驗(yàn)證規(guī)則,還介紹了如何自定義驗(yàn)證邏輯以及如何實(shí)現(xiàn)國(guó)際化的錯(cuò)誤提示。這種方式使得我們的應(yīng)用程序不僅在功能上更加強(qiáng)大,同時(shí)也能更好地適應(yīng)全球化的需求。
到此這篇關(guān)于Go語(yǔ)言結(jié)合validator包實(shí)現(xiàn)表單驗(yàn)證的文章就介紹到這了,更多相關(guān)Go validator表單驗(yàn)證內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
go語(yǔ)言實(shí)現(xiàn)同步操作項(xiàng)目示例
本文主要介紹了go語(yǔ)言實(shí)現(xiàn)同步操作項(xiàng)目示例,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2023-05-05Go語(yǔ)言實(shí)現(xiàn)生成樣式美觀的PDF文件
使用?Go?語(yǔ)言生成樣式美觀的?PDF?文件是一個(gè)常見(jiàn)的需求,尤其是在報(bào)告生成、發(fā)票、合同等場(chǎng)景中,下面就跟隨小編一起來(lái)學(xué)習(xí)一下具體實(shí)現(xiàn)方法吧2025-01-01go語(yǔ)言通過(guò)zlib壓縮數(shù)據(jù)的方法
這篇文章主要介紹了go語(yǔ)言通過(guò)zlib壓縮數(shù)據(jù)的方法,實(shí)例分析了Go語(yǔ)言中zlib的使用技巧,需要的朋友可以參考下2015-03-03GoLang中生成UUID唯一標(biāo)識(shí)的實(shí)現(xiàn)方法
UUID是讓分散式系統(tǒng)中的所有元素,都能有唯一的辨識(shí)信息,本文主要介紹了GoLang中生成UUID唯一標(biāo)識(shí)的實(shí)現(xiàn)方法,具有一定的參考價(jià)值,感興趣的可以了解一下2024-08-08