Go 每日一庫之 validator
簡介
今天咱們來介紹一個很是實用的庫——validator。validator用於對數據進行校驗。在 Web 開發中，對用戶傳過來的數據咱們都須要進行嚴格校驗，防止用戶的惡意請求。例如日期格式，用戶年齡，性別等必須是正常的值，不能隨意設置。git
快速使用
先安裝：github
$ go get gopkg.in/go-playground/validator.v10
後使用：golang
package main
import (
"fmt"
"gopkg.in/go-playground/validator.v10"
)
type User struct {
Name string `validate:"min=6,max=10"`
Age int `validate:"min=1,max=100"`
}
func main() {
validate := validator.New()
u1 := User{Name: "lidajun", Age: 18}
err := validate.Struct(u1)
fmt.Println(err)
u2 := User{Name: "dj", Age: 101}
err = validate.Struct(u2)
fmt.Println(err)
}
validator在結構體標籤（struct tag）中定義字段的約束。使用validator驗證數據以前，咱們須要調用validator.New()建立一個驗證器，這個驗證器能夠指定選項、添加自定義約束，而後經過調用它的Struct()方法來驗證各類結構對象的字段是否符合定義的約束。數組
在上面代碼中，咱們定義了一個結構體User，User有名稱Name字段和年齡Age字段。經過min和max約束，咱們設置Name的字符串長度爲[6,10]之間，Age的範圍爲[1,100]。微信
第一個對象Name和Age字段都知足約束，故Struct()方法返回nil錯誤。第二個對象的Name字段值爲dj，長度 2，小於最小值min，Age字段值爲 101，大於最大值max，故返回錯誤：函數
<nil> Key: 'User.Name' Error:Field validation for 'Name' failed on the 'min' tag Key: 'User.Age' Error:Field validation for 'Age' failed on the 'max' tag
錯誤信息比較好理解，User.Name違反了min約束，User.Age違反了max約束，一眼就能看出問題所在。學習
注意：ui
-
validator已經更新迭代了不少版本，當前最新的版本是v10，各個版本之間有一些差別，你們平時在使用和閱讀代碼時要注意區分。我這裏使用最新的版本v10做爲演示版本； - 字符串長度和數值的範圍均可以經過
min和max來約束。
約束
validator提供了很是豐富的約束可供使用，下面依次來介紹。編碼
範圍約束
咱們上面已經看到了使用min和max來約束字符串的長度或數值的範圍，下面再介紹其它的範圍約束。範圍約束的字段類型有如下幾種：spa
- 對於數值，則約束其值；
- 對於字符串，則約束其長度；
- 對於切片、數組和
map，則約束其長度。
下面如未特殊說明，則是根據上面各個類型對應的值與參數值比較。
-
len：等於參數值，例如len=10； -
max：小於等於參數值，例如max=10； -
min：大於等於參數值，例如min=10； -
eq：等於參數值，注意與len不一樣。對於字符串，eq約束字符串自己的值，而len約束字符串長度。例如eq=10； -
ne：不等於參數值，例如ne=10； -
gt：大於參數值，例如gt=10； -
gte：大於等於參數值，例如gte=10； -
lt：小於參數值，例如lt=10； -
lte：小於等於參數值，例如lte=10； -
oneof：只能是列舉出的值其中一個，這些值必須是數值或字符串，以空格分隔，若是字符串中有空格，將字符串用單引號包圍，例如oneof=red green。
大部分仍是比較直觀的，咱們經過一個例子看看其中幾個約束如何使用：
type User struct {
Name string `validate:"ne=admin"`
Age int `validate:"gte=18"`
Sex string `validate:"oneof=male female"`
RegTime time.Time `validate:"lte"`
}
func main() {
validate := validator.New()
u1 := User{Name: "dj", Age: 18, Sex: "male", RegTime: time.Now().UTC()}
err := validate.Struct(u1)
if err != nil {
fmt.Println(err)
}
u2 := User{Name: "admin", Age: 15, Sex: "none", RegTime: time.Now().UTC().Add(1 * time.Hour)}
err = validate.Struct(u2)
if err != nil {
fmt.Println(err)
}
}
上面例子中，咱們定義了User對象，爲它的 4 個字段分別設置了約束：
-
Name：字符串不能是admin； -
Age：必須大於等於 18，未成年人禁止入內； -
Sex：性別必須是male和female其中一個； -
RegTime：註冊時間必須小於當前的 UTC 時間，注意若是字段類型是time.Time，使用gt/gte/lt/lte等約束時不用指定參數值，默認與當前的 UTC 時間比較。
一樣地，第一個對象的字段都是合法的，校驗經過。第二個對象的 4 個字段都非法，經過輸出信息很好定錯誤位置：
Key: 'User.Name' Error:Field validation for 'Name' failed on the 'ne' tag Key: 'User.Age' Error:Field validation for 'Age' failed on the 'gte' tag Key: 'User.Sex' Error:Field validation for 'Sex' failed on the 'oneof' tag Key: 'User.RegTime' Error:Field validation for 'RegTime' failed on the 'lte' tag
跨字段約束
validator容許定義跨字段的約束，即該字段與其餘字段之間的關係。這種約束實際上分爲兩種，一種是參數字段就是同一個結構中的平級字段，另外一種是參數字段爲結構中其餘字段的字段。約束語法很簡單，要想使用上面的約束語義，只須要稍微修改一下。例如相等約束（eq），若是是約束同一個結構中的字段，則在後面添加一個field，使用eqfield定義字段間的相等約束。若是是更深層次的字段，在field以前還須要加上cs（能夠理解爲cross-struct），eq就變爲eqcsfield。它們的參數值都是須要比較的字段名，內層的還須要加上字段的類型：
eqfield=ConfirmPassword eqcsfield=InnerStructField.Field
看示例：
type RegisterForm struct {
Name string `validate:"min=2"`
Age int `validate:"min=18"`
Password string `validate:"min=10"`
Password2 string `validate:"eqfield=Password"`
}
func main() {
validate := validator.New()
f1 := RegisterForm{
Name: "dj",
Age: 18,
Password: "1234567890",
Password2: "1234567890",
}
err := validate.Struct(f1)
if err != nil {
fmt.Println(err)
}
f2 := RegisterForm{
Name: "dj",
Age: 18,
Password: "1234567890",
Password2: "123",
}
err = validate.Struct(f2)
if err != nil {
fmt.Println(err)
}
}
咱們定義了一個簡單的註冊表單結構，使用eqfield約束其兩次輸入的密碼必須相等。第一個對象知足約束，第二個對象兩次密碼明顯不等。程序輸出：
Key: 'RegisterForm.Password2' Error:Field validation for 'Password2' failed on the 'eqfield' tag
字符串
validator中關於字符串的約束有不少，這裏介紹幾個：
-
contains=：包含參數子串，例如contains=email； -
containsany：包含參數中任意的 UNICODE 字符，例如containsany=abcd； -
containsrune：包含參數表示的 rune 字符，例如containsrune=☻； -
excludes：不包含參數子串，例如excludes=email； -
excludesall：不包含參數中任意的 UNICODE 字符，例如excludesall=abcd； -
excludesrune：不包含參數表示的 rune 字符，excludesrune=☻； -
startswith：以參數子串爲前綴，例如startswith=hello； -
endswith：以參數子串爲後綴，例如endswith=bye。
看示例：
type User struct {
Name string `validate:"containsrune=☻"`
Age int `validate:"min=18"`
}
func main() {
validate := validator.New()
u1 := User{"d☻j", 18}
err := validate.Struct(u1)
if err != nil {
fmt.Println(err)
}
u2 := User{"dj", 18}
err = validate.Struct(u2)
if err != nil {
fmt.Println(err)
}
}
限制Name字段必須包含 UNICODE 字符☻。
惟一性
使用unqiue來指定惟一性約束，對不一樣類型的處理以下：
- 對於數組和切片，
unique約束沒有重複的元素； - 對於
map，unique約束沒有重複的值； - 對於元素類型爲結構體的切片，
unique約束結構體對象的某個字段不重複，經過unqiue=field指定這個字段名。
例如：
type User struct {
Name string `validate:"min=2"`
Age int `validate:"min=18"`
Hobbies []string `validate:"unique"`
Friends []User `validate:"unique=Name"`
}
func main() {
validate := validator.New()
f1 := User{
Name: "dj2",
Age: 18,
}
f2 := User{
Name: "dj3",
Age: 18,
}
u1 := User{
Name: "dj",
Age: 18,
Hobbies: []string{"pingpong", "chess", "programming"},
Friends: []User{f1, f2},
}
err := validate.Struct(u1)
if err != nil {
fmt.Println(err)
}
u2 := User{
Name: "dj",
Age: 18,
Hobbies: []string{"programming", "programming"},
Friends: []User{f1, f1},
}
err = validate.Struct(u2)
if err != nil {
fmt.Println(err)
}
}
咱們限制愛好Hobbies中不能有重複元素，好友Friends的各個元素不能有一樣的名字Name。第一個對象知足約束，第二個對象的Hobbies字段包含了重複的"programming"，Friends字段中兩個元素的Name字段都是dj2。程序輸出：
Key: 'User.Hobbies' Error:Field validation for 'Hobbies' failed on the 'unique' tag Key: 'User.Friends' Error:Field validation for 'Friends' failed on the 'unique' tag
郵件
經過email限制字段必須是郵件格式：
type User struct {
Name string `validate:"min=2"`
Age int `validate:"min=18"`
Email string `validate:"email"`
}
func main() {
validate := validator.New()
u1 := User{
Name: "dj",
Age: 18,
Email: "dj@example.com",
}
err := validate.Struct(u1)
if err != nil {
fmt.Println(err)
}
u2 := User{
Name: "dj",
Age: 18,
Email: "djexample.com",
}
err = validate.Struct(u2)
if err != nil {
fmt.Println(err)
}
}
上面咱們約束Email字段必須是郵件的格式，第一個對象知足約束，第二個對象不知足，程序輸出：
Key: 'User.Email' Error:Field validation for 'Email' failed on the 'email' tag
特殊
有一些比較特殊的約束：
-
-：跳過該字段，不檢驗； -
|：使用多個約束，只須要知足其中一個，例如rgb|rgba； -
required：字段必須設置，不能爲默認值； -
omitempty：若是字段未設置，則忽略它。
其餘
validator提供了大量的、各個方面的、豐富的約束，如ASCII/UNICODE字母、數字、十六進制、十六進制顏色值、大小寫、RBG 顏色值，HSL 顏色值、HSLA 顏色值、JSON 格式、文件路徑、URL、base64 編碼串、ip 地址、ipv四、ipv六、UUID、經緯度等等等等等等等等等等等。限於篇幅這裏就不一一介紹了。感興趣自行去文檔中挖掘。
VarWithValue方法
在一些很簡單的狀況下，咱們僅僅想對兩個變量進行比較，若是每次都要先定義結構和tag就太繁瑣了。validator提供了VarWithValue()方法，咱們只須要傳入要驗證的兩個變量和約束便可
func main() {
name1 := "dj"
name2 := "dj2"
validate := validator.New()
fmt.Println(validate.VarWithValue(name1, name2, "eqfield"))
fmt.Println(validate.VarWithValue(name1, name2, "nefield"))
}
自定義約束
除了使用validator提供的約束外，還能夠定義本身的約束。例如如今有個奇葩的需求，產品同窗要求用戶必須使用迴文串做爲用戶名，咱們能夠自定義這個約束：
type RegisterForm struct {
Name string `validate:"palindrome"`
Age int `validate:"min=18"`
}
func reverseString(s string) string {
runes := []rune(s)
for from, to := 0, len(runes)-1; from < to; from, to = from+1, to-1 {
runes[from], runes[to] = runes[to], runes[from]
}
return string(runes)
}
func CheckPalindrome(fl validator.FieldLevel) bool {
value := fl.Field().String()
return value == reverseString(value)
}
func main() {
validate := validator.New()
validate.RegisterValidation("palindrome", CheckPalindrome)
f1 := RegisterForm{
Name: "djd",
Age: 18,
}
err := validate.Struct(f1)
if err != nil {
fmt.Println(err)
}
f2 := RegisterForm{
Name: "dj",
Age: 18,
}
err = validate.Struct(f2)
if err != nil {
fmt.Println(err)
}
}
首先定義一個類型爲func (validator.FieldLevel) bool的函數檢查約束是否知足，能夠經過FieldLevel取出要檢查的字段的信息。而後，調用驗證器的RegisterValidation()方法將該約束註冊到指定的名字上。最後咱們就能夠在結構體中使用該約束。上面程序中，第二個對象不知足約束palindrome，輸出：
Key: 'RegisterForm.Name' Error:Field validation for 'Name' failed on the 'palindrome' tag
錯誤處理
在上面的例子中，校驗失敗時咱們僅僅只是輸出返回的錯誤。其實，咱們能夠進行更精準的處理。validator返回的錯誤實際上只有兩種，一種是參數錯誤，一種是校驗錯誤。參數錯誤時，返回InvalidValidationError類型；校驗錯誤時返回ValidationErrors，它們都實現了error接口。並且ValidationErrors是一個錯誤切片，它保存了每一個字段違反的每一個約束信息：
// src/gopkg.in/validator.v10/errors.go
type InvalidValidationError struct {
Type reflect.Type
}
// Error returns InvalidValidationError message
func (e *InvalidValidationError) Error() string {
if e.Type == nil {
return "validator: (nil)"
}
return "validator: (nil " + e.Type.String() + ")"
}
type ValidationErrors []FieldError
func (ve ValidationErrors) Error() string {
buff := bytes.NewBufferString("")
var fe *fieldError
for i := 0; i < len(ve); i++ {
fe = ve[i].(*fieldError)
buff.WriteString(fe.Error())
buff.WriteString("\n")
}
return strings.TrimSpace(buff.String())
}
因此validator校驗返回的結果只有 3 種狀況：
-
nil：沒有錯誤； -
InvalidValidationError：輸入參數錯誤； -
ValidationErrors：字段違反約束。
咱們能夠在程序中判斷err != nil時，依次將err轉換爲InvalidValidationError和ValidationErrors以獲取更詳細的信息：
func processErr(err error) {
if err == nil {
return
}
invalid, ok := err.(*validator.InvalidValidationError)
if ok {
fmt.Println("param error:", invalid)
return
}
validationErrs := err.(validator.ValidationErrors)
for _, validationErr := range validationErrs {
fmt.Println(validationErr)
}
}
func main() {
validate := validator.New()
err := validate.Struct(1)
processErr(err)
err = validate.VarWithValue(1, 2, "eqfield")
processErr(err)
}
總結
validator功能很是豐富，使用較爲簡單方便。本文介紹的約束只是其中的冰山一角。它的應用很是普遍，建議瞭解一下。
你們若是發現好玩、好用的 Go 語言庫，歡迎到 Go 每日一庫 GitHub 上提交 issue😄
參考
- validator GitHub：https://github.com/go-playground/validator
- Go 每日一庫 GitHub：https://github.com/darjun/go-daily-lib
我
歡迎關注個人微信公衆號【GoUpUp】，共同窗習，一塊兒進步~
- 1. Go 每日一庫之 validator
- 2. Go 每日一庫之 watermill
- 3. Go 每日一庫之 nutsdb
- 4. Go 每日一庫之 viper
- 5. Go 每日一庫之 zerolog
- 6. Go 每日一庫之 cron
- 7. Go 每日一庫之 sqlc
- 8. Go 每日一庫之 gentleman
- 9. Go 每日一庫之 gojsonq
- 10. Go 每日一庫之 plot
- 更多相關文章...
- • SQLite 日期 & 時間 - SQLite教程
- • 一對一關聯查詢 - MyBatis教程
- • RxJava操作符（一）Creating Observables
- • Kotlin學習（一）基本語法
-
每一个你不满意的现在，都有一个你没有努力的曾经。
- 1. Go 每日一庫之 validator
- 2. Go 每日一庫之 watermill
- 3. Go 每日一庫之 nutsdb
- 4. Go 每日一庫之 viper
- 5. Go 每日一庫之 zerolog
- 6. Go 每日一庫之 cron
- 7. Go 每日一庫之 sqlc
- 8. Go 每日一庫之 gentleman
- 9. Go 每日一庫之 gojsonq
- 10. Go 每日一庫之 plot