gvalid模块实现了非常强大的数据校验功能，内置了40种常用的校验规则，支持单数据多规则校验、多数据多规则批量校验、自定义错误信息、自定义正则校验、自定义校验规则注册、支持struct tag规则及提示信息绑定等特性，是目前功能最强大的Go数据校验模块。

数据校验设计的灵感来源于经典的PHP Laravel框架 https://laravel.com/docs/8.x/validation 感谢Laravel ❤️

使用方式：

import "github.com/gogf/gf/util/gvalid"

接口文档：

https://godoc.org/github.com/gogf/gf/util/gvalid

校验规则：

内置40种常用的校验规则：

required             格式：required                              说明：必需参数
required-if          格式：required-if:field,value,...           说明：必需参数(当任意所给定字段值与所给值相等时，即：当field字段的值为value时，当前验证字段为必须参数)
required-unless      格式：required-unless:field,value,...       说明：必需参数(当所给定字段值与所给值都不相等时，即：当field字段的值不为value时，当前验证字段为必须参数)
required-with        格式：required-with:field1,field2,...       说明：必需参数(当所给定任意字段值不为空时)
required-with-all    格式：required-with-all:field1,field2,...   说明：必须参数(当所给定所有字段值都不为空时)
required-without     格式：required-without:field1,field2,...    说明：必需参数(当所给定任意字段值为空时)
required-without-all 格式：required-without-all:field1,field2,...说明：必须参数(当所给定所有字段值都为空时)
date                 格式：date                                  说明：参数为常用日期类型，格式：2006-01-02, 20060102, 2006.01.02
date-format          格式：date-format:format                    说明：判断日期是否为指定的日期格式，format为Go日期格式(可以包含时间)
email                格式：email                                 说明：EMAIL邮箱地址
phone                格式：phone                                 说明：手机号
phone-loose          格式：phone                                 说明：手机号，只要满足 13、14、15、16、17、18、19开头的11位数字都可以通过验证
telephone            格式：telephone                             说明：国内座机电话号码，"XXXX-XXXXXXX"、"XXXX-XXXXXXXX"、"XXX-XXXXXXX"、"XXX-XXXXXXXX"、"XXXXXXX"、"XXXXXXXX"
passport             格式：passport                              说明：通用帐号规则(字母开头，只能包含字母、数字和下划线，长度在6~18之间)
password             格式：password                              说明：通用密码(任意可见字符，长度在6~18之间)
password2            格式：password2                             说明：中等强度密码(在弱密码的基础上，必须包含大小写字母和数字)
password3            格式：password3                             说明：强等强度密码(在弱密码的基础上，必须包含大小写字母、数字和特殊字符)
postcode             格式：postcode                              说明：中国邮政编码
resident-id          格式：resident-id                           说明：公民身份证号码
bank-card            格式：bank-card                             说明：银行号验证
qq                   格式：qq                                    说明：腾讯QQ号码
ip                   格式：ip                                    说明：IPv4/IPv6地址
ipv4                 格式：ipv4                                  说明：IPv4地址
ipv6                 格式：ipv6                                  说明：IPv6地址
mac                  格式：mac                                   说明：MAC地址
url                  格式：url                                   说明：URL
domain               格式：domain                                说明：域名
length               格式：length:min,max                        说明：参数长度为min到max(长度参数为整形)，注意中文一个汉字占3字节
min-length           格式：min-length:min                        说明：参数长度最小为min(长度参数为整形)，注意中文一个汉字占3字节
max-length           格式：max-length:max                        说明：参数长度最大为max(长度参数为整形)，注意中文一个汉字占3字节
between              格式：between:min,max                       说明：参数大小为min到max(支持整形和浮点类型参数)
min                  格式：min:min                               说明：参数最小为min(支持整形和浮点类型参数)
max                  格式：max:max                               说明：参数最大为max(支持整形和浮点类型参数)
json                 格式：json                                  说明：判断数据格式为JSON
integer              格式：integer                               说明：整数
float                格式：float                                 说明：浮点数
boolean              格式：boolean                               说明：布尔值(1,true,on,yes:true | 0,false,off,no,"":false)
same                 格式：same:field                            说明：参数值必需与field参数的值相同
different            格式：different:field                       说明：参数值不能与field参数的值相同
in                   格式：in:value1,value2,...                  说明：参数值应该在value1,value2,...中(字符串匹配)
not-in               格式：not-in:value1,value2,...              说明：参数值不应该在value1,value2,...中(字符串匹配)
regex                格式：regex:pattern                         说明：参数值应当满足正则匹配规则pattern

required

  • 格式: required
  • 说明：必需参数

required-if

  • 格式: required-if:field,value,...
  • 说明：必需参数(当任意所给定字段值与所给值相等时，即：当field字段的值为value时，当前验证字段为必须参数)

required-unless

  • 格式: required-unless:field,value,...
  • 说明：必需参数(当所给定字段值与所给值都不相等时，即：当field字段的值不为value时，当前验证字段为必须参数)

required-with

  • 格式: required-with:field1,field2,...
  • 说明：必需参数(当所给定任意字段值不为空时)

required-with-all

  • 格式: required-with-all:field1,field2,...
  • 说明：必须参数(当所给定所有字段值都不为空时)

required-without

  • 格式: required-without:field1,field2,...
  • 说明：必需参数(当所给定任意字段值为空时)

required-without-all

  • 格式: required-without-all:field1,field2,...
  • 说明：必须参数(当所给定所有字段值都为空时)

date

  • 格式: date
  • 说明：参数为常用日期类型，日期之间支持的连接符号-或/或.，也支持不带连接符号的8位长度日期，格式如： 2006-01-02, 2006/01/02, 2006.01.02, 20060102, 01-Nov-2018, 01.Nov.018, 01/Nov/2018

date-format

  • 格式: date-format:format
  • 说明：判断日期是否为指定的日期格式，format参数格式为gtime日期格式(可以包含日期及时间)，格式说明参考【gtime模块】章节。

email

  • 格式: email
  • 说明：EMAIL邮箱地址

phone

  • 格式: phone
  • 说明：手机号

phone-loose

  • 格式: phone
  • 说明：宽松的手机号验证，只要满足 13、14、15、16、17、18、19开头的11位数字都可以通过验证。

telephone

  • 格式: telephone
  • 说明：国内座机电话号码，”XXXX-XXXXXXX”、”XXXX-XXXXXXXX”、”XXX-XXXXXXX”、”XXX-XXXXXXXX”、”XXXXXXX”、”XXXXXXXX”

passport

  • 格式: passport
  • 说明：通用帐号规则(字母开头，只能包含字母、数字和下划线，长度在6~18之间)

password

  • 格式: password
  • 说明：通用密码(任意可见字符，长度在6~18之间)

password2

  • 格式: password2
  • 说明：中等强度密码(在弱密码的基础上，必须包含大小写字母和数字)

password3

  • 格式: password3
  • 说明：强等强度密码(在弱密码的基础上，必须包含大小写字母、数字和特殊字符)

postcode

  • 格式: postcode
  • 说明：中国邮政编码

resident-id

  • 格式:  resident-id
  • 说明：公民身份证号码

bank-card

  • 格式:   bank-card
  • 说明：银行卡号校验

qq

  • 格式: qq
  • 说明：腾讯QQ号码

ip

  • 格式: ip
  • 说明：IPv4/IPv6地址

ipv4

  • 格式: ipv4
  • 说明：IPv4地址

ipv6

  • 格式: ipv6
  • 说明：IPv6地址

mac

  • 格式: mac
  • 说明：MAC地址

url

  • 格式: url
  • 说明：URL

domain

  • 格式: domain
  • 说明：域名

length

  • 格式: length:min,max
  • 说明：参数长度为min到max(长度参数为整形)，注意中文一个汉字占3字节

min-length

  • 格式: min-length:min
  • 说明：参数长度最小为min(长度参数为整形)，注意中文一个汉字占3字节

max-length

  • 格式: max-length:max
  • 说明：参数长度最大为max(长度参数为整形)，注意中文一个汉字占3字节

between

  • 格式: between:min,max
  • 说明：参数大小为min到max(支持整形和浮点类型参数)

min

  • 格式: min:min
  • 说明：参数大小最小为min(支持整形和浮点类型参数)

max

  • 格式: max:max
  • 说明：参数大小最大为max(支持整形和浮点类型参数)

json

  • 格式: json
  • 说明：判断数据格式为JSON

integer

  • 格式: integer
  • 说明：整数

float

  • 格式: float
  • 说明：浮点数

boolean

  • 格式: boolean
  • 说明：布尔值(1,true,on,yes为true | 0,false,off,no,""为false)

same

  • 格式: same:field
  • 说明：参数值必需与field参数的值相同

different

  • 格式: different:field
  • 说明：参数值不能与field参数的值相同

in

  • 格式: in:value1,value2,...
  • 说明：参数值应该在value1,value2,...中(字符串匹配)

not-in

  • 格式: not-in:value1,value2,...
  • 说明：参数值不应该在value1,value2,...中(字符串匹配)

regex

  • 格式: regex:pattern
  • 说明：参数值应当满足正则匹配规则pattern
Content Menu

  • No labels

18 Comments

  1. 郭强

    刘洋 

    int 类型的数据怎么判断为空，int默认为0

    你可以使用min规则，不一定要使用required规则。如果是结构体属性的校验，请参考 数据校验-结构体校验 章节。

    1. linhaijian

      required规则可以用min来代替，那required-if怎么办呢？

      1. 郭强

        目前可以使用指针属性替代，后续会改进一下请求参数的校验处理。

  2. 糖水不加糖

    phone-loose手机号宽松验证格式加进来方便查找.

  3. 朱文永

    Addtime *gtime.Time `v:"required|date#时间不能为空|时间格式错误"`

    date校验会报如下错误:
    runtime error: invalid memory address or nil pointer dereference

    其他的校验 email phone 等都正常

  4. xx

    required-without和required-without-all根本用不了，也没例子，测试过了吗？

    1. xx

      type UserApiSearch struct {
    Uid       int64       `json:"uid"`                                  // 用户ID
    Nickname  string      `json:"nickname" v:"required-with:Uid"`       // 昵称
    StartTime *gtime.Time `json:"start_time" v:"required-with:EndTime"` // 开始时间
    EndTime   *gtime.Time `json:"end_time" v:"required-with:StartTime"` // 结束时间
}

      Nickname的required-with也不行。

      1. 郭强

        这个是因为*gtime.Time类型在required-with规则下会失效，你试试最新的master分支。

  5. 贾君宇

    能否加一个终止校验的标志，像laravel一样，出现err就停止下一个检测

    1. 郭强

      你可以提个issue记录下。

  6. lufee

    int类型的时候 会把0和空转为1。。。这怎么整，用min也不管用

    1. 郭强

      先自己研究下，不行的话把代码提issue

  7. xx

    限制最小值和最大值不能一起使用的吗？我像这样用最小值起作用，但最大值不起作用

    Amount          float64 `v:"min:1#Payment Amount must greater than 0|max:2147483647#Amount too big"` 

    1. 海亮

      between

      1. xx

        谢谢

    2. 郭强

      哥们你格式写错了，你看下文档上的例子：数据校验-结构体校验

  8. ctforcp

    【regex防坑示例】 记得转义反斜杠 如 [a-z_\\d] 不要直接写成 [a-z_\d] 不然这个字段所有其它规则都会失效

    type requestData struct {
        Table interface{} `v:"table@required|length:1,30|regex:^[a-z_][a-z_\\d]*$#请输入表名|表名长度为:min到:max位|表名限非数字开头的小写字母、下划和数字组成"`
    }

  9. sss

    type Child struct {
    Field1 string `json:"field1" v:"required-if:source,1"`
    Field2 string `json:"field2" v:"required-if:source,2"`
}

type Parent struct {
    Source uint `json:"source" v:"required|in:1,2"`
    Child Child `json:"child"`
}

    请问 Child  里的校验如何能关联到 Parent 的 source  字段呢？ 郭强