golan参数校验Validator

前言:

开发接口的时候需要多前端提交的参数进行参数校验,如果提交的参数只有一个两个,这样我们可以简单写个if判断,但是如果提交的参数比较多,通过if判断就比较繁琐了,在Go中有一个validator包可以通过反射结构体structtag进行参数校验

1.实践

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

定义结体:

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

初始化结构体并做参数校验:

func InitUserInfo(id,age int,name,sex string) *UserInfo {
 // new一个校验器
 valid := validator.New()
 // 初始化UserInfo
 userInfo := &UserInfo{
  ID: id,
  Age: age,
  Name:name,
  Sex:sex,
 }
 if err := valid.Struct(userInfo);err != nil {
  fmt.Println("参数校验不通过",err)
 }
 return userInfo
}

效果:

InitUserInfo(1,2,"kevin","男")// 参数校验通过
InitUserInfo(0,2,"kevin","男")// 参数校验不通过 Key: "UserInfo.ID" Error:Field validation for "ID" failed on the "gt" tag
InitUserInfo(1,2,"kevin","")// 参数校验不通过 Key: "UserInfo.Sex" Error:Field validation for "Sex" failed on the "required" tag

如参数校验不通过,err中会包含不通过字段信息

1.1校验标签

-:跳过该字段,不测验;
|:应用多个束缚,只须要满足其中一个,例如rgb|rgba;
required:字段必须设置,不能为默认值;
omitempty:如果字段未设置,则疏忽它

image-20211119223655095

1.2字符串约束

  • excludesall:不包含参数中任意的 UNICODE 字符,例如excludesall=ab
  • excludesrune:不包含参数表示的 rune 字符,excludesrune=asong
  • startswith:以参数子串为前缀,例如startswith=hi
  • endswith:以参数子串为后缀,例如endswith=bye
  • contains= :包含参数子串,例如contains=email
  • containsany:包含参数中任意的 UNICODE 字符,例如containsany=ab
  • containsrune:包含参数表示的 rune 字符,例如`containsrune=asong
  • excludes:不包含参数子串,例如excludes=email

1.3自定义校验器

在Gin中支持实现自定义校验标签

定义校验逻辑:

// 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
}

注册标签:

 // 注册
 if v,ok := binding.Validator.Engine().(*validator.Validate); ok {
  if err := v.RegisterValidation("sum",VerifySum);err != nil{
   fmt.Println("参数校验标签注册失败")
  }
  fmt.Println("参数校验标签注册成功")
 }

应用标签到结构体上:

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

测试:

func getSum(c *gin.Context) {
 var b TestSum
 b.Sum = cast.ToInt(c.Request.URL.Query().Get("sum"))
 // 数据模型绑定查询字符串验证
 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()
 // 注册
 if v,ok := binding.Validator.Engine().(*validator.Validate); ok {
  if err := v.RegisterValidation("sum",VerifySum);err != nil{
   fmt.Println("参数校验标签注册失败")
  }
  fmt.Println("参数校验标签注册成功")
 }
 route.GET("/getSum", getSum)
 route.Run(":8080")
}

附加:

Go中获取标签值是通过反射进行获取的:

  type TestSum struct {
    Sum int `binding:"sum"`
  }
  // 获取标签值:
 var b TestSum
 b_type := reflect.TypeOf(b)
 fmt.Println(b_type.Field(0).Tag.Get("binding"))

到此这篇关于golan参数校验Validator的文章就介绍到这了,更多相关go参数校验Validator内容请搜索云海天教程以前的文章或继续浏览下面的相关文章希望大家以后多多支持云海天教程!