Page History

框架校验组件内置了40+左右常用的校验规则。

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

Code Block

language	xml

required             格式：required                              说明：必需参数，除了支持常见的字符串，也支持Slice/Map类型
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
datetime             格式: datetime                              说明：参数为常用日期时间类型，其中日期之间支持的连接符号只支持-，格式如： 2006-01-02 12:00:00
date-format          格式：date-format:format                    说明：判断日期是否为指定的日期格式，format为gtime格式，如：Y-m-d H:i:s
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                                说明：域名
size                 格式：size:size                             说明：参数长度必须为:size，注意底层使用Unicode计算长度，因此中文一个汉字占1个长度位
length               格式：length:min,max                        说明：参数长度为min到max(长度参数为整形)，注意底层使用Unicode计算长度，因此中文一个汉字占1个长度单位。
min-length           格式：min-length:min                        说明：参数长度最小为min(长度参数为整形)，注意底层使用Unicode计算长度，因此中文一个汉字占1个长度单位。
max-length           格式：max-length:max                        说明：参数长度最大为max(长度参数为整形)，注意底层使用Unicode计算长度，因此中文一个汉字占1个长度单位。
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
说明：必需参数，除了支持常见的字符串，也支持Slice/Map类型。

示例：姓名字段Name为必需参数必需不能为空。

Code Block

language	go

func ExampleValidator_Required() {
	type BizReq struct {
		Id   uint   `v:"required"`
		Name string `v:"required"`
	}
	var (
		ctx = context.Background()
		req = BizReq{
			Id: 1,
		}
	)
	if err := g.Validator().CheckStruct(ctx, req); err != nil {
		fmt.Println(err)
	}

	// Output:
	// The Name field is required
}

required-if

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

示例：当Gender字段为1时WifeName字段必须不为空，当Gender字段为2时HusbandName字段必须不为空

Code Block

language	go

func ExampleValidator_RequiredIf()  {
	type BizReq struct {
		Id          uint   `v:"required" dc:"Your Id"`
		Name        string `v:"required" dc:"Your name"`
		Gender      uint   `v:"in:0,1,2" dc:"0:Secret;1:Male;2:Female"`
		WifeName    string `v:"required-if:gender,1"`
		HusbandName string `v:"required-if:gender,2"`
	}
	var (
		ctx = context.Background()
		req = BizReq{
			Id:     1,
			Name:   "test",
			Gender: 1,
		}
	)
	if err := g.Validator().CheckStruct(ctx, req); err != nil {
		fmt.Println(err)
	}

	// Output:
	// The WifeName field is required
}

required-unless

格式: required-unless:field,value,...
说明：必需参数(当所给定字段值与所给值都不相等时，即：当field字段的值不为value时，当前验证字段为必须参数)。
示例：当Gender不等于0且Gender不等于2时，WifeName必须不为空

当Id不等于0且Gender不等于2时，HusbandName必须不为空

Code Block

language	go

func ExampleValidator_RequiredUnless()  {
	type BizReq struct {
		Id       	uint   `v:"required" dc:"Your Id"`
		Name     	string `v:"required" dc:"Your name"`
		Gender   	uint   `v:"in:0,1,2" dc:"0:Secret;1:Male;2:Female"`
		WifeName 	string `v:"required-unless:gender,0,gender,2"`
		HusbandName string `v:"required-unless:id,0,gender,2"`
	}
	var (
		ctx = context.Background()
		req = BizReq{
			Id:     1,
			Name:   "test",
			Gender: 1,
		}
	)
	if err := g.Validator().CheckStruct(ctx, req); err != nil {
		fmt.Println(err)
	}

	// Output:
	// The WifeName field is required; The HusbandName field is required
}

required-with

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

示例：当WifeName不为空时，HusbandName必须不为空

Code Block

language	go

func ExampleValidator_RequiredWith()  {
	type BizReq struct {
		Id       	uint   `v:"required" dc:"Your Id"`
		Name     	string `v:"required" dc:"Your name"`
		Gender   	uint   `v:"in:0,1,2" dc:"0:Secret;1:Male;2:Female"`
		WifeName 	string
		HusbandName string `v:"required-with:WifeName"`
	}
	var (
		ctx = context.Background()
		req = BizReq{
			Id:     	1,
			Name:   	"test",
			Gender:		1,
			WifeName:	"Ann",
		}
	)
	if err := g.Validator().CheckStruct(ctx, req); err != nil {
		fmt.Println(err)
	}

	// Output:
	// The HusbandName field is required
}

required-with-all

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

示例：当Id，Name，Gender，WifeName全部不为空时，HusbandName必须不为空

Code Block

language	go

func ExampleValidator_RequiredWithAll()  {
	type BizReq struct {
		Id       	uint   `v:"required" dc:"Your Id"`
		Name     	string `v:"required" dc:"Your name"`
		Gender   	uint   `v:"in:0,1,2" dc:"0:Secret;1:Male;2:Female"`
		WifeName 	string
		HusbandName string `v:"required-with-all:Id,Name,Gender,WifeName"`
	}
	var (
		ctx = context.Background()
		req = BizReq{
			Id:     	1,
			Name:   	"test",
			Gender:		1,
			WifeName:	"Ann",
		}
	)
	if err := g.Validator().CheckStruct(ctx, req); err != nil {
		fmt.Println(err)
	}

	// Output:
	// The HusbandName field is required
}

required-without

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

示例：当Id或WifeName为空时，HusbandName必须不为空

Code Block

language	go

func ExampleValidator_RequiredWithout()  {
	type BizReq struct {
		Id       	uint   `v:"required" dc:"Your Id"`
		Name     	string `v:"required" dc:"Your name"`
		Gender   	uint   `v:"in:0,1,2" dc:"0:Secret;1:Male;2:Female"`
		WifeName 	string
		HusbandName string `v:"required-without:Id,WifeName"`
	}
	var (
		ctx = context.Background()
		req = BizReq{
			Id:     	1,
			Name:   	"test",
			Gender:		1,
		}
	)
	if err := g.Validator().CheckStruct(ctx, req); err != nil {
		fmt.Println(err)
	}

	// Output:
	// The HusbandName field is required
}

required-without-all

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

示例：当Id和WifeName都为空时，HusbandName必须不为空

Code Block

language	go

func ExampleValidator_RequiredWithoutAll()  {
	type BizReq struct {
		Id       	uint   `v:"required" dc:"Your Id"`
		Name     	string `v:"required" dc:"Your name"`
		Gender   	uint   `v:"in:0,1,2" dc:"0:Secret;1:Male;2:Female"`
		WifeName 	string
		HusbandName string `v:"required-without-all:Id,WifeName"`
	}
	var (
		ctx = context.Background()
		req = BizReq{
			Name:   	"test",
			Gender:		1,
		}
	)
	if err := g.Validator().CheckStruct(ctx, req); err != nil {
		fmt.Println(err)
	}

	// Output:
	// The HusbandName field is required
}

date

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

datetime

格式: datetime
说明：参数为常用日期时间类型，其中日期之间支持的连接符号只支持-，格式如： 2006-01-02 12:00:00

date-format

格式: date-format:format
说明：判断日期是否为指定的日期格式，format参数格式为gtime日期格式(可以包含日期及时间)，格式说明参考章节：gtime模块
示例：date-format:Y-m-d H:i:s

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
说明：域名

size

格式: size:size
说明：参数长度为size(长度参数为整形)，注意底层使用Unicode计算长度，因此中文一个汉字占1个长度单位

length

格式: length:min,max
说明：参数长度为min到max(长度参数为整形)，注意底层使用Unicode计算长度，因此中文一个汉字占1个长度单位

min-length

格式: min-length:min
说明：参数长度最小为min(长度参数为整形)，注意底层使用Unicode计算长度，因此中文一个汉字占1个长度单位

max-length

格式: max-length:max
说明：参数长度最大为max(长度参数为整形)，注意底层使用Unicode计算长度，因此中文一个汉字占1个长度单位

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参数的值相同

示例：在用户注册时，提交密码Password和确认密码Password2必须相等（服务端校验）。

Code Block

language	go

func ExampleValidator_Same()  {
	type BizReq struct {
		Name      string `v:"required"`
		Password  string `v:"required|same:Password2"`
		Password2 string `v:"required"`
	}
	var (
		ctx = context.Background()
		req = BizReq{
			Name:      "gf",
			Password:  "goframe.org",
			Password2: "goframe.net",
		}
	)
	if err := g.Validator().CheckStruct(ctx, req); err != nil {
		fmt.Println(err)
	}

	// Output:
	// The Password value must be the same as field Password2
}

different

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

示例：备用邮箱OtherMailAddr和邮箱地址MailAddr必须不相同

Code Block

language	go

func ExampleValidator_Different()  {
	type BizReq struct {
		Name        	string 	`v:"required"`
		MailAddr		string 	`v:"required"`
		OtherMailAddr	string 	`v:"required|different:MailAddr"`
	}
	var (
		ctx = context.Background()
		req = BizReq{
			Name:   		"gf",
			MailAddr:		"gf@goframe.org",
			OtherMailAddr:	"gf@goframe.org",
		}
	)
	if err := g.Validator().CheckStruct(ctx, req); err != nil {
		fmt.Println(err)
	}

	// Output:
	// The OtherMailAddr value must be different from field MailAddr
}

in

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

示例：性别字段Gender的值必须在0，1，2中

Code Block

language	go

func ExampleValidator_In()  {
	type BizReq struct {
		Id          uint   `v:"required" dc:"Your Id"`
		Name        string `v:"required" dc:"Your name"`
		Gender      uint   `v:"in:0,1,2" dc:"0:Secret;1:Male;2:Female"`
	}
	var (
		ctx = context.Background()
		req = BizReq{
			Id:     1,
			Name:   "test",
			Gender: 3,
		}
	)
	if err := g.Validator().CheckStruct(ctx, req); err != nil {
		fmt.Println(err)
	}

	// Output:
	// The Gender value is not in acceptable range
}

not-in

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

示例：无效索引InvalidIndex的值必须不在-1，0，1中

Code Block

language	go

func ExampleValidator_NotIn()  {
	type BizReq struct {
		Id          	uint   `v:"required" dc:"Your Id"`
		Name        	string `v:"required" dc:"Your name"`
		InvalidIndex	uint   `v:"not-in:-1,0,1"`
	}
	var (
		ctx = context.Background()
		req = BizReq{
			Id:     1,
			Name:   "test",
			InvalidIndex: 1,
		}
	)
	if err := g.Validator().CheckStruct(ctx, req); err != nil {
		fmt.Println(err)
	}

	// Output:
	// The InvalidIndex value is not in acceptable range
}

regex

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

Panel

title	Content Menu

Table of Contents

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 66

New Version 67

Key

required

required-if

required-unless

required-with

required-with-all

required-without

required-without-all

date

datetime

date-format

email

phone

phone-loose

telephone

passport

password

password2

password3

postcode

resident-id

bank-card

qq

ip

ipv4

ipv6

mac

url

domain

size

length

min-length

max-length

between

min

max

json

integer

float

boolean

same

different

in

not-in

regex