示例

  1. package main
  3. import (
  4.     "fmt"
  5.     "net/http"
  7.     "github.com/gin-gonic/gin"
  8. )
  10. type RegisterRequest struct {
  11.     Username string `json:"username" binding:"required"`
  12.     Nickname string `json:"nickname" binding:"required"`
  13.     Email    string `json:"email" binding:"required,email"`
  14.     Password string `json:"password" binding:"required"`
  15.     Age      uint8  `json:"age" binding:"gte=1,lte=120"`
  16. }
  18. func main() {
  19.     router := gin.Default()
  20.     router.POST("register", Register)
  21.     router.Run(":9999")
  22. }
  24. func Register(c *gin.Context) {
  25.     var r RegisterRequest
  26.     err := c.ShouldBindJSON(&r)
  27.     if err != nil {
  28.        ...
  29.         return
  30.     }
  31.     ...
  32. }

常用Tag

字符串约束

  • 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；

    范围约束

    范围约束的字段类型分为三种：

  • 对于数值，我们则可以约束其值

  • 对于切片、数组和map，我们则可以约束其长度
  • 对于字符串，我们则可以约束其长度

常用tag介绍：

  • ne：不等于参数值，例如ne=5；
  • gt：大于参数值，例如gt=5；
  • gte：大于等于参数值，例如gte=50；
  • lt：小于参数值，例如lt=50；
  • lte：小于等于参数值，例如lte=50；
  • oneof：只能是列举出的值其中一个，这些值必须是数值或字符串，以空格分隔，如果字符串中有空格，将字符串用单引号包围，例如oneof=male female。
  • eq：等于参数值，注意与len不同。对于字符串，eq约束字符串本身的值，而len约束字符串长度。例如eq=10；
  • len：等于参数值，例如len=10；
  • max：小于等于参数值，例如max=10；

  • min：大于等于参数值，例如min=10

    Fields约束

  • eqfield：定义字段间的相等约束，用于约束同一结构体中的字段。例如：eqfield=Password

  • eqcsfield：约束统一结构体中字段等于另一个字段（相对），确认密码时可以使用，例如：eqfiel=ConfirmPassword
  • nefield：用来约束两个字段是否相同，确认两种颜色是否一致时可以使用，例如：nefield=Color1

  • necsfield：约束两个字段是否相同（相对）

    常用约束

  • unique：指定唯一性约束，不同类型处理不同：

    • 对于map，unique约束没有重复的值
    • 对于数组和切片，unique没有重复的值
    • 对于元素类型为结构体的碎片，unique约束结构体对象的某个字段不重复，使用unique=field指定字段名
  • email：使用email来限制字段必须是邮件形式，直接写eamil即可，无需加任何指定。
  • omitempty：字段未设置，则忽略
  • -：跳过该字段，不检验；
  • |：使用多个约束，只需要满足其中一个，例如rgb|rgba；
  • required：字段必须设置，不能为默认值；

自定义Tag

  1. package main
  3. import (
  4.     "fmt"
  5.     "github.com/gin-gonic/gin"
  6.     "github.com/gin-gonic/gin/binding"
  7.     "github.com/go-playground/validator/v10"
  8. )
  10. type Params struct {
  11.     Name string `binding:"nameCheck"`
  12. }
  14. func main() {
  15.     r := gin.Default()
  17.     // 注册自定义tag
  18.     if v, ok := binding.Validator.Engine().(*validator.Validate); ok {
  19.         err := v.RegisterValidation("nameCheck", NameCheck)
  20.         if err != nil {
  21.             fmt.Println(err.Error())
  22.             return
  23.         }
  24.     }
  26.     r.POST("/", test)
  28.     r.Run(":8999")
  29. }
  31. func test(r *gin.Context) {
  32.     var p Params
  33.     if err := r.ShouldBindJSON(&p); err != nil {
  34.         ...
  35.     }
  36.     r.String(200, "ok")
  37. }
  39. // 自定义tag检查方法
  40. func NameCheck(f validator.FieldLevel) bool {
  41.     data := f.Field().String()
  42.     if data != "admin" {
  43.         return false
  44.     }
  45.     return true
  46. }

参考

学会gin框架的参数验证之validator库，看这一篇就够用了
validator package - github.com/go-playground/validator/v10 - Go Packages