gvalid

原文：https://pkg.go.dev/github.com/gogf/gf/v2@v2.6.4/util/gvalid

Package gvalid implements powerful and useful data/form validation functionality.

​ Package gvalid 实现了强大而有用的数据/表单验证功能。

常量

This section is empty.

变量

This section is empty.

函数

func DeleteRule

1

func DeleteRule(rules ...string)

DeleteRule deletes custom defined validation one or more rules and associated functions from global package.

​ DeleteRule 从全局包中删除自定义验证的一个或多个规则和关联函数。

func GetRegisteredRuleMap

1

func GetRegisteredRuleMap() map[string]RuleFunc

GetRegisteredRuleMap returns all the custom registered rules and associated functions.

​ GetRegisteredRuleMap 返回所有自定义注册的规则和关联的函数。

func GetTags

1

func GetTags() []string

GetTags returns the validation tags.

​ GetTags 返回验证标记。

func ParseTagValue

1

func ParseTagValue(tag string) (field, rule, msg string)

ParseTagValue parses one sequence tag to field, rule and error message. The sequence tag is like: [alias@]rule[…#msg…]

​ ParseTagValue 将一个序列标签解析为字段、规则和错误消息。序列标签如下：[alias@]rule[…#msg…]

func RegisterRule

1

func RegisterRule(rule string, f RuleFunc)

RegisterRule registers custom validation rule and function for package.

​ RegisterRule 为包注册自定义验证规则和函数。

func RegisterRuleByMap

1

func RegisterRuleByMap(m map[string]RuleFunc)

RegisterRuleByMap registers custom validation rules using map for package.

​ RegisterRuleByMap 使用包的 map 注册自定义验证规则。

类型

type CustomMsg

1

type CustomMsg = map[string]interface{}

CustomMsg is the custom error message type, like: map[field] => string|map[rule]string

​ CustomMsg 是自定义错误消息类型，例如：map[field] => string|map[rule]string

type Error

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

type Error interface {
	Code() gcode.Code
	Current() error
	Error() string
	FirstItem() (key string, messages map[string]error)
	FirstRule() (rule string, err error)
	FirstError() (err error)
	Items() (items []map[string]map[string]error)
	Map() map[string]error
	Maps() map[string]map[string]error
	String() string
	Strings() (errs []string)
}

Error is the validation error for validation result.

​ Error 是验证结果的验证错误。

type RuleFunc

1

type RuleFunc func(ctx context.Context, in RuleFuncInput) error

RuleFunc is the custom function for data validation.

​ RuleFunc 是用于数据验证的自定义函数。

type RuleFuncInput

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

type RuleFuncInput struct {
	// Rule specifies the validation rule string, like "required", "between:1,100", etc.
	Rule string

	// Message specifies the custom error message or configured i18n message for this rule.
	Message string

	// Field specifies the field for this rule to validate.
	Field string

	// ValueType specifies the type of the value, which might be nil.
	ValueType reflect.Type

	// Value specifies the value for this rule to validate.
	Value *gvar.Var

	// Data specifies the `data` which is passed to the Validator. It might be a type of map/struct or a nil value.
	// You can ignore the parameter `Data` if you do not really need it in your custom validation rule.
	Data *gvar.Var
}

RuleFuncInput holds the input parameters that passed to custom rule function RuleFunc.

​ RuleFuncInput 保存传递给自定义规则函数 RuleFunc 的输入参数。

type Validator

1
2
3

type Validator struct {
	// contains filtered or unexported fields
}

Validator is the validation manager for chaining operations.

​ Validator 是用于链接操作的验证管理器。

func New

1

func New() *Validator

New creates and returns a new Validator.

​ new 创建并返回一个新的验证器。

Example

(*Validator) Assoc

1

func (v *Validator) Assoc(assoc interface{}) *Validator

Assoc is a chaining operation function, which sets associated validation data for current operation. The optional parameter assoc is usually type of map, which specifies the parameter map used in union validation. Calling this function with assoc also sets useAssocInsteadOfObjectAttributes true

​ Assoc 是一个链接操作函数，用于设置当前操作的关联验证数据。可选参数 assoc 通常是 type of map，它指定联合验证中使用的参数 map。调用此函数 assoc 也设置 useAssocInsteadOfObjectAttributes true

Example

(*Validator) Bail

1

func (v *Validator) Bail() *Validator

Bail sets the mark for stopping validation after the first validation error.

​ Bail 设置在第一个验证错误后停止验证的标记。

Example

(*Validator) Ci

1

func (v *Validator) Ci() *Validator

Ci sets the mark for Case-Insensitive for those rules that need value comparison.

​ Ci 为需要值比较的规则设置了“不区分大小写”的标记。

Example

(*Validator) Clone

1

func (v *Validator) Clone() *Validator

Clone creates and returns a new Validator which is a shallow copy of current one.

​ 克隆创建并返回一个新的验证者，它是当前验证者的浅层副本。

Example

(*Validator) Data

1

func (v *Validator) Data(data interface{}) *Validator

Data is a chaining operation function, which sets validation data for current operation.

​ 数据是一个链接操作函数，用于设置当前操作的验证数据。

Example

(*Validator) Foreach

1

func (v *Validator) Foreach() *Validator

Foreach tells the next validation using current value as an array and validates each of its element. Note that this decorating rule takes effect just once for next validation rule, specially for single value validation.

​ Foreach 使用当前值作为数组告诉下一个验证，并验证其每个元素。请注意，此修饰规则仅对下一个验证规则生效一次，特别是对于单值验证。

(*Validator) I18n

1

func (v *Validator) I18n(i18nManager *gi18n.Manager) *Validator

I18n sets the i18n manager for the validator.

​ I18n 为验证器设置 i18n 管理器。

Example

(*Validator) Messages

1

func (v *Validator) Messages(messages interface{}) *Validator

Messages is a chaining operation function, which sets custom error messages for current operation. The parameter messages can be type of string/[]string/map[string]string. It supports sequence in error result if rules is type of []string.

​ Messages 是一个链接操作函数，用于设置当前操作的自定义错误消息。参数 messages 类型可以是 string/[]string/map[string]string。如果 rules 类型为 []string，则支持错误结果中的序列。

Example

(*Validator) RuleFunc

1

func (v *Validator) RuleFunc(rule string, f RuleFunc) *Validator

RuleFunc registers one custom rule function to current Validator.

​ RuleFunc 向当前 Validator 注册一个自定义规则函数。

Example

(*Validator) RuleFuncMap

1

func (v *Validator) RuleFuncMap(m map[string]RuleFunc) *Validator

RuleFuncMap registers multiple custom rule functions to current Validator.

​ RuleFuncMap 将多个自定义规则函数注册到当前 Validator。

Example

(*Validator) Rules

1

func (v *Validator) Rules(rules interface{}) *Validator

Rules is a chaining operation function, which sets custom validation rules for current operation.

​ Rules是一个链接操作函数，用于设置当前操作的自定义验证规则。

Example

(*Validator) Run

1

func (v *Validator) Run(ctx context.Context) Error

Run starts validating the given data with rules and messages.

​ Run 开始使用规则和消息验证给定数据。

Example Run

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

package main

import (
	"context"
	"fmt"

	"github.com/gogf/gf/v2/frame/g"
)

func main() {
	// check value mode
	if err := g.Validator().Data(16).Rules("min:18").Run(context.Background()); err != nil {
		fmt.Println("check value err:", err)
	}
	// check map mode
	data := map[string]interface{}{
		"passport":  "",
		"password":  "123456",
		"password2": "1234567",
	}
	rules := map[string]string{
		"passport":  "required|length:6,16",
		"password":  "required|length:6,16|same:password2",
		"password2": "required|length:6,16",
	}
	if err := g.Validator().Data(data).Rules(rules).Run(context.Background()); err != nil {
		fmt.Println("check map err:", err)
	}
	// check struct mode
	type Params struct {
		Page      int    `v:"required|min:1"`
		Size      int    `v:"required|between:1,100"`
		ProjectId string `v:"between:1,10000"`
	}
	rules = map[string]string{
		"Page":      "required|min:1",
		"Size":      "required|between:1,100",
		"ProjectId": "between:1,10000",
	}
	obj := &Params{
		Page: 0,
		Size: 101,
	}
	if err := g.Validator().Data(obj).Run(context.Background()); err != nil {
		fmt.Println("check struct err:", err)
	}

	// May Output:
	// check value err: The value `16` must be equal or greater than 18
	// check map err: The passport field is required; The passport value `` length must be between 6 and 16; The password value `123456` must be the same as field password2
	// check struct err: The Page value `0` must be equal or greater than 1; The Size value `101` must be between 1 and 100
}

Output: