golan參數(shù)校驗(yàn)Validator

更新時(shí)間：2022年01月25日 09:24:23 作者：Kevin_cai09

這篇文章主要介紹了golan參數(shù)校驗(yàn)Validator,validator包可以通過反射結(jié)構(gòu)體struct的tag進(jìn)行參數(shù)校驗(yàn),下面來看看文章的詳細(xì)介紹吧,需要的朋友也可以參考一下

開發(fā)接口的時(shí)候需要多前端提交的參數(shù)進(jìn)行參數(shù)校驗(yàn)，如果提交的參數(shù)只有一個(gè)兩個(gè)，這樣我們可以簡(jiǎn)單寫個(gè)if判斷，但是如果提交的參數(shù)比較多，通過if判斷就比較繁瑣了，在Go中有一個(gè)validator包可以通過反射結(jié)構(gòu)體struct的tag進(jìn)行參數(shù)校驗(yàn)

1.實(shí)踐

go get github.com/go-playground/validator/v10

定義結(jié)體：

type UserInfo struct {
 ID    int `validate:"gt=0"`
 Age   int `validate:"gt=0"`
 Name  string `validate:"required"`
 Sex   string `validate:"required"`
}

初始化結(jié)構(gòu)體并做參數(shù)校驗(yàn)：

func InitUserInfo(id,age int,name,sex string) *UserInfo {
 // new一個(gè)校驗(yàn)器
 valid := validator.New()
 // 初始化UserInfo
 userInfo := &UserInfo{
  ID: id,
  Age: age,
  Name:name,
  Sex:sex,
 }
 if err := valid.Struct(userInfo);err != nil {
  fmt.Println("參數(shù)校驗(yàn)不通過",err)
 }
 return userInfo
}

效果：

InitUserInfo(1,2,"kevin","男")// 參數(shù)校驗(yàn)通過
InitUserInfo(0,2,"kevin","男")// 參數(shù)校驗(yàn)不通過 Key: 'UserInfo.ID' Error:Field validation for 'ID' failed on the 'gt' tag
InitUserInfo(1,2,"kevin","")// 參數(shù)校驗(yàn)不通過 Key: 'UserInfo.Sex' Error:Field validation for 'Sex' failed on the 'required' tag

如參數(shù)校驗(yàn)不通過，err中會(huì)包含不通過字段信息

1.1校驗(yàn)標(biāo)簽

-：跳過該字段，不測(cè)驗(yàn)；
|：應(yīng)用多個(gè)束縛，只須要滿足其中一個(gè)，例如rgb|rgba；
required：字段必須設(shè)置，不能為默認(rèn)值；
omitempty：如果字段未設(shè)置，則疏忽它

1.2字符串約束

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；

1.3自定義校驗(yàn)器

在Gin中支持實(shí)現(xiàn)自定義校驗(yàn)標(biāo)簽

定義校驗(yàn)邏輯：

// sum不能大于10
func VerifySum(level validator.FieldLevel) bool {
 if sum,ok := level.Field().Interface().(int);ok{
  fmt.Println(sum)
  if sum > 10 {
   return false
  }
  return true
 }
 return false
}

注冊(cè)標(biāo)簽：

 // 注冊(cè)
 if v,ok := binding.Validator.Engine().(*validator.Validate); ok {
  if err := v.RegisterValidation("sum",VerifySum);err != nil{
   fmt.Println("參數(shù)校驗(yàn)標(biāo)簽注冊(cè)失敗")
  }
  fmt.Println("參數(shù)校驗(yàn)標(biāo)簽注冊(cè)成功")
 }

應(yīng)用標(biāo)簽到結(jié)構(gòu)體上:

type TestSum struct {
 Sum int `binding:"sum"`
}

測(cè)試：

func getSum(c *gin.Context) {
 var b TestSum
 b.Sum = cast.ToInt(c.Request.URL.Query().Get("sum"))
 // 數(shù)據(jù)模型綁定查詢字符串驗(yàn)證
 if err := c.ShouldBindWith(&b, binding.Query); err == nil {
  c.JSON(http.StatusOK, gin.H{"message": "prams are valid!"})
 } else {
  c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
 }
}

func main()  {
 route := gin.Default()
 // 注冊(cè)
 if v,ok := binding.Validator.Engine().(*validator.Validate); ok {
  if err := v.RegisterValidation("sum",VerifySum);err != nil{
   fmt.Println("參數(shù)校驗(yàn)標(biāo)簽注冊(cè)失敗")
  }
  fmt.Println("參數(shù)校驗(yàn)標(biāo)簽注冊(cè)成功")
 }
 route.GET("/getSum", getSum)
 route.Run(":8080")
}

附加：

Go中獲取標(biāo)簽值是通過反射進(jìn)行獲取的：

  type TestSum struct {
    Sum int `binding:"sum"`
  }
  // 獲取標(biāo)簽值：
 var b TestSum
 b_type := reflect.TypeOf(b)
 fmt.Println(b_type.Field(0).Tag.Get("binding"))

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

您可能感興趣的文章: