在web开发过程中,我们经常需要校验前端传过来的值是否合法,这时可以用validator进行校验
这里用到的是tag,像这样:
type User struct {
Name string `json:"name" validate:"min=0,max=35"`
Age unit8 `json:"age" validate:"lte=90,gte=0"`
}
标记之间特殊符号说明
- 逗号( ,):把多个验证标记隔开。注意:隔开逗号之间不能有空格, validate:“lt=0,gt=100”,逗号那里不能有空格,否则panic
- 横线( - ):跳过该字段不验证
- 竖线( | ):使用多个验证标记,但是只需满足其中一个即可
- required:表示该字段值必输设置,且不能为默认值
- omitempty:如果字段未设置,则忽略它
一些验证的例子说明
字符串验证
doc: https://github.com/go-playground/validator/blob/master/README.md#strings
- contains:包含参数子串,validate:“contains=tom” (字段的字符串值包含tom)
- excludes:包含参数子串,validate:“excludes=tom” (字段的字符串值不包含tom)
- startswith:以参数子串为前缀,validate:“startswith=golang”
- endswith:以参数子串为后缀,validate:“startswith=world”
范围验证: 切片、数组和map、字符串,验证其长度;数值,验证大小范围
- lte:小于等于参数值,validate:“lte=3” (小于等于3)
- gte:大于等于参数值,validate:“lte=120,gte=0” (大于等于0小于等于120)
- lt:小于参数值,validate:“lt=3” (小于3) gt:大于参数值,validate:“lt=120,gt=0”
- (大于0小于120) len:等于参数值,validate:“len=2”
- max:最大值,小于等于参数值,validate:“max=20” (小于等于20)
- min:最小值,大于等于参数值,validate:“min=2,max=20” (大于等于2小于等于20)
- ne:不等于,validate:“ne=2” (不等于2)
- oneof:只能是列举出的值其中一个,这些值必须是数值或字符串,以空格分隔,如果字符串中有空格,将字符串用单引号包围,validate:“oneof=red
green”
当然,还有其他很多用用法,如IP校验、也可以自定义校验,大家可自行前往官网学习。
下面写两个简单的demo演示如何使用:
例子一:验证单个字段变量值
package main
import (
"fmt"
"github.com/go-playground/validator"
)
func main() {
validate := validator.New()
var boolTest bool
err := validate.Var(boolTest, "required")
if err != nil {
fmt.Println(err)
}
var stringTest string = ""
err = validate.Var(stringTest, "required")
if err != nil {
fmt.Println(err)
}
var emailTest string = "test@126.com"
err = validate.Var(emailTest, "email")
if err != nil {
fmt.Println(err)
} else {
fmt.Println("success") // 输出: success。 说明验证成功
}
emailTest2 := "test.126.com"
errs := validate.Var(emailTest2, "required,email")
if errs != nil {
fmt.Println(errs) // 输出: Key: "" Error:Field validation for "" failed on the "email" tag。验证失败
}
fmt.Println("\r\nEnd!!")
}
例子二:验证结构体struct
package main
import (
"fmt"
"github.com/go-playground/validator/v10"
)
type User struct {
FirstName string `validate:"required"`
LastName string `validate:"required"`
Age uint8 `validate:"gte=0,lte=130"`
Email string `validate:"required,email"`
Addresses []*Address `validate:"required,dive,required"`
}
type Address struct {
Street string `validate:"required"`
City string `validate:"required"`
Planet string `validate:"required"`
Phone string `validate:"required"`
}
func main() {
address := &Address{
Street: "Eavesdown Docks",
Planet: "Persphone",
Phone: "none",
}
user := &User{
FirstName: "Badger",
LastName: "Smith",
Age: 135,
Email: "Badger.Smith@gmail.com",
Addresses: []*Address{address},
}
validate := validator.New()
err := validate.Struct(user)
if err != nil {
fmt.Println("=== error msg ====")
fmt.Println(err)
if _, ok := err.(*validator.InvalidValidationError); ok {
fmt.Println(err)
return
}
fmt.Println("\r\n=========== error field info ====================")
for _, err := range err.(validator.ValidationErrors) {
// 列出效验出错字段的信息
fmt.Println("Namespace: ", err.Namespace())
fmt.Println("Fild: ", err.Field())
fmt.Println("StructNamespace: ", err.StructNamespace())
fmt.Println("StructField: ", err.StructField())
fmt.Println("Tag: ", err.Tag())
fmt.Println("ActualTag: ", err.ActualTag())
fmt.Println("Kind: ", err.Kind())
fmt.Println("Type: ", err.Type())
fmt.Println("Value: ", err.Value())
fmt.Println("Param: ", err.Param())
fmt.Println()
}
// from here you can create your own error messages in whatever language you wish
return
}
}