golan参数校验Validator

 更新时间:2022年01月25日 09:24:23   作者:Kevin_cai09  
这篇文章主要介绍了golan参数校验Validator,validator包可以通过反射结构体struct的tag进行参数校验,下面来看看文章的详细介绍吧,需要的朋友也可以参考一下

前言:

开发接口的时候需要多前端提交的参数进行参数校验,如果提交的参数只有一个两个,这样我们可以简单写个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:如果字段未设置,则疏忽它

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内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Golang开发中常用的代码片段汇总

    Golang开发中常用的代码片段汇总

    这篇文章主要给大家汇总了在Golang开发中常用的代码片段,这些代码片段都是在日常工作中编写golang应用时使用到,需要的朋友可以参考借鉴,下面跟着小编一起来学习学习吧。
    2017-07-07
  • Go语言字符串操作指南:简单易懂的实战技巧

    Go语言字符串操作指南:简单易懂的实战技巧

    本文将介绍Go语言中字符串的实战操作,通过本文的学习,读者将掌握Go语言中字符串的常用操作,为实际开发提供帮助,需要的朋友可以参考下
    2023-10-10
  • 使用Go语言实现谷歌翻译功能

    使用Go语言实现谷歌翻译功能

    这篇文章主要为大家详细介绍了如何使用Go语言实现谷歌翻译功能,文中的示例代码讲解详细,具有一定的借鉴价值,有需要的小伙伴可以参考下
    2024-02-02
  • Go语言操作mysql数据库简单例子

    Go语言操作mysql数据库简单例子

    这篇文章主要介绍了Go语言操作mysql数据库简单例子,本文包含插入数据和查询代码实例,需要的朋友可以参考下
    2014-10-10
  • Golang 正则匹配效率详解

    Golang 正则匹配效率详解

    这篇文章主要介绍了Golang 正则匹配效率详解,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-04-04
  • Golang Http请求返回结果处理

    Golang Http请求返回结果处理

    本文主要介绍了Golang Http请求返回结果处理,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-08-08
  • Go语言实现栈与队列基本操作学家

    Go语言实现栈与队列基本操作学家

    go语言中,并没有栈与队列相关的数据结构,但是我们可以借助切片来实现栈与队列的操作;接下来我们一起实现栈与队列基本操作,感兴趣的可以了解一下
    2022-11-11
  • Go语言kube-scheduler深度剖析开发之scheduler初始化

    Go语言kube-scheduler深度剖析开发之scheduler初始化

    这篇文章主要介绍了Go语言kube-scheduler深度剖析开发之scheduler初始化实现过程示例,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-04-04
  • GoFrame基于性能测试得知grpool使用场景

    GoFrame基于性能测试得知grpool使用场景

    这篇文章主要为大家介绍了GoFrame基于性能测试得知grpool使用场景示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-06-06
  • 一文详解Go语言io包中的discard类型

    一文详解Go语言io包中的discard类型

    这篇文章主要介绍了Go语言io包中的discard类型示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-07-07

最新评论