使用 validator 以后，只需要在定義結(jié)構(gòu)體時(shí)使用 binding 或 validate tag標(biāo)識(shí)相關(guān)校驗(yàn)規(guī)則，就可以進(jìn)行參數(shù)校驗(yàn)了，而不用自己單獨(dú)去寫常見的校驗(yàn)規(guī)則。

main.go

package main
import (
	"fmt"
	"github.com/go-playground/validator/v10"
	"github.com/go-playground/locales/zh_Hans_CN"
	unTrans "github.com/go-playground/universal-translator"
	zhTrans "github.com/go-playground/validator/v10/translations/zh"
)
type User struct {
	Username string `validate:"min=6,max=10,contains=ook,startswith=He"`
	Age      uint8  `validate:"gte=1,lte=10"`
	Sex      string `validate:"oneof=female male"`
	Email    string `validate:"email"`
}
func main() {
	validate := validator.New()
	//user := User{Username: "Heooking", Age: 6, Sex: "male", Email: "test@qq.com"}
	user := User{Username: "Looking", Age: 26, Sex: "male", Email: "qq.com"}
	err := validate.Struct(user)
	// 默認(rèn)英文提示
	if err != nil {
		fmt.Println(err)
		//Key: 'User.Username' Error:Field validation for 'Username' failed on the 'startswith' tag
		//Key: 'User.Age' Error:Field validation for 'Age' failed on the 'lte' tag
		//Key: 'User.Email' Error:Field validation for 'Email' failed on the 'email' tag
	}
	fmt.Println()
	// 中文錯(cuò)誤提示
	uni := unTrans.New(zh_Hans_CN.New())
	trans, _ := uni.GetTranslator("zh_Hans_CN")
	zhTrans.RegisterDefaultTranslations(validate, trans)
	if err != nil {
		for _, v := range err.(validator.ValidationErrors) {
			fmt.Println(v.Translate(trans))
			//Username必須以文本'He'開頭
			//Age必須小于或等于10
			//Email必須是一個(gè)有效的郵箱
		}
	}
}

go.mod

module test
go 1.17
require (
	github.com/go-playground/validator/v10 v10.15.0
)
require (
	github.com/gabriel-vasile/mimetype v1.4.2 // indirect
	github.com/go-playground/locales v0.14.1 // indirect
	github.com/go-playground/universal-translator v0.18.1 // indirect
	github.com/leodido/go-urn v1.2.4 // indirect
	golang.org/x/crypto v0.7.0 // indirect
	golang.org/x/net v0.8.0 // indirect
	golang.org/x/sys v0.6.0 // indirect
)

常用約束如下：

字符串約束

• excludesall：不包含參數(shù)中任意的 UNICODE 字符，例如excludesall=ab；
• excludesrune：不包含參數(shù)表示的 rune 字符，excludesrune=asong；
• startswith：以參數(shù)子串為前綴，例如startswith=hi；
• endswith：以參數(shù)子串為后綴，例如endswith=bye。
• contains=：包含參數(shù)子串，例如contains=email；
• containsany：包含參數(shù)中任意的 UNICODE 字符，例如containsany=ab；
• containsrune：包含參數(shù)表示的 rune 字符，例如`containsrune=asong；
• excludes：不包含參數(shù)子串，例如excludes=email；

范圍約束

范圍約束的字段類型分為三種：

• 對(duì)于數(shù)值，我們則可以約束其值
• 對(duì)于切片、數(shù)組和map，我們則可以約束其長度
• 對(duì)于字符串，我們則可以約束其長度

常用 tag 介紹：

• ne：不等于參數(shù)值，例如 ne=5；
• gt：大于參數(shù)值，例如 gt=5；
• gte：大于等于參數(shù)值，例如 gte=50；
• lt：小于參數(shù)值，例如 lt=50；
• lte：小于等于參數(shù)值，例如 lte=50；
• oneof：只能是列舉出的值其中一個(gè)，這些值必須是數(shù)值或字符串，以空格分隔，如果字符串中有空格，將字符串用單引號(hào)包圍，例如 oneof=male female。
• eq：等于參數(shù)值，注意與 len不同。對(duì)于字符串， eq約束字符串本身的值，而 len約束字符串長度。例如 eq=10；
• len：等于參數(shù)值，例如 len=10；
• max：小于等于參數(shù)值，例如 max=10；
• min：大于等于參數(shù)值，例如 min=10
• Fields約束
• eqfield：定義字段間的相等約束，用于約束同一結(jié)構(gòu)體中的字段。例如： eqfield=Password
• eqcsfield：約束統(tǒng)一結(jié)構(gòu)體中字段等于另一個(gè)字段（相對(duì)），確認(rèn)密碼時(shí)可以使用，例如： eqfiel=ConfirmPassword
• nefield：用來約束兩個(gè)字段是否相同，確認(rèn)兩種顏色是否一致時(shí)可以使用，例如： nefield=Color1
• necsfield：約束兩個(gè)字段是否相同（相對(duì)）

常用約束

• unique：指定唯一性約束，不同類型處理不同：

對(duì)于map，unique約束沒有重復(fù)的值
        對(duì)于數(shù)組和切片，unique沒有重復(fù)的值
        對(duì)于元素類型為結(jié)構(gòu)體的碎片，unique約束結(jié)構(gòu)體對(duì)象的某個(gè)字段不重復(fù)，使用 unique=field指定字段名

• email：使用email來限制字段必須是郵件形式，直接寫eamil即可，無需加任何指定。
• omitempty：字段未設(shè)置，則忽略
• -：跳過該字段，不檢驗(yàn)；
• |：使用多個(gè)約束，只需要滿足其中一個(gè)，例如rgb|rgba；
• required：字段必須設(shè)置，不能為默認(rèn)值；

到此這篇關(guān)于Go的gin參數(shù)校驗(yàn)之validator庫的文章就介紹到這了,更多相關(guān)Go validator庫內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論