示例

/app/demo/index2 接口中有 参数校验示例，已支持中文错误提示

  1. func Index2(c *gin.Context) {
  2.     var (
  3.         req request_validator.Register
  4.     )
  6.     err := request.ParseRequest(c, &req)
  7.     if  err != nil {
  8.         helpers.ApiError(c, e.ParamError,err.Error())
  9.         return
  10.     }
  12.     helpers.ApiSuccess(c, req)
  13. }

request.ParseRequest(c, &req) 会把接口参数绑定到结构体 req 中
如果参数校验不通过 helpers.ApiError(c, e.ParamError,err.Error()) 会把错误输出给前端

req 结构体：

  1. type Register struct {
  2.     Mobile   uint   `form:"mobile" binding:"required,checkMobile"` //checkMobile自定义验证函数 request.checkMobile
  3.     Password string `form:"password" binding:"required,gte=6"`
  4.     Email    string `json:"email" binding:"required,email"`
  5. }

binding 中 是 校验参数 规则。校验规则有很多种

required 表示必填
email 必须是email格式
checkMobile 是 自定义的 校验方法。自定义的校验方法可以实现自己的校验规则，这里 实现 的 checkMobile 是正则匹配校验是否是手机号格式

更多校验规则

字符串类型字段规则

  • 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：字段必须设置，不能为默认值；

更多使用方法，请到官方文档自行学习。