Golang驗(yàn)證器之validator是使用詳解
前言
對于HTTP請求,我們要在腦子里有一個(gè)根深蒂固的概念,那就是任何客戶端傳過來的數(shù)據(jù)都是不可信任的。那么開發(fā)接口的時(shí)候需要對客戶端傳提交的參數(shù)進(jìn)行參數(shù)校驗(yàn),如果提交的參數(shù)只有一個(gè)兩個(gè),這樣我們可以簡單寫個(gè)if判斷,那么要是有很多的參數(shù)校驗(yàn),那么滿屏都是參數(shù)校驗(yàn)的if判斷,效率不僅低還不美觀,接下來我們介紹一個(gè)參數(shù)校驗(yàn)器validator
。
什么是validator
Validator
是一個(gè) Golang 的第三方庫,用于對數(shù)據(jù)進(jìn)行校驗(yàn),常用于 API 的開發(fā)中,對客戶端發(fā)出的請求數(shù)據(jù)進(jìn)行嚴(yán)格校驗(yàn),防止惡意請求。
安裝
validator包安裝:
go get -u github.com/go-playground/validator/v10
使用方法
導(dǎo)入validator:
import "github.com/go-playground/validator/v10"
validator 應(yīng)用了 Golang
的 Struct Tag
和 Reflect
機(jī)制,基本思想是:在 Struct Tag
中為不同的字段定義各自類型的約束,然后通過 Reflect
獲取這些約束的類型信息并在校驗(yàn)器中進(jìn)行數(shù)據(jù)校驗(yàn)。
示例:
package main import ( "fmt" "github.com/go-playground/validator/v10" ) type User struct { UserName string `json:"user_name" validate:"required"` Password string `json:"password" validate:"required,min=6,max=20"` } func main() { example := User{ Password: "123", } //實(shí)例化驗(yàn)證器 validate := validator.New() errs := validate.Struct(example) if errs != nil { for _, err := range errs.(validator.ValidationErrors) { fmt.Println(err) } } }
validator包的驗(yàn)證提示默認(rèn)是英文的,輸出如下:
這樣看可能不太清楚,如果需要翻譯成中文則還需安裝驗(yàn)證提示翻譯包:
go get -u github.com/go-playground/locales go get -u github.com/go-playground/universal-translator
修改后如下:
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 User struct { UserName string `json:"user_name" validate:"required"` Password string `json:"password" validate:"required,min=6,max=20"` } func main() { example := User{ Password: "123", } // 中文翻譯器 uni := ut.New(zh.New()) trans, _ := uni.GetTranslator("zh") //實(shí)例化驗(yàn)證器 validate := validator.New() // 注冊翻譯器到校驗(yàn)器 err := zh_translations.RegisterDefaultTranslations(validate, trans) if err!=nil { fmt.Println(err) return } errs := validate.Struct(example) if errs != nil { for _, err := range errs.(validator.ValidationErrors) { fmt.Println(err.Translate(trans)) } } }
執(zhí)行輸出:
校驗(yàn)規(guī)則
下面列舉一部分我們開發(fā)中經(jīng)常用到的驗(yàn)證規(guī)則,詳細(xì)驗(yàn)證規(guī)則可以參考文檔:
https://pkg.go.dev/gopkg.in/go-playground/validator.v10
Tag | 說明 | 示例 |
---|---|---|
required | 必填 | Field或Struct validate:"required" |
omitempty | 空時(shí)忽略 | Field或Struct validate:"omitempty" |
len | 長度 | Field validate:"len=0" |
eq | 等于 | Field validate:"eq=0" |
gt | 大于 | Field validate:"gt=0" |
gte | 大于等于 | Field validate:"gte=0" |
lt | 小于 | Field validate:"lt=0" |
lte | 小于等于 | Field validate:"lte=0" |
min | 最小值 | Field validate:"min=1" |
max | 最大值 | Field validate:"max=2" |
required_with | 其他字段其中一個(gè)不為空且當(dāng)前字段不為空 | Field validate:"required_with=Field1 Field2" |
required_without | 其他字段其中一個(gè)為空且當(dāng)前字段不為空 | Field `validate:“required_without=Field1 Field2” |
lowercase | 符串值是否只包含小寫字符 | Field validate:"lowercase" |
uppercase | 符串值是否只包含大寫字符 | Field validate:"uppercase" |
字符串值包含一個(gè)有效的電子郵件 | Field validate:"email" | |
json | 字符串值是否為有效的JSON | Field validate:"json" |
url | 符串值是否包含有效的url | Field validate:"url" |
uri | 符串值是否包含有效的 uri | Field validate:"uri" |
contains | 字符串值包含子字符串值 | Field validate:"contains=@" |
excludes | 字符串值不包含子字符串值 | 字符串值不包含子字符串值 Field validate:"excludes=@" |
ip | 字符串值是否包含有效的 IP 地址 | Field validate:"ip" |
datetime | 字符串值是否包含有效的日期 | Field validate:"datetime" |
startswith | 字符串以提供的字符串值開始 | Field validate:"startswith=abc" |
endswith | 字符串以提供的字符串值結(jié)束 | Field validate:"endswith=abc" |
跨字段驗(yàn)證
validator 允許定義跨字段驗(yàn)證,即:驗(yàn)證某個(gè)字段與其他字段之間的關(guān)系。這種驗(yàn)證實(shí)際上分為兩種:
- 一種是參數(shù)字段就是同一個(gè)結(jié)構(gòu)體中的平級字段。
- 另一種是參數(shù)字段為結(jié)構(gòu)中其他字段的字段。
驗(yàn)證語法很簡單,如果是驗(yàn)證同一個(gè)結(jié)構(gòu)中的字段,則在基礎(chǔ)的 Tags 后面添加一個(gè) field 后綴,例如:eqfield 定義字段間的相等(eq)約束。如果是更深層次的字段,在 field 之前還需要加上 cs(Cross-Struct),eq 就變?yōu)榱?eqcsfield。
- 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 的值。
另外還有幾個(gè)常用的 Tag:
- required_with=Field1 Field2:在 Field1 或者 Field2 存在時(shí),必須;
- required_with_all=Field1 Field2:在 Field1 與 Field2 都存在時(shí),必須;
- required_without=Field1 Field2:在 Field1 或者 Field2 不存在時(shí),必須;
- required_without_all=Field1 Field2:在 Field1 與 Field2 都存在時(shí),必須;
錯(cuò)誤處理
通過看源碼,我們可以看到validator 返回的錯(cuò)誤有兩種,一種是參數(shù)錯(cuò)誤,一種是校驗(yàn)錯(cuò)誤,它們都實(shí)現(xiàn)了 error 接口。
- 參數(shù)錯(cuò)誤時(shí),返回 InvalidValidationError 類型;
- 校驗(yàn)錯(cuò)誤時(shí),返回 ValidationErrors 類型。ValidationErrors 是一個(gè)錯(cuò)誤切片,保存了每個(gè)字段違反的每個(gè)約束信息。
所以 validator 校驗(yàn)返回的結(jié)果有 3 種情況:
- nil:沒有錯(cuò)誤;
- InvalidValidationError:輸入?yún)?shù)錯(cuò)誤;
- ValidationErrors:字段違反約束。
validator 返回的錯(cuò)誤有兩種,一種是參數(shù)錯(cuò)誤,一種是校驗(yàn)錯(cuò)誤,它們都實(shí)現(xiàn)了 error 接口。
參數(shù)錯(cuò)誤時(shí),返回 InvalidValidationError 類型;
校驗(yàn)錯(cuò)誤時(shí),返回 ValidationErrors 類型。ValidationErrors 是一個(gè)錯(cuò)誤切片,保存了每個(gè)字段違反的每個(gè)約束信息。
所以 validator 校驗(yàn)返回的結(jié)果只有 3 種情況:
nil:沒有錯(cuò)誤;
InvalidValidationError:輸入?yún)?shù)錯(cuò)誤;
ValidationErrors:字段違反約束。
我們可以在程序中判斷 err != nil
時(shí),可以依次將 err轉(zhuǎn)換為 InvalidValidationError
和 ValidationErrors
以獲取更詳細(xì)的信息:
err := validate.Struct(user) if err != nil { invalid, ok := err.(*validator.InvalidValidationError) if ok { fmt.Println("param error:", invalid) return } validationErrs := err.(validator.ValidationErrors) for _, validationErr := range validationErrs { fmt.Println(validationErr) } }
小結(jié)
通過以上的內(nèi)容我們了解了validator
一些基本的功能和用法,在我們開發(fā)中大大提高了開發(fā)效率。
validator
功能非常豐富,使用較為簡單方便。它的應(yīng)用非常廣泛,建議了解一下。
到此這篇關(guān)于Golang驗(yàn)證器之validator是使用詳解的文章就介紹到這了,更多相關(guān)Golang validator內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
go語言通過odbc操作Access數(shù)據(jù)庫的方法
這篇文章主要介紹了go語言通過odbc操作Access數(shù)據(jù)庫的方法,實(shí)例分析了Go語言通過odbc連接、查詢與關(guān)閉access數(shù)據(jù)庫的技巧,需要的朋友可以參考下2015-03-03Go結(jié)合Redis用最簡單的方式實(shí)現(xiàn)分布式鎖
本文主要介紹了Go結(jié)合Redis用最簡單的方式實(shí)現(xiàn)分布式鎖示例,文中通過示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2022-01-01golang?metrics各個(gè)指標(biāo)含義講解說明
這篇文章主要為大家介紹了golang?metrics各個(gè)指標(biāo)含義講解說明,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-05-05Go語言實(shí)戰(zhàn)之詳細(xì)掌握正則表達(dá)式的應(yīng)用與技巧
正則表達(dá)式是一種從左到右與主題字符串匹配的模式,正則表達(dá)式用于替換字符串中的文本,驗(yàn)證表單,基于模式匹配從字符串中提取子字符串等等,這篇文章主要給大家介紹了關(guān)于Go語言實(shí)戰(zhàn)之詳細(xì)掌握正則表達(dá)式的應(yīng)用與技巧,需要的朋友可以參考下2023-12-12深入了解Golang?interface{}的底層原理實(shí)現(xiàn)
在?Go?語言沒有泛型之前,接口可以作為一種替代實(shí)現(xiàn),也就是萬物皆為的?interface。那到底?interface?是怎么設(shè)計(jì)的底層結(jié)構(gòu)呢?下面咱們透過底層分別看一下這兩種類型的接口原理。感興趣的小伙伴們可以參考借鑒,希望對大家能有所幫助2022-10-10