Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

goframe框架提供了功能强大、使用便捷、灵活易扩展的数据/表单校验组件,由gvalid模块实现。gvalid模块实现了非常强大的数据校验功能,内置了40种常用的校验规则,支持单数据多规则校验、多数据多规则批量校验、自定义错误信息、自定义正则校验、自定义校验规则注册、支持struct tag规则及提示信息绑定等特性,是目前功能最强大的Go数据校验模块。

Tip

数据校验设计的灵感来源于经典的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种常用的校验规则。40种左右常用的校验规则。

Note

校验规则涉及到联合校验的场景时,规则中关联的参数名称会自动按照不区分大小写且忽略特殊字符的形式进行智能匹配。


Code Block
languagexml
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
  • 说明:参数长度minmax(长度参数为整形),注意中文一个汉字占3字节

min-length

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

max-length

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

between

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

min

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

max

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

json

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

integer

  • 格式: integer
  • 说明:整数

float

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

boolean

  • 格式: boolean
  • 说明:布尔值(1,true,on,yestrue | 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


Panel
titleContent Menu

Table of Contents