GoFrame框架校验组件内置了数十项常用的校验规则，校验组件是开发者最频繁使用的框架核心组件之一。

Note
校验规则涉及到联合校验的场景时，规则中关联的参数名称会自动按照不区分大小写且忽略特殊字符的形式进行智能匹配。以下示例代码中我们均采用常用的结构体校验的方式，结构体属性中的`v`标签标识`validation`的缩写，用于设置该属性的校验规格。

修饰规则

修饰规则本身没有任何的校验逻辑，而是修改后续功能规则的实现逻辑。

`ci`

格式： ci
说明：字段值比较在默认情况下为区分大小写严格匹配比较，通过ci(Case Insensitive)修饰规则，可以设置后续需要比较值的规则字段为不区分大小写。如：same, different, in, not-in等。
示例：

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

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

Code Block
language

xml

go

required

func Example_Rule_CaseInsensitive() {
	type BizReq struct {
		Account   string `v:"required"`
		Password  string

格式：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

`v:"required|ci|same:Password2"`
		Password2 string `v:"required"`
	}
	var (
		ctx = context.Background()
		req = BizReq{
			Account:   "gf",
			Password:  "Goframe.org", // Diff from Password2, but because of "ci", rule check passed
			Password2: "goframe.org",
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Println(err)
	}

	// output:
}

bail

Note
需要特别注意：如果参数校验存在多条校验规则，并且规则中存在`required`规则和`bail`修饰规则一起使用时，那么建议将`required`校验规则放置于所有规则之前，否则`bail`校验规则的特性（校验失败即停止后续校验）有可能会引起后续规则的`required*`规则不生效。

格式：bail
说明：只要后续的多个校验中有一个规则校验失败则停止校验并立即返回校验结果。
注意：在框架的HTTP Server组件中，如果采用规范路由注册方式，在其自动校验特性中将会自动开启bail修饰规则，开发者无需在Req对象中显式设置bail。

示例：

Code Block

language	go

func Example_Rule_Bail() {
	type BizReq struct {
		Account   string `v:"bail|required|length:6,16|same:QQ"`
		QQ        string
		Password  string `v:"required|same:Password2"`
		Password2 string `v:"required"`
	}
	var (
		ctx = context.Background()
		req = BizReq{
			Account:   "gf",
			QQ:        "123456",
			Password:  "goframe.org",
			Password2: "goframe.org",
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Println(err)
	}

	// output:
	// The Account value `gf` length must be between 6 and 16
}

`foreach`

格式：foreach
说明：用于数组参数，将待检验的参数作为数组遍历，并将后一个校验规则应用于数组中的每一项。
版本：框架版本>=v2.2.0

示例：

Code Block

language	go

func Example_Rule_Foreach() {
	type BizReq struct {
		Value1 []int `v:"foreach|in:1,2,3"`
		Value2 []int `v:"foreach|in:1,2,3"`
	}
	var (
		ctx = context.Background()
		req = BizReq{
			Value1: []int{1, 2, 3},
			Value2: []int{3, 4, 5},
		}
	)
	if err := g.Validator().Bail().Data(req).Run(ctx); err != nil {
		fmt.Println(err.String())
	}

	// Output:
	// The Value2 value `4` is not in acceptable range: 1,2,3
}

功能规则

功能规则实现特定的校验逻辑，框架内置了非常丰富强大的内置校验规则。

`required`

格式: required
说明：必需参数，除了支持常见的字符串，也支持Slice/Map类型。

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

Code Block

language	go

func Example_Rule_Required() {
	type BizReq struct {
		ID   uint   `v:"required"`
		Name string `v:"required"`
	}
	var (
		ctx = context.Background()
		req = BizReq{
			ID: 1,
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(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 Example_Rule_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().Data(req).Run(ctx); 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 Example_Rule_RequiredUnless() { type BizReq struct { ID uint `v:"required" dc:"Your ID"` Name

格式：phone

       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 =

说明：手机号 phone-loose

BizReq{
			ID:     1,
			Name:   "test",
			Gender:

格式：phone

1,
		}
	)
	if err := g.Validator().Data(req).Run(ctx); 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 Example_Rule_RequiredWith() {
	type BizReq struct {
		ID          uint

说明：手机号，只要满足

13、14、15、16、17、18、19开头的11位数字都可以通过验证 telephone

 `v:"required" dc:"Your ID"`
		Name        string

格式：telephone

`v:"required" dc:"Your name"`
		Gender      uint

`v:"in:0,1,2" dc:"0:Secret;1:Male;2:Female"`
		WifeName    string
		HusbandName

说明：国内座机电话号码，"XXXX-XXXXXXX"、"XXXX-XXXXXXXX"、"XXX-XXXXXXX"、"XXX-XXXXXXXX"、"XXXXXXX"、"XXXXXXXX" passport

string `v:"required-with:WifeName"`
	}
	var (
		ctx = context.Background()
		req = BizReq{
			ID:

格式：passport

1,
			Name:     "test",
			Gender:   1,
			WifeName: "Ann",
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err !=

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

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 Example_Rule_RequiredWithAll() {
	type BizReq struct {
		ID          uint   `v:"required" dc:"Your ID"`
		Name        string `v:"required"

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

dc:"Your name"` Gender uint

格式：password2

`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:

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

1,
			WifeName: "Ann",
		}
	)
	if err := g.Validator().Data(req).Run(ctx); 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 Example_Rule_RequiredWithout() {
	type BizReq struct {
		ID          uint   `v:"required" dc:"Your ID"`
		Name        string `v:"required"

说明：中国邮政编码 resident-id

dc:"Your name"` Gender uint

格式：resident-id

`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().Data(req).Run(ctx); err

说明：公民身份证号码 bank-card 格式：bank-card

!= 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 Example_Rule_RequiredWithoutAll() {
	type BizReq struct {
		ID          uint   `v:"required" dc:"Your ID"`
		Name        string `v:"required"

说明：银行号验证 qq

dc:"Your name"`
		Gender      uint   `v:"in:0,1,2" dc:"0:Secret;1:Male;2:Female"`
		WifeName    string
		HusbandName string

格式：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

`v:"required-without-all:Id,WifeName"`
	}
	var (
		ctx = context.Background()
		req = BizReq{
			Name:   "test",
			Gender: 1,
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Println(err)
	}

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

`date`

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

示例：

Code Block

language	go

func Example_Rule_Date() {
	type BizReq struct {
		Date1 string `v:"date"`
		Date2 string `v:"date"`
		Date3 string `v:"date"`
		Date4 string `v:"date"`
		Date5 string `v:"date"`
	}

	var (
		ctx = context.Background()
		req = BizReq{
			Date1: "2021-10-31",
			Date2: "2021.10.31",
			Date3: "2021-Oct-31",
			Date4: "2021 Octa 31",
			Date5: "2021/Oct/31",
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(gstr.Join(err.Strings(), "\n"))
	}

	// Output:
	// The Date3 value `2021-Oct-31` is not a valid date
	// The Date4 value `2021 Octa 31` is not a valid date
	// The Date5 value `2021/Oct/31` is not a valid date
}

`datetime`

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

示例：

Code Block

language	go

func Example_Rule_Datetime() {
	type BizReq struct {
		Date1 string `v:"datetime"`
		Date2 string `v:"datetime"`
		Date3 string `v:"datetime"`
		Date4 string `v:"datetime"`
	}

	var (
		ctx = context.Background()
		req = BizReq{
			Date1: "2021-11-01 23:00:00",
			Date2: "2021-11-01 23:00",     // error
			Date3: "2021/11/01 23:00:00",  // error
			Date4: "2021/Dec/01 23:00:00", // error
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(gstr.Join(err.Strings(), "\n"))
	}

	// Output:
	// The Date2 value `2021-11-01 23:00` is not a valid datetime
	// The Date3 value `2021/11/01 23:00:00` is not a valid datetime
	// The Date4 value `2021/Dec/01 23:00:00` is not a valid datetime
}

`date-format`

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

示例：date-format:Y-m-d H:i:s

Code Block

language	go

func Example_Rule_DateFormat() {
	type BizReq struct {
		Date1 string `v:"date-format:Y-m-d"`
		Date2 string `v:"date-format:Y-m-d"`
		Date3 string `v:"date-format:Y-m-d H:i:s"`
		Date4 string `v:"date-format:Y-m-d H:i:s"`
	}

	var (
		ctx = context.Background()
		req = BizReq{
			Date1: "2021-11-01",
			Date2: "2021-11-01 23:00", // error
			Date3: "2021-11-01 23:00:00",
			Date4: "2021-11-01 23:00", // error
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(gstr.Join(err.Strings(), "\n"))
	}

	// Output:
	// The Date2 value `2021-11-01 23:00` does not match the format: Y-m-d
	// The Date4 value `2021-11-01 23:00` does not match the format: Y-m-d H:i:s
}

`before`

格式: before:field
说明：判断给定的日期/时间是否在指定字段的日期/时间之前。
版本：框架版本>=v2.2.0

Code Block

language	go

func Example_Rule_Before() {
	type BizReq struct {
		Time1 string `v:"before:Time3"`
		Time2 string `v:"before:Time3"`
		Time3 string
	}
	var (
		ctx = context.Background()
		req = BizReq{
			Time1: "2022-09-02",
			Time2: "2022-09-03",
			Time3: "2022-09-03",
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Println(err.String())
	}

	// Output:
	// The Time2 value `2022-09-03` must be before field Time3 value `2022-09-03`
}

`before-equal`

格式: before-equal:field
说明：判断给定的日期/时间是否在指定字段的日期/时间之前，或者与指定字段的日期/时间相等。

版本：框架版本>=v2.2.0

Code Block

language	go

func Example_Rule_BeforeEqual() {
	type BizReq struct {
		Time1 string `v:"before-equal:Time3"`
		Time2 string `v:"before-equal:Time3"`
		Time3 string
	}
	var (
		ctx = context.Background()
		req = BizReq{
			Time1: "2022-09-02",
			Time2: "2022-09-01",
			Time3: "2022-09-01",
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(gstr.Join(err.Strings(), "\n"))
	}

	// Output:
	// The Time1 value `2022-09-02` must be before or equal to field Time3
}

`after`

格式: after:field
说明：判断给定的日期/时间是否在指定字段的日期/时间之后。

版本：框架版本>=v2.2.0

Code Block

language	go

func Example_Rule_After() {
	type BizReq struct {
		Time1 string
		Time2 string `v:"after:Time1"`
		Time3 string `v:"after:Time1"`
	}
	var (
		ctx = context.Background()
		req = BizReq{
			Time1: "2022-09-01",
			Time2: "2022-09-01",
			Time3: "2022-09-02",
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Println(err.String())
	}

	// Output:
	// The Time2 value `2022-09-01` must be after field Time1 value `2022-09-01`
}

`after-equal`

格式: after-equal:field
说明：判断给定的日期/时间是否在指定字段的日期/时间之后，或者与指定字段的日期/时间相等。

版本：框架版本>=v2.2.0

Code Block

language	go

func Example_Rule_AfterEqual() {
	type BizReq struct {
		Time1 string
		Time2 string `v:"after-equal:Time1"`
		Time3 string `v:"after-equal:Time1"`
	}
	var (
		ctx = context.Background()
		req = BizReq{
			Time1: "2022-09-02",
			Time2: "2022-09-01",
			Time3: "2022-09-02",
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(gstr.Join(err.Strings(), "\n"))
	}

	// Output:
	// The Time2 value `2022-09-01` must be after or equal to field Time1 value `2022-09-02`
}

`array`

格式: array
说明：判断给定的参数是否数组格式。如果给定的参数为JSON数组字符串，也将检验通过。

版本：框架版本>=v2.2.0

Code Block

language	go

func Example_Rule_Array() {
	type BizReq struct {
		Value1 string   `v:"array"`
		Value2 string   `v:"array"`
		Value3 string   `v:"array"`
		Value4 []string `v:"array"`
	}
	var (
		ctx = context.Background()
		req = BizReq{
			Value1: "1,2,3",
			Value2: "[]",
			Value3: "[1,2,3]",
			Value4: []string{},
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(gstr.Join(err.Strings(), "\n"))
	}

	// Output:
	// The Value1 value `1,2,3` is not of valid array type
}

`enums`

格式：enums

说明：校验提交的参数是否在字段类型的枚举值中。该规则需要结合gf gen enums命令一起使用，详情请参考：枚举维护-gen enums

Code Block

language	go

func ExampleRule_Enums() {
	type Status string
	const (
		StatusRunning Status = "Running"
		StatusOffline Status = "Offline"
	)
	type BizReq struct {
		Id     int    `v:"required"`
		Name   string `v:"required"`
		Status Status `v:"enums"`
	}

	var (
		ctx = context.Background()
		req = BizReq{
			Id:     1,
			Name:   "john",
			Status: Status("Pending"),
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(gstr.Join(err.Strings(), "\n"))
	}

	// May Output:
	// The Status value `Pending` should be in enums of: ["Running","Offline"]
}

`email`

格式：email

说明：EMAIL邮箱地址格式。

Code Block

language	go

func Example_Rule_Email() {
	type BizReq struct {
		MailAddr1 string `v:"email"`
		MailAddr2 string `v:"email"`
		MailAddr3 string `v:"email"`
		MailAddr4 string `v:"email"`
	}

	var (
		ctx = context.Background()
		req = BizReq{
			MailAddr1: "gf@goframe.org",
			MailAddr2: "gf@goframe", // error
			MailAddr3: "gf@goframe.org.cn",
			MailAddr4: "gf#goframe.org", // error
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(gstr.Join(err.Strings(), "\n"))
	}

	// Output:
	// The MailAddr2 value `gf@goframe` is not a valid email address
	// The MailAddr4 value `gf#goframe.org` is not a valid email address
}

`phone`

格式：phone

说明：大中国区手机号格式。

Code Block

language	go

func Example_Rule_Phone() {
	type BizReq struct {
		PhoneNumber1 string `v:"phone"`
		PhoneNumber2 string `v:"phone"`
		PhoneNumber3 string `v:"phone"`
		PhoneNumber4 string `v:"phone"`
	}

	var (
		ctx = context.Background()
		req = BizReq{
			PhoneNumber1: "13578912345",
			PhoneNumber2: "11578912345", // error 11x not exist
			PhoneNumber3: "17178912345", // error 171 not exit
			PhoneNumber4: "1357891234",  // error len must be 11
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(gstr.Join(err.Strings(), "\n"))
	}

	// Output:
	// The PhoneNumber2 value `11578912345` is not a valid phone number
	// The PhoneNumber3 value `17178912345` is not a valid phone number
	// The PhoneNumber4 value `1357891234` is not a valid phone number
}

`phone-loose`

格式: phone

说明：宽松的手机号验证，只要满足 13、14、15、16、17、18、19开头的11位数字都可以通过验证。可用于非严格的业务场景。

Code Block

language	go

func Example_Rule_PhoneLoose() {
	type BizReq struct {
		PhoneNumber1 string `v:"phone-loose"`
		PhoneNumber2 string `v:"phone-loose"`
		PhoneNumber3 string `v:"phone-loose"`
		PhoneNumber4 string `v:"phone-loose"`
	}

	var (
		ctx = context.Background()
		req = BizReq{
			PhoneNumber1: "13578912345",
			PhoneNumber2: "11578912345", // error 11x not exist
			PhoneNumber3: "17178912345",
			PhoneNumber4: "1357891234", // error len must be 11
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(gstr.Join(err.Strings(), "\n"))
	}

	// Output:
	// The PhoneNumber2 value `11578912345` is invalid
	// The PhoneNumber4 value `1357891234` is invalid
}

`telephone`

格式: telephone

说明：大中国区座机电话号码，”XXXX-XXXXXXX”、”XXXX-XXXXXXXX”、”XXX-XXXXXXX”、”XXX-XXXXXXXX”、”XXXXXXX”、”XXXXXXXX”。

Code Block

language	go

func Example_Rule_Telephone() {
	type BizReq struct {
		Telephone1 string `v:"telephone"`
		Telephone2 string `v:"telephone"`
		Telephone3 string `v:"telephone"`
		Telephone4 string `v:"telephone"`
	}

	var (
		ctx = context.Background()
		req = BizReq{
			Telephone1: "010-77542145",
			Telephone2: "0571-77542145",
			Telephone3: "20-77542145", // error
			Telephone4: "775421451",   // error len must be 7 or 8
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(gstr.Join(err.Strings(), "\n"))
	}

	// Output:
	// The Telephone3 value `20-77542145` is not a valid telephone number
	// The Telephone4 value `775421451` is not a valid telephone number
}

`passport`

格式: passport

说明：通用帐号规则（字母开头，只能包含字母、数字和下划线，长度在6~18之间）。

Code Block

language	go

func Example_Rule_Passport() {
	type BizReq struct {
		Passport1 string `v:"passport"`
		Passport2 string `v:"passport"`
		Passport3 string `v:"passport"`
		Passport4 string `v:"passport"`
	}

	var (
		ctx = context.Background()
		req = BizReq{
			Passport1: "goframe",
			Passport2: "1356666",  // error starting with letter
			Passport3: "goframe#", // error containing only numbers or underscores
			Passport4: "gf",       // error length between 6 and 18
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(gstr.Join(err.Strings(), "\n"))
	}

	// Output:
	// The Passport2 value `1356666` is not a valid passport format
	// The Passport3 value `goframe#` is not a valid passport format
	// The Passport4 value `gf` is not a valid passport format
}

`password`

格式: password
说明：通用密码规则（任意可见字符，长度在6~18之间）。
Code Block
language go
func Example_Rule_Password

required

格式: required
说明：必需参数，除了支持常见的字符串，也支持Slice/Map类型。

示例：姓名字段

Name

为必需参数必需不能为空。

Code Block

language	go

func ExampleValidator_Required

() { type BizReq struct {

Id uint

Password1 string `v:"

required

password"`

Name

Password2 string `v:"

required

password"`
	}

	var (
		ctx = context.Background()
		req = BizReq{

Id

Password1:

1

"goframe",

} )

	Password2: "gofra", // error length between 6 and 18
		}
	)
	if err := g.Validator().

CheckStruct

Data(req).Run(ctx

, req

); err != nil { fmt.

Println

Print(err) } // Output: // The

Name

Password2 value

field

`gofra` is

required

not a valid password format }

required-if

`password2`

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

说明：中等强度密码（在通用密码规则的基础上，要求密码必须包含大小写字母和数字）。示例：当Gender字段为1时WifeName字段必须不为空，当Gender字段为2时HusbandName字段必须不为空

Code Block

language	go

func ExampleValidatorExample_Rule_RequiredIfPassword2()  {
	type BizReq struct {
		IdPassword1          uint   `v:"required" dc:"Your Idstring `v:"password2"`
		Name        Password2 string `v:"required" dc:"Your name"password2"`
		Gender      uint   `v:"in:0,1,2" dc:"0:Secret;1:Male;2:Female"`
		WifeName    Password3 string `v:"required-if:gender,1password2"`
		HusbandNamePassword4 string `v:"required-if:gender,2password2"`
	}

	var (
		ctx = context.Background()
		req = BizReq{
			Id:     1,Password1: "Goframe123",
			Password2: "gofra",      // error length between 6 and 18
			NamePassword3:   "testGoframe",    // error must contain lower and upper letters and numbers.
			GenderPassword4: 1,"goframe123", // error must contain lower and upper letters and numbers.
		}
	)
	if err := g.Validator().CheckStructData(req).Run(ctx, req); err != nil {
		fmt.PrintlnPrint(gstr.Join(err.Strings(), "\n"))
	}

	// Output:
	// The WifeNamePassword2 value field`gofra` is required
}

required-unless

not a valid password format
	// The Password3 value `Goframe` is not a valid password format
	// The Password4 value `goframe123` is not a valid password format
}

`password3`

格式: password3

说明：强等强度密码（在通用密码规则的基础上，必须包含大小写字母、数字和特殊字符）。

Code Block

language	go

func Example_Rule_Password3() {
	type BizReq struct {
		Password1 string `v:"password3"`
		Password2 string `v:"password3"`
		Password3 string `v:"password3"`
	}

格式: 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{
			IdPassword1:     1"Goframe123#",
			NamePassword2:   "testgofra",      // error length between 6 and 18
			GenderPassword3: 1,
"Goframe123", // error must contain lower and upper letters, numbers and special chars.
		}
	)
	if err := g.Validator().CheckStructData(req).Run(ctx, req); err != nil {
		fmt.PrintlnPrint(gstr.Join(err.Strings(), "\n"))
	}

	// Output:
	// The WifeNamePassword2 value field`gofra` is required; not a valid password format
	// The HusbandNamePassword3 value field`Goframe123` is required not a valid password format
}

required-with

`postcode`

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

说明：大中国区邮政编码规则。

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

Code Block

language	go

func ExampleValidatorExample_Rule_RequiredWithPostcode()  {
	type BizReq struct {
		IdPostcode1       	uint   string `v:"required" dc:"Your Id"postcode"`
		Name     	Postcode2 string `v:"required" dc:"Your name"postcode"`
		Gender   	uint   `v:"in:0,1,2" dc:"0:Secret;1:Male;2:FemalePostcode3 string `v:"postcode"`
	}

	WifeNamevar 	string(
		HusbandNamectx string `v:"required-with:WifeName"`
	}
	var (
		ctx = context.Background= context.Background()
		req = BizReq{
			IdPostcode1:     	1"100000",
			NamePostcode2:   	"test10000",   // error length must be 6
			Gender:		1,
			WifeName:	"Ann",Postcode3: "1000000", // error length must be 6
		}
	)
	if err := g.Validator().Data(req).CheckStructRun(ctx, req); err != nil {
		fmt.PrintlnPrint(gstr.Join(err)
.Strings(), "\n"))
	}

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

required-with-all

 Postcode2 value `10000` is not a valid postcode format
	// The Postcode3 value `1000000` is not a valid postcode format
}

`resident-id`

格式: resident-id
说明：公民身份证号码。
格式: required-with-all:field1,field2,...
说明：必须参数(当所给定所有字段值都不为空时)。

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

Code Block

language	go

func ExampleValidatorExample_Rule_RequiredWithAllResidentId()  {
	type BizReq struct {
		IdResidentID1       	uint   string `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"`
	}
	resident-id"`
	}

	var (
		ctx = context.Background()
		req = BizReq{
			Id:     	1,
			Name:   	"testResidentID1: "320107199506285482",
			Gender:		1,
			WifeName:	"Ann",
		}
	)
	if err := g.Validator().CheckStructData(req).Run(ctx, req); err != nil {
		fmt.PrintlnPrint(err)
	}

	// Output:
	// The HusbandNameResidentID1 value field`320107199506285482` is required not a valid resident id number
}

required

`bank-`

without

`card`

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

说明：大中国区银行卡号校验。

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

Code Block

language	go

func ExampleValidatorExample_Rule_RequiredWithoutBankCard()  {
	type BizReq struct {
		Id       	uint   `v:"required" dc:"Your IdBankCard1 string `v:"bank-card"`
	}

	Namevar (
		ctx    	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= context.Background()
		req = BizReq{
			BankCard1: "6225760079930218",
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.PrintlnPrint(err)
	}

	// Output:
	// The HusbandNameBankCard1 value field`6225760079930218` is requirednot a valid bank card number
}

required-without-all

`qq`

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

说明：腾讯QQ号码规则。

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

Code Block

language	go

func ExampleValidatorExample_Rule_RequiredWithoutAllQQ()  {
	type BizReq struct {
		IdQQ1       	uint   string `v:"requiredqq" dc`
		QQ2 string `v:"Your Idqq"`
		Name     	QQ3 string `v:"required" dc:"Your name"qq"`
	}

	Gendervar (
		ctx  	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{
			NameQQ1:   	"test389961817",
			Gender:		1,QQ2: "9999",       // error >= 10000
		}
		QQ3: "514258412a", // error all number
		}
	)
	if err := g.Validator().CheckStructData(req).Run(ctx, req); err != nil {
		fmt.Print(gstr.PrintlnJoin(err.Strings(), "\n"))
	}

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

date

QQ2 value `9999` is not a valid QQ number
	// The QQ3 value `514258412a` is not a valid QQ number
}

`ip`

格式: ip
说明：IPv4/IPv6地址。
Code Block
language go
func Example_Rule_IP()
格式: date
说明：参数为常用日期类型，日期之间支持的连接符号-或/或.，也支持不带连接符号的8位长度日期，格式如： 2006-01-02, 2006/01/02, 2006.01.02, 20060102, 01-Nov-2018, 01.Nov.018, 01/Nov/2018

示例：

Code Block

language	go

func ExampleValidator_Date()  {
	type BizReq struct {
		Date1  IP1 string `v:"dateip"`
		Date2	IP2 string `v:"dateip"`
		Date3	IP3 string `v:"dateip"`
		Date4	IP4 string `v:"dateip"`
	}

	var (
		ctx = context.Background()
		req = BizReq{
			Date1IP1:	"2021-10-31 "127.0.0.1",
			Date2IP2:  "2021.10.31fe80::812b:1158:1f43:f0d1",
			Date3IP3: 	"2021 10 31","520.255.255.255", // error >= 10000
			Date4IP4:	"31/10/2021 "ze80::812b:1158:1f43:f0d1",
		}
	)
	if err := g.Validator().CheckStructData(req).Run(ctx, req); err != nil {
		fmt.Print(gstr.Join(err.Strings(), "\n"))
	}

	// Output:
	// The Date3IP3 value `520.255.255.255` is not a valid date;IP address
	// The Date4IP4 value `ze80::812b:1158:1f43:f0d1` is not a valid IP dateaddress
}

datetime

`ipv4`

格式: 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

ipv4

说明：IPv4地址。

Code Block

language	go

func Example_Rule_IPV4() {
	type BizReq struct {
		IP1 string `v:"ipv4"`
		IP2 string `v:"ipv4"`
	}

	var (
		ctx = context.Background()
		req = BizReq{
			IP1: "127.0.0.1",
			IP2: "520.255.255.255",
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(err)
	}

	// Output:
	// The IP2 value `520.255.255.255` is not a valid IPv4 address
}

`ipv6`

格式: ipv6

说明：IPv6地址。

Code Block

language	go

func Example_Rule_IPV6() {
	type BizReq struct {
		IP1 string `v:"ipv6"`
		IP2 string `v:"ipv6"`
	}

	var (
		ctx = context.Background()
		req = BizReq{
			IP1: "fe80::812b:1158:1f43:f0d1",
			IP2: "ze80::812b:1158:1f43:f0d1",
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(err)
	}

	// Output:
	// The IP2 value `ze80::812b:1158:1f43:f0d1` is not a valid IPv6 address
}

`mac`

格式: mac

说明：MAC地址。

Code Block

language	go

func Example_Rule_Mac() {
	type BizReq struct {
		Mac1 string `v:"mac"`
		Mac2 string `v:"mac"`
	}

	var (
		ctx = context.Background()
		req = BizReq{
			Mac1: "4C-CC-6A-D6-B1-1A",
			Mac2: "Z0-CC-6A-D6-B1-1A",
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(err)
	}

	// Output:
	// The Mac2 value `Z0-CC-6A-D6-B1-1A` is not a valid MAC address
}

`url`

格式: url
说明：URL

示例：支持以http，https，ftp，file开头的地址。

Code Block

language	go

func Example_Rule_Url() {
	type BizReq struct {
		URL1 string `v:"url"`
		URL2 string `v:"url"`
		URL3 string `v:"url"`
	}

	var (
		ctx = context.Background()
		req = BizReq{
			URL1: "http://goframe.org",
			URL2: "ftp://goframe.org",
			URL3: "ws://goframe.org",
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(err)
	}

	// Output:
	// The URL3 value `ws://goframe.org` is not a valid URL address
}

`domain`

格式: domain
说明：域名

示例：域名规则。xxx.yyy（首位必须为字母）。

Code Block

language	go

func Example_Rule_Domain() {
	type BizReq struct {
		Domain1 string `v:"domain"`
		Domain2 string `v:"domain"`
		Domain3 string `v:"domain"`
		Domain4 string `v:"domain"`
	}

	var (
		ctx = context.Background()
		req = BizReq{
			Domain1: "goframe.org",
			Domain2: "a.b",
			Domain3: "goframe#org",
			Domain4: "1a.2b",
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(gstr.Join(err.Strings(), "\n"))
	}

	// Output:
	// The Domain3 value `goframe#org` is not a valid domain format
	// The Domain4 value `1a.2b` is not a valid domain format
}

`size`

格式: size:size

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

Code Block

language	go

func Example_Rule_Size() {
	type BizReq struct {
		Size1 string `v:"size:10"`
		Size2 string `v:"size:5"`
	}

	var (
		ctx = context.Background()
		req = BizReq{
			Size1: "goframe欢迎你",
			Size2: "goframe",
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(err)
	}

	// Output:
	// The Size2 value `goframe` length must be 5
}

`length`

格式: length:min,max

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

Code Block

language	go

func Example_Rule_Length() {
	type BizReq struct {
		Length1 string `v:"length:5,10"`
		Length2 string `v:"length:10,15"`
	}

	var (
		ctx = context.Background()
		req = BizReq{
			Length1: "goframe欢迎你",
			Length2: "goframe",
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(err)
	}

	// Output:
	// The Length2 value `goframe` length must be between 10 and 15
}

`min-length`

格式: min-length:min

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

Code Block

language	go

func Example_Rule_MinLength() {
	type BizReq struct {
		MinLength1 string `v:"min-length:10"`
		MinLength2 string `v:"min-length:8"`
	}

	var (
		ctx = context.Background()
		req = BizReq{
			MinLength1: "goframe欢迎你",
			MinLength2: "goframe",
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(err)
	}

	// Output:
	// The MinLength2 value `goframe` length must be equal or greater than 8
}

`max-length`

格式: max-length:max

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

Code Block

language	go

func Example_Rule_MaxLength() {
	type BizReq struct {
		MaxLength1 string `v:"max-length:10"`
		MaxLength2 string `v:"max-length:5"`
	}

	var (
		ctx = context.Background()
		req = BizReq{
			MaxLength1: "goframe欢迎你",
			MaxLength2: "goframe",
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(err)
	}

	// Output:
	// The MaxLength2 value `goframe` length must be equal or lesser than 5
}

`between`

格式: between:min,max

说明：参数大小为min到max(支持整形和浮点类型参数)。

Code Block

language	go

func Example_Rule_Between() {
	type BizReq struct {
		Age1   int     `v:"between:1,100"`
		Age2   int     `v:"between:1,100"`
		Score1 float32 `v:"between:0,10"`
		Score2 float32 `v:"between:0,10"`
	}

	var (
		ctx = context.Background()
		req = BizReq{
			Age1:   50,
			Age2:   101,
			Score1: 9.8,
			Score2: -0.5,
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(gstr.Join(err.Strings(), "\n"))
	}

	// Output:
	// The Age2 value `101` must be between 1 and 100
	// The Score2 value `-0.5` must be between 0 and 10
}

`min`

格式: min:min

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

Code Block

language	go

func Example_Rule_Min() {
	type BizReq struct {
		Age1   int     `v:"min:100"`
		Age2   int     `v:"min:100"`
		Score1 float32 `v:"min:10"`
		Score2 float32 `v:"min:10"`
	}

	var (
		ctx = context.Background()
		req = BizReq{
			Age1:   50,
			Age2:   101,
			Score1: 9.8,
			Score2: 10.1,
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(gstr.Join(err.Strings(), "\n"))
	}

	// Output:
	// The Age1 value `50` must be equal or greater than 100
	// The Score1 value `9.8` must be equal or greater than 10
}

`max`

格式: max:max

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

Code Block

language	go

func Example_Rule_Max() {
	type BizReq struct {
		Age1   int     `v:"max:100"`
		Age2   int     `v:"max:100"`
		Score1 float32 `v:"max:10"`
		Score2 float32 `v:"max:10"`
	}

	var (
		ctx = context.Background()
		req = BizReq{
			Age1:   99,
			Age2:   101,
			Score1: 9.9,
			Score2: 10.1,
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(gstr.Join(err.Strings(), "\n"))
	}

	// Output:
	// The Age2 value `101` must be equal or lesser than 100
	// The Score2 value `10.1` must be equal or lesser than 10
}

`json`

格式: json

说明：判断数据格式为JSON。

Code Block

language	go

func Example_Rule_Json() {
	type BizReq struct {
		JSON1 string `v:"json"`
		JSON2 string `v:"json"`
	}

	var (
		ctx = context.Background()
		req = BizReq{
			JSON1: "{\"name\":\"goframe\",\"author\":\"郭强\"}",
			JSON2: "{\"name\":\"goframe\",\"author\":\"郭强\",\"test\"}",
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(err)
	}

	// Output:
	// The JSON2 value `{"name":"goframe","author":"郭强","test"}` is not a valid JSON string
}

`integer`

格式: integer

说明：整数（正整数或者负整数）。

Code Block

language	go

func Example_Rule_Integer() {
	type BizReq struct {
		Integer string `v:"integer"`
		Float   string `v:"integer"`
		Str     string `v:"integer"`
	}

	var (
		ctx = context.Background()
		req = BizReq{
			Integer: "100",
			Float:   "10.0",
			Str:     "goframe",
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(gstr.Join(err.Strings(), "\n"))
	}

	// Output:
	// The Float value `10.0` is not an integer
	// The Str value `goframe` is not an integer
}

`float`

格式: float

说明：浮点数。

Code Block

language	go

func Example_Rule_Float() {
	type BizReq struct {
		Integer string `v:"float"`
		Float   string `v:"float"`
		Str     string `v:"float"`
	}

	var (
		ctx = context.Background()
		req = BizReq{
			Integer: "100",
			Float:   "10.0",
			Str:     "goframe",
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(err)
	}

	// Output:
	// The Str value `goframe` is invalid
}

`boolean`

格式: boolean

说明：布尔值(1,true,on,yes为true | 0,false,off,no,""为false)。

Code Block

language	go

func Example_Rule_Boolean() {
	type BizReq struct {
		Boolean bool    `v:"boolean"`
		Integer int     `v:"boolean"`
		Float   float32 `v:"boolean"`
		Str1    string  `v:"boolean"`
		Str2    string  `v:"boolean"`
		Str3    string  `v:"boolean"`
	}

	var (
		ctx = context.Background()
		req = BizReq{
			Boolean: true,
			Integer: 1,
			Float:   10.0,
			Str1:    "on",
			Str2:    "",
			Str3:    "goframe",
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Print(gstr.Join(err.Strings(), "\n"))
	}

	// Output:
	// The Float value `10` field must be true or false
	// The Str3 value `goframe` field must be true or false
}

`same`

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

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

Code Block

language	go

func Example_Rule_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().Data(req).Run(ctx); err != nil {
		fmt.Println(err)
	}

	// Output:
	// The Password value `goframe.org` must be the same as field Password2
}

`different`

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

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

Code Block

language	go

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

	// Output:
	// The ConfirmMailAddr value `gf@goframe.org` must be different from field MailAddr
}

`eq`

格式: eq:field
说明：参数值必需与field字段参数的值相同。same规则的别名，功能同same规则。

版本：框架版本>=v2.2.0

Code Block

language	go

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

	// Output:
	// The Password value `goframe.org` must be equal to field Password2 value `goframe.net`
}

`not-eq`

格式: not-eq:field
说明：参数值必需与field字段参数的值不相同。different规则的别名，功能同different规则。

版本：框架版本>=v2.2.0

Code Block

language	go

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

	// Output:
	// The OtherMailAddr value `gf@goframe.org` must not be equal to field MailAddr value `gf@goframe.org`
}

`gt`

格式: gt:field
说明：参数值必需大于给定字段对应的值。

版本：框架版本>=v2.2.0

Code Block

language	go

func Example_Rule_GT() {
	type BizReq struct {
		Value1 int
		Value2 int `v:"gt:Value1"`
		Value3 int `v:"gt:Value1"`
	}
	var (
		ctx = context.Background()
		req = BizReq{
			Value1: 1,
			Value2: 1,
			Value3: 2,
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Println(err.String())
	}

	// Output:
	// The Value2 value `1` must be greater than field Value1 value `1`
}

`gte`

格式: gte:field
说明：参数值必需大于或等于给定字段对应的值。

版本：框架版本>=v2.2.0

Code Block

language	go

func Example_Rule_GTE() {
	type BizReq struct {
		Value1 int
		Value2 int `v:"gte:Value1"`
		Value3 int `v:"gte:Value1"`
	}
	var (
		ctx = context.Background()
		req = BizReq{
			Value1: 2,
			Value2: 1,
			Value3: 2,
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Println(err.String())
	}

	// Output:
	// The Value2 value `1` must be greater than or equal to field Value1 value `2`
}

`lt`

格式: lt:field
说明：参数值必需小于给定字段对应的值。

版本：框架版本>=v2.2.0

Code Block

language	go

func Example_Rule_LT() {
	type BizReq struct {
		Value1 int
		Value2 int `v:"lt:Value1"`
		Value3 int `v:"lt:Value1"`
	}
	var (
		ctx = context.Background()
		req = BizReq{
			Value1: 2,
			Value2: 1,
			Value3: 2,
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Println(err.String())
	}

	// Output:
	// The Value3 value `2` must be lesser than field Value1 value `2`
}

`lte`

格式: lte:field
说明：参数值必需小于或等于给定字段对应的值。

版本：框架版本>=v2.2.0

Code Block

language	go

func Example_Rule_LTE() {
	type BizReq struct {
		Value1 int
		Value2 int `v:"lte:Value1"`
		Value3 int `v:"lte:Value1"`
	}
	var (
		ctx = context.Background()
		req = BizReq{
			Value1: 1,
			Value2: 1,
			Value3: 2,
		}
	)
	if err := g.Validator().Data(req).Run(ctx); err != nil {
		fmt.Println(err.String())
	}

	// Output:
	// The Value3 value `2` must be lesser than or equal to field Value1 value `1`
}

`in`

格式: in:value1,value2,...
说明：参数值应该在value1,value2,...中（字符串匹配）。
示例：性别字段Gender的值必须在0/1/2中。
Code Block
language go
func Example_Rule_In()
格式: same:field
说明：参数值必需与field参数的值相同

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

Code Block

language	go

func ExampleValidator_Same()  {
	type BizReq struct {
		NameID     uint  string `v:"required" dc:"Your Id"`
		PasswordName   string `v:"required|same:Password2" dc:"Your name"`
		Password2 string `v:"requiredGender uint   `v:"in:0,1,2" dc:"0:Secret;1:Male;2:Female"`
	}
	var (
		ctx = context.Background()
		req = BizReq{
			NameID:      "gf"1,
			PasswordName:   "goframe.orgtest",
			Password2Gender: "goframe.net"3,
		}
	)
	if err := g.Validator().Data(req).CheckStructRun(ctx, req); err != nil {
		fmt.Println(err)
	}

	// Output:
	// The PasswordGender value must`3` beis thenot samein asacceptable field Password2range: 0,1,2
}

different

`not-in`

格式: different:field
说明：参数值不能与field参数的值相同
not-in:value1,value2,...
说明：参数值不应该在value1,value2,...中（字符串匹配）。

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

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

Code Block

language	go

func ExampleValidator_Different Example_Rule_NotIn()  {
	type BizReq struct {
		NameID           uint  	string 	`v:"required" dc:"Your Id"`
		MailAddr		Name         string 	`v:"required" dc:"Your name"`
		OtherMailAddr	string 	InvalidIndex uint   `v:"required|different:MailAddrnot-in:-1,0,1"`
	}
	var (
		ctx = context.Background()
		req = BizReq{
			NameID:    		"gf"       1,
			MailAddr:		"gf@goframe.orgName:         "test",
			OtherMailAddr:	"gf@goframe.org"InvalidIndex: 1,
		}
	)
	if err := g.Validator().Data(req).CheckStructRun(ctx, req); err != nil {
		fmt.Println(err)
	}

	// Output:
	// The OtherMailAddrInvalidIndex value `1` must not be differentin from field MailAddrrange: -1,0,1
}

in

`regex`

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

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

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

Code Block

language	go

func ExampleValidatorExample_Rule_In()  {
	type BizReq struct {
		Id          uint   `v:"required" dc:"Your Id"`
		Name        Regex() {
	type BizReq struct {
		Regex1 string `v:"required" dc:"Your name"regex:[1-9][0-9]{4,14}"`
		GenderRegex2      uint   string `v:"in:0,1,2" dc:"0:Secret;1:Male;2:Femaleregex:[1-9][0-9]{4,14}"`
		Regex3 string `v:"regex:[1-9][0-9]{4,14}"`
	}
	var (
		ctx = context.Background()
		req = BizReq{
			Id:     1Regex1: "1234",
			NameRegex2:   "test01234",
			GenderRegex3: 3"10000",
		}
	)
	if err := g.Validator().Data(req).CheckStructRun(ctx, req); err != nil {
		fmt.PrintlnPrint(gstr.Join(err.Strings(), "\n"))
	}

	// Output:
	// The Gender value is not in acceptable rangeRegex1 value `1234` must be in regex of: [1-9][0-9]{4,14}
	// The Regex2 value `01234` must be in regex of: [1-9][0-9]{4,14}
}

`not-`

in

`regex`

格式: not-in:value1,value2,...
说明：参数值不应该在value1,value2,...中(字符串匹配)
regex:pattern
说明：参数值不应当满足正则匹配规则pattern。

版本：框架版本>=v2.2.0

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

Code Block

language	go

func ExampleValidatorExample_Rule_NotInNotRegex()  {
	type BizReq struct {
		Id          	uint   `v:"required" dc:"Your Id"`
		Name        	Regex1 string `v:"required" dc:"Your nameregex:\\d{4}"`
		InvalidIndex	uintRegex2 string  `v:"not-in:-1,0,1regex:\\d{4}"`
	}
	var (
		ctx = context.Background()
		req = BizReq{
			IdRegex1:     1"1234",
			NameRegex2:   "test1234",
			InvalidIndex: 1,
		}
	)
	if err := g.Validator().CheckStructData(req).Run(ctx, req); err != nil {
		fmt.Print(gstr.PrintlnJoin(err.Strings(), "\n"))
	}

	// Output:
	// The InvalidIndexRegex2 value `1234` isshould not be in regex acceptable range
}

regex

格式: regex:pattern
说明：参数值应当满足正则匹配规则pattern
of: \d{4} }

Panel

title	Content Menu

Table of Contents

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 69

New Version Current

Key

修饰规则

ci

bail

foreach

功能规则

required

required-if

required-unless

required-with

required-with-all

required-without

required-without-all

date

datetime

date-format

before

before-equal

after

after-equal

array

enums

email

phone

phone-loose

telephone

passport

password

required

password2

required-unless

password3

postcode

required-with-all

resident-id

bank-

card

qq

date

ip

ipv4

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

ipv6

mac

`ci`

`foreach`

`required`

`required-if`

`required-unless`

`required-with`

`required-with-all`

`required-without`

`required-without-all`

`date`

`datetime`

`date-format`

`before`

`before-equal`

`after`

`after-equal`

`array`

`enums`

`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`

`eq`

`not-eq`

`gt`

`gte`

`lt`

`lte`

`in`

`not-in`

`regex`

`not-`

`regex`