Go通用的数据验证与过滤库,使用简单,内置大部分常用验证器、过滤器,支持自定义消息、字段翻译。
Map
Struct
Request
(Form
,JSON
,url.Values
, UploadedFile
)数据
Content-Type
快速验证 http.Request
并收集数据v.StringRule("tags.*", "required|string|minlen:1")
en
zh-CN
zh-TW
)
message
, label
标签定义消息翻译validate
,例如 Gin、Echo、Chi 等validate.Val("xyz@mail.com", "required|email")
受到 albrow/forms asaskevich/govalidator inhere/php-validate 这些项目的启发. 非常感谢它们
Please see the English introduction README
在结构体上添加 validate
标签,可以快速对一个结构体进行验证设置。
可以搭配使用 message
和 label
标签,快速配置结构体的字段翻译和错误消息。
json
标签的值message
tag 配置错误消息label
tag 字段映射/翻译代码示例:
package main
import (
"fmt"
"time"
"github.com/gookit/validate"
)
// UserForm struct
type UserForm struct {
Name string `validate:"required|min_len:7" message:"required:{field} is required" label:"用户名称"`
Email string `validate:"email" message:"email is invalid" label:"用户邮箱"`
Age int `validate:"required|int|min:1|max:99" message:"int:age must int|min:age min value is 1"`
CreateAt int `validate:"min:1"`
Safe int `validate:"-"` // 标记字段安全无需验证
UpdateAt time.Time `validate:"required" message:"update time is required"`
Code string `validate:"customValidator"`
// 结构体嵌套
ExtInfo struct{
Homepage string `validate:"required" label:"用户主页"`
CityName string
} `validate:"required" label:"扩展信息"`
}
// CustomValidator custom validator in the source struct.
func (f UserForm) CustomValidator(val string) bool {
return len(val) == 4
}
结构体可以实现3个接口方法,方便做一些自定义:
ConfigValidation(v *Validation)
将在创建验证器实例后调用Messages() map[string]string
可以自定义验证器错误消息Translates() map[string]string
可以自定义字段映射/翻译代码示例:
package main
import (
"fmt"
"time"
"github.com/gookit/validate"
)
// UserForm struct
type UserForm struct {
Name string `validate:"required|minLen:7"`
Email string `validate:"email"`
Age int `validate:"required|int|min:1|max:99"`
Safe int `validate:"-"`
CreateAt int `validate:"min:1"`
UpdateAt time.Time `validate:"required"`
Code string `validate:"customValidator"` // 使用自定义验证器
// 结构体嵌套
ExtInfo struct{
Homepage string `validate:"required"`
CityName string
} `validate:"required"`
}
// CustomValidator 定义在结构体中的自定义验证器
func (f UserForm) CustomValidator(val string) bool {
return len(val) == 4
}
// ConfigValidation 配置验证
// - 定义验证场景
// - 也可以添加验证设置
func (f UserForm) ConfigValidation(v *validate.Validation) {
// v.StringRule()
v.WithScenes(validate.SValues{
"add": []string{"ExtInfo.Homepage", "Name", "Code"},
"update": []string{"ExtInfo.CityName", "Name"},
})
}
// Messages 您可以自定义验证器错误消息
func (f UserForm) Messages() map[string]string {
return validate.MS{
"required": "oh! the {field} is required",
"Name.required": "message for special field",
}
}
// Translates 你可以自定义字段翻译
func (f UserForm) Translates() map[string]string {
return validate.MS{
"Name": "用户名称",
"Email": "用户邮箱",
"ExtInfo.Homepage": "用户主页",
}
}
func main() {
u := &UserForm{
Name: "inhere",
}
// 创建 Validation 实例
v := validate.Struct(u)
// 或者使用
// v := validate.New(u)
if v.Validate() { // 验证成功
// do something ...
} else {
fmt.Println(v.Errors) // 所有的错误消息
fmt.Println(v.Errors.One()) // 返回随机一条错误消息
fmt.Println(v.Errors.Field("Name")) // 返回该字段的错误消息
}
}
Map
数据package main
import "fmt"
import "github.com/gookit/validate"
func main() {
m := map[string]interface{}{
"name": "inhere",
"age": 100,
"oldSt": 1,
"newSt": 2,
"email": "some@email.com",
}
v := validate.Map(m)
// v := validate.New(m)
v.AddRule("name", "required")
v.AddRule("name", "minLen", 7)
v.AddRule("age", "max", 99)
v.AddRule("age", "min", 1)
v.AddRule("email", "email")
// 也可以这样,一次添加多个验证器
v.StringRule("age", "required|int|min:1|max:99")
v.StringRule("name", "required|minLen:7")
// feat: 支持在 slice 中检查子项的值
v.StringRule("tags.*", "required|string|min_len:7")
// 设置不同场景验证不同的字段
// v.WithScenes(map[string]string{
// "create": []string{"name", "email"},
// "update": []string{"name"},
// })
if v.Validate() { // validate ok
// do something ...
} else {
fmt.Println(v.Errors) // all error messages
fmt.Println(v.Errors.One()) // returns a random error message text
}
}
传入 *http.Request
,快捷方法 FromRequest()
就会自动根据请求方法和请求数据类型收集相应的数据
GET/DELETE/...
等,会搜集 url query 数据POST/PUT/PATCH
并且类型为 application/json
会搜集JSON数据POST/PUT/PATCH
并且类型为 multipart/form-data
会搜集表单数据,同时会收集文件上传数据POST/PUT/PATCH
并且类型为 application/x-www-form-urlencoded
会搜集表单数据package main
import (
"fmt"
"net/http"
"github.com/gookit/validate"
)
func main() {
handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
data, err := validate.FromRequest(r)
if err != nil {
panic(err)
}
v := data.Create()
// setting rules
v.FilterRule("age", "int") // convert value to int
v.AddRule("name", "required")
v.AddRule("name", "minLen", 7)
v.AddRule("age", "max", 99)
if v.Validate() { // validate ok
// do something ...
} else {
fmt.Println(v.Errors) // all error messages
fmt.Println(v.Errors.One()) // returns a random error message text
}
})
http.ListenAndServe(":8090", handler)
}
快速创建 Validation
实例:
Request(r *http.Request) *Validation
JSON(s string, scene ...string) *Validation
Struct(s interface{}, scene ...string) *Validation
Map(m map[string]interface{}, scene ...string) *Validation
New(data interface{}, scene ...string) *Validation
快速创建 DataFace
实例:
FromMap(m map[string]interface{}) *MapData
FromStruct(s interface{}) (*StructData, error)
FromJSON(s string) (*MapData, error)
FromJSONBytes(bs []byte) (*MapData, error)
FromURLValues(values url.Values) *FormData
FromRequest(r *http.Request, maxMemoryLimit ...int64) (DataFace, error)
通过
DataFace
创建Validation
d := FromMap(map[string]interface{}{"key": "val"})
v := d.Validation()
Validation
常用方法:func (v *Validation) AtScene(scene string) *Validation
设置当前验证场景名func (v *Validation) Filtering() bool
应用所有过滤规则func (v *Validation) Validate() bool
应用所有验证和过滤规则,返回是否验证成功func (v *Validation) ValidateE() Errors
应用所有验证和过滤规则,并在失败时返回错误func (v *Validation) SafeData() map[string]interface{}
获取所有经过验证的数据func (v *Validation) BindSafeData(ptr interface{}) error
将验证后的安全数据绑定到一个结构体v.Errors
是一个Map数据,键是字段名,值是 map[string]string
。
// do validating
if v.Validate() {
return nil
}
// get errors
es := v.Errors
// check
es.Empty() // bool
// 返回一个随机的 error错误,如果没有错误返回 nil
fmt.Println(v.Errors.OneError())
fmt.Println(v.Errors.ErrOrNil())
fmt.Println(v.Errors) // all error messages
fmt.Println(v.Errors.One()) // returns a random error message text
fmt.Println(v.Errors.Field("Name")) // returns error messages of the field
错误转为JSON:
StopOnError=true
(默认),只会有一个错误:{
"field1": {
"required": "error msg0"
}
}
StopOnError=false
时,可能会返回多个错误:{
"field1": {
"minLen": "error msg1",
"required": "error msg0"
},
"field2": {
"min": "error msg2"
}
}
你可以通过改变全局选项设置,来调整验证器的一些处理逻辑。
// GlobalOption settings for validate
type GlobalOption struct {
// FilterTag 结构体中的过滤规则标签名称。默认 'filter`
FilterTag string
// ValidateTag 结构体中的验证规则标签名称。默认 'validate`
ValidateTag string
// FieldTag 定义结构体字段验证错误时的输出名字。默认使用 json
FieldTag string
// LabelTag 定义结构体字段验证错误时的输出翻译名称。默认使用 label
// - 等同于设置 字段 translate
LabelTag string
// MessageTag define error message for the field. default: message
MessageTag string
// StopOnError 如果为 true,则出现第一个错误时,将停止继续验证。默认 true
StopOnError bool
// SkipOnEmpty 跳过对字段不存在或值为空的检查。默认 true
SkipOnEmpty bool
// UpdateSource Whether to update source field value, useful for struct validate
UpdateSource bool
// CheckDefault Whether to validate the default value set by the user
CheckDefault bool
// CheckZero Whether validate the default zero value. (intX,uintX: 0, string: "")
CheckZero bool
// CheckSubOnParentMarked 当字段是一个结构体时,仅在当前字段配置了验证tag时才收集子结构体的规则
CheckSubOnParentMarked bool
}
如何配置:
// 更改全局选项
validate.Config(func(opt *validate.GlobalOption) {
opt.StopOnError = false
opt.SkipOnEmpty = false
})
import "github.com/gookit/validate/locales/zhcn"
// for all Validation.
// NOTICE: 必须在调用 validate.New() 前注册, 它只需要一次调用。
zhcn.RegisterGlobal()
// ... ...
v := validate.New()
// only for current Validation
zhcn.Register(v)
validate.AddGlobalMessages(map[string]string{
"minLength": "OO! {field} min length is %d",
})
v := validate.New(map[string]interface{}{
"name": "inhere",
})
v.StringRule("name", "required|string|minLen:7|maxLen:15")
v.AddMessages(map[string]string{
"minLength": "OO! {field} min length is %d",
"name.minLen": "OO! username min length is %d",
})
message, label
type UserForm struct {
Name string `validate:"required|minLen:7" label:"用户名称"`
Email string `validate:"email" message:"email is invalid" label:"用户邮箱"`
}
Messages()
方法添加// Messages you can custom validator error messages.
func (f UserForm) Messages() map[string]string {
return validate.MS{
"required": "oh! the {field} is required",
"Name.required": "message for special field",
}
}
validate
支持添加自定义验证器,并且支持添加 全局验证器
和 临时验证器
两种
func (f UserForm) CustomValidator(val string) bool
注意:验证器方法必须返回一个
bool
表明验证是否成功。第一个参数是对应的字段值,如果有额外参数则自动追加在后面
你可以一次添加一个或者多个自定义验证器
validate.AddValidator("myCheck0", func(val interface{}) bool {
// do validate val ...
return true
})
validate.AddValidators(M{
"myCheck1": func(val interface{}) bool {
// do validate val ...
return true
},
})
同样,你可以一次添加一个或者多个自定义验证器
v := validate.Struct(u)
v.AddValidator("myFunc3", func(val interface{}) bool {
// do validate val ...
return true
})
v.AddValidators(M{
"myFunc4": func(val interface{}) bool {
// do validate val ...
return true
},
})
validate
也允许添加自定义过滤器, 同样支持 全局过滤器
和 临时过滤器
两种
TIP: 对于过滤器函数,允许具有 1 个返回值
inteface{}
或 2 个返回值(inteface{},error)
的函数,其中第二个可以返回错误
你可以一次添加一个或者多个自定义过滤器
package main
import "github.com/gookit/validate"
func init() {
validate.AddFilter("myToIntFilter0", func(val interface{}) int {
// do filtering val ...
return 1
})
validate.AddFilters(validate.M{
"myToIntFilter1": func(val interface{}) (int, error) {
// do filtering val ...
return 1, nil
},
})
}
同样,你可以一次添加一个或者多个自定义过滤器
package main
import "github.com/gookit/validate"
func main() {
v := validate.New(&someStrcut{})
v.AddFilter("myToIntFilter0", func(val interface{}) int {
// do filtering val ...
return 1
})
v.AddFilters(validate.M{
"myToIntFilter1": func(val interface{}) (int, error) {
// do filtering val ...
return 1, nil
},
})
}
required
验证器允许自定义 required
验证器来自定义验证是否为空。但是,需注意验证器名称必须以 required
开头,例如 required_custom
。
type Data struct {
Age int `validate:"required_custom" message:"age is required"`
Name string `validate:"required"`
}
v := validate.New(&Data{
Name: "tom",
Age: 0,
})
v.AddValidator("required_custom", func(val interface{}) bool {
// do check value
return false
})
ok := v.Validate()
assert.False(t, ok)
可以在任何框架中使用 validate
,例如 Gin、Echo、Chi 等。 这里以 gin 示例:
package main
import (
"github.com/gin-gonic/gin/binding"
"github.com/gookit/validate"
)
// implements the binding.StructValidator
type customValidator struct {}
func (c *customValidator) ValidateStruct(ptr interface{}) error {
v := validate.Struct(ptr)
v.Validate() // 调用验证
return v.Errors
}
func (c *customValidator) Engine() interface{} {
return nil
}
func main() {
// ...
// after init gin, set custom validator
binding.Validator = &customValidator{}
}
几大类别:
TIP: 驼峰式的验证器名称现在都添加了下划线式的别名。因此
endsWith
也可以写为ends_with
验证器/别名 | 描述信息 |
---|---|
required |
字段为必填项,值不能为空 |
required_if/requiredIf |
required_if:anotherfield,value,... 如果其它字段 anotherField 为任一值 value ,则此验证字段必须存在且不为空。 |
required_unless/requiredUnless |
required_unless:anotherfield,value,... 如果其它字段 anotherField 不等于任一值 value ,则此验证字段必须存在且不为空。 |
required_with/requiredWith |
required_with:foo,bar,... 在其他任一指定字段出现时,验证的字段才必须存在且不为空 |
required_with_all/requiredWithAll |
required_with_all:foo,bar,... 只有在其他指定字段全部出现时,验证的字段才必须存在且不为空 |
required_without/requiredWithout |
required_without:foo,bar,... 在其他指定任一字段不出现时,验证的字段才必须存在且不为空 |
required_without_all/requiredWithoutAll |
required_without_all:foo,bar,... 只有在其他指定字段全部不出现时,验证的字段才必须存在且不为空 |
-/safe |
标记当前字段是安全的,无需验证 |
int/integer/isInt |
检查值是 intX uintX 类型,同时支持大小检查 "int" "int:2" "int:2,12" |
uint/isUint |
检查值是 uintX 类型(value >= 0 ) |
bool/isBool |
检查值是布尔字符串(true : "1", "on", "yes", "true", false : "0", "off", "no", "false"). |
string/isString |
检查值是字符串类型,同时支持长度检查 "string" "string:2" "string:2,12" |
float/isFloat |
检查值是 float(floatX ) 类型 |
slice/isSlice |
检查值是 slice 类型([]intX []uintX []byte []string 等). |
in/enum |
检查值()是否在给定的枚举列表([]string , []intX , []uintX )中 |
not_in/notIn |
检查值不是在给定的枚举列表中 |
contains |
检查输入值(string array/slice map )是否包含给定的值 |
not_contains/notContains |
检查输入值(string array/slice map )是否不包含给定值 |
string_contains/stringContains |
检查输入的 string 值是否不包含给定sub-string值 |
starts_with/startsWith |
检查输入的 string 值是否以给定sub-string开始 |
ends_with/endsWith |
检查输入的 string 值是否以给定sub-string结束 |
range/between |
检查值是否为数字且在给定范围内 |
max/lte |
检查输入值小于或等于给定值 |
min/gte |
检查输入值大于或等于给定值(for intX uintX floatX ) |
eq/equal/isEqual |
检查输入值是否等于给定值 |
ne/notEq/notEqual |
检查输入值是否不等于给定值 |
lt/lessThan |
检查值小于给定大小(use for intX uintX floatX ) |
gt/greaterThan |
检查值大于给定大小(use for intX uintX floatX ) |
int_eq/intEq/intEqual |
检查值为int且等于给定值 |
len/length |
检查值长度等于给定大小(use for string array slice map ). |
min_len/minLen/minLength |
检查值的最小长度是给定大小 |
max_len/maxLen/maxLength |
检查值的最大长度是给定大小 |
email/isEmail |
检查值是Email地址字符串 |
regex/regexp |
检查该值是否可以通过正则验证 |
arr/list/array/isArray |
检查值是 array 或者 slice 类型 |
map/isMap |
检查值是 map 类型 |
strings/isStrings |
检查值是字符串切片类型([]string ) |
ints/isInts |
检查值是int slice类型(only allow []int ) |
eq_field/eqField |
检查字段值是否等于另一个字段的值 |
ne_field/neField |
检查字段值是否不等于另一个字段的值 |
gte_field/gtField |
检查字段值是否大于另一个字段的值 |
gt_field/gteField |
检查字段值是否大于或等于另一个字段的值 |
lt_field/ltField |
检查字段值是否小于另一个字段的值 |
lte_field/lteField |
检查字段值是否小于或等于另一个字段的值 |
file/isFile |
验证是否是上传的文件 |
image/isImage |
验证是否是上传的图片文件,支持后缀检查 |
mime/mimeType/inMimeTypes |
验证是否是上传的文件,并且在指定的MIME类型中 |
date/isDate |
检查字段值是否为日期字符串。(只支持几种常用的格式) eg 2018-10-25 |
gt_date/gtDate/afterDate |
检查输入值是否大于给定的日期字符串 |
lt_date/ltDate/beforeDate |
检查输入值是否小于给定的日期字符串 |
gte_date/gteDate/afterOrEqualDate |
检查输入值是否大于或等于给定的日期字符串 |
lte_date/lteDate/beforeOrEqualDate |
检查输入值是否小于或等于给定的日期字符串 |
hasWhitespace |
检查字符串值是否有空格 |
ascii/ASCII/isASCII |
检查值是ASCII字符串 |
alpha/isAlpha |
验证值是否仅包含字母字符 |
alpha_num/alphaNum/isAlphaNum |
验证是否仅包含字母、数字 |
alpha_dash/alphaDash/isAlphaDash |
验证是否仅包含字母、数字、破折号( - )以及下划线( _ ) |
multi_byte/multiByte/isMultiByte |
检查值是多字节字符串 |
base64/isBase64 |
检查值是Base64字符串 |
dns_name/dnsName/DNSName/isDNSName |
检查值是DNS名称字符串 |
data_uri/dataURI/isDataURI |
Check value is DataURI string. |
empty/isEmpty |
检查值是否为空 |
hex_color/hexColor/isHexColor |
检查值是16进制的颜色字符串 |
hexadecimal/isHexadecimal |
检查值是十六进制字符串 |
json/JSON/isJSON |
检查值是JSON字符串。 |
lat/latitude/isLatitude |
检查值是纬度坐标 |
lon/longitude/isLongitude |
检查值是经度坐标 |
mac/isMAC |
检查值是MAC字符串 |
num/number/isNumber |
检查值是数字字符串. >= 0 |
cn_mobile/cnMobile/isCnMobile |
检查值是中国11位手机号码字符串 |
printableASCII/isPrintableASCII |
Check value is PrintableASCII string. |
rgbColor/RGBColor/isRGBColor |
检查值是RGB颜色字符串 |
full_url/fullUrl/isFullURL |
检查值是完整的URL字符串(必须以http,https开始的URL). |
url/URL/isURL |
检查值是URL字符串 |
ip/IP/isIP |
检查值是IP(v4或v6)字符串 |
ipv4/isIPv4 |
检查值是IPv4字符串 |
ipv6/isIPv6 |
检查值是IPv6字符串 |
cidr/CIDR/isCIDR |
检查值是 CIDR 字符串 |
CIDRv4/isCIDRv4 |
检查值是 CIDR v4 字符串 |
CIDRv6/isCIDRv6 |
检查值是 CIDR v6 字符串 |
uuid/isUUID |
检查值是UUID字符串 |
uuid3/isUUID3 |
检查值是UUID3字符串 |
uuid4/isUUID4 |
检查值是UUID4字符串 |
uuid5/isUUID5 |
检查值是UUID5字符串 |
filePath/isFilePath |
检查值是一个存在的文件路径 |
unixPath/isUnixPath |
检查值是Unix Path字符串 |
winPath/isWinPath |
检查值是Windows路径字符串 |
isbn10/ISBN10/isISBN10 |
检查值是ISBN10字符串 |
isbn13/ISBN13/isISBN13 |
检查值是ISBN13字符串 |
提示
intX
包含: int
, int8
, int16
, int32
, int64
uintX
包含: uint
, uint8
, uint16
, uint32
, uint64
floatX
包含: float32
, float64
Filters powered by: gookit/filter
过滤器/别名 | 描述信息 |
---|---|
int/toInt |
Convert value(string/intX/floatX) to int type v.FilterRule("id", "int") |
uint/toUint |
Convert value(string/intX/floatX) to uint type v.FilterRule("id", "uint") |
int64/toInt64 |
Convert value(string/intX/floatX) to int64 type v.FilterRule("id", "int64") |
float/toFloat |
Convert value(string/intX/floatX) to float type |
bool/toBool |
Convert string value to bool. (true : "1", "on", "yes", "true", false : "0", "off", "no", "false") |
trim/trimSpace |
Clean up whitespace characters on both sides of the string |
ltrim/trimLeft |
Clean up whitespace characters on left sides of the string |
rtrim/trimRight |
Clean up whitespace characters on right sides of the string |
int/integer |
Convert value(string/intX/floatX) to int type v.FilterRule("id", "int") |
lower/lowercase |
Convert string to lowercase |
upper/uppercase |
Convert string to uppercase |
lcFirst/lowerFirst |
Convert the first character of a string to lowercase |
ucFirst/upperFirst |
Convert the first character of a string to uppercase |
ucWord/upperWord |
Convert the first character of each word to uppercase |
camel/camelCase |
Convert string to camel naming style |
snake/snakeCase |
Convert string to snake naming style |
escapeJs/escapeJS |
Escape JS string. |
escapeHtml/escapeHTML |
Escape HTML string. |
str2ints/strToInts |
Convert string to int slice []int |
str2time/strToTime |
Convert date string to time.Time . |
str2arr/str2array/strToArray |
Convert string to string slice []string |
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。
1. 开源生态
2. 协作、人、软件
3. 评估模型