go validators用法详解 对struct字段进行参数验证

2023年8月20日 93次阅读 来源: smoke_zl

golang小菜一枚，业务中有对接口struct字段进行参数验证的需求，为了练手，自己造了个go validators验证器的轮子，代码在github，使用的详细方法写到这里，欢迎大大们提出宝贵建议，也希望大家在使用过程遇到问题来这提问

在编写golang接口时，需要对接收到的struct字段内容进行验证，比如
type Student struct {
 Uid   int64
 Name  string
 Age   int64
 Sex   string
 Email string
}

我们需要对结构体内的字段进行验证合法性:

  • Uid的值在某一个范围内
  • Name值的长度在某一个范围内
  • Sex的值符合男或女
  • Email格式正确等等
go validators可以对数据进行基本验证，也可高度定制

项目地址：https://github.com/smokezl/govalidators
介绍地址：https://www.jianshu.com/p/64757be312a4

安装方式
go get github.com/smokezl/govalidators
先来个简单例子，通过golang的structTag来配置验证器
type Class struct {
    Cid       int64  `validate:"required||integer=10000,_"`
    Cname     string `validate:"required||string=1,5||unique"`
    BeginTime string `validate:"required||datetime=H:i"`
}

type Student struct {
    Uid          int64    `validate:"required||integer=10000,_"`
    Name         string   `validate:"required||string=1,5"`
    Age          int64    `validate:"required||integer=10,30"`
    Sex          string   `validate:"required||in=male,female"`
    Email        string   `validate:"email||user||vm"`
    PersonalPage string   `validate:"url"`
    Hobby        []string `validate:"array=_,2||unique||in=swimming,running,drawing"`
    CreateTime   string   `validate:"datetime"`
    Class        []Class  `validate:"array=1,3"`
}
  1. required 判断字段对应的值是否是对应类型的零值
  2. integer 表示字段类型是否是整数类型，如果integer后边不接=?,?，那么表示只判断是否是整数类型，如果后边接=?,?，那么有四种写法
    (1). integer=10 表示字段值 = 10
    (2). integer=_ ,10 表示字段值 <= 10，字段值最小值为字段对应类型的最小值(比如字段对应类型为int8，那么最小为−128)，最大值为10
    (3). integer=10, _ 表示字段值 >= 10，字段值最小值为10，最大值为字段对应类型的最大值(比如字段对应类型为int8，那么最大为127)
    (4). integer=1,20 表示字段值 >=1 并且 <= 20
  3. array、string 同 integer，array=?,? 表示元素个数范围，string=?,? 表示字符串长度范围
  4. email 表示字段值是否是合法的email地址
  5. url 表示字段值是否是合法的url地址
  6. in 表示字段值在in指定的值中，比如 Hobby 字段中，in=swimming,running,drawing，表示 Hobby 字段的值，只能是swimming,running,drawing中的一个或多个
  7. datetime 表示字段值符合日期类型，如果datetime后边不接=?，那么默认为Y-m-d H:i:s，否则验证器会按照指定格式判断，比如 datetime=Y-m、datetime=Y/m/d H:i:s等，可以是Y m d H i s 的随意拼接
  8. unique 表示字段值唯一，比如 Hobby 字段的 unique，表示 Hobby 字段值唯一，Class 中，Cname 字段的 unique，表示 Cname 字段值唯一
介绍了各验证器的作用，现在来开始使用吧
import (
    "fmt"
    "github.com/smokezl/govalidators"
)

validator := govalidators.New()
student := &Student{
    Uid:          1234567,
    Name:         "张三1111",
    Age:          31,
    Sex:          "male1",
    Email:        "@qq.com",
    PersonalPage: "www.abcd.com",
    Hobby:        []string{"swimming", "singing"},
    CreateTime:   "2018-03-03 05:60:00",
    Class: []Class{
        Class{
            Cid:       12345678,
            Cname:     "语文",
            BeginTime: "13:00",
        },
        Class{
            Cid:       22345678,
            Cname:     "数学",
            BeginTime: "13:00",
        },
        Class{
            Cid:       32345678,
            Cname:     "数学",
            BeginTime: "13:60",
        },
    },
}
errList := validator.Validate(student)
if errList != nil {
    for _, err := range errList {
        fmt.Println("err:", err)
    }
}

执行结果：

err: Name should be betwween 1 and 5 chars long
err: Age should be betwween 10 and 30
err: Sex is not in params [male female]
err: Email is not a email address
err: PersonalPage is not a url
err: Hobby is not in params [swimming running drawing]
err: CreateTime is not a date time
err: Cname is not unique
err: BeginTime is not a date time
有时候，我们不需要将错误全部收集到，而是只要其中一个有错，那么就返回错误，可以用 LazyValidate 方法
err := validator.LazyValidate(student)
if err != nil {
    fmt.Println("err:", err)
}

执行结果：

err: Name should be betwween 1 and 5 chars long
我们还可以对报错信息、email 正则、url 正则进行自定义，先看下各个验证器可以自定义的参数
  1. 公共 Range 类型
type Range struct {
    Min string //最小值，外部可设置，支持0-9数字和 _ 符号，会将值赋值给 Range.min
    Max string //最大值，外部可设置，支持0-9数字和 _ 符号，会将值赋值给 Range.max
    min string //最小值，比对使用，支持0-9数字和 _ 符号，接收 Range.Min 和 struct 中传进来的值
    max string //最大值，比对使用，支持0-9数字和 _ 符号，接收 Range.Max 和 struct 中传进来的值

/**
 * 自定义范围判断错误 msg 格式，map 的 keys 有 lessThan,equal,atLeast,between 
 * 根据类型的不同，msg 文案也不同，[min] 表示 Range.min, [max] 表示 Range.max
 * var stringErrorMap = map[string]string{
 *   "lessThan": "[name] should be less than [max] chars long",
 *   "equal":    "[name] should be equal [min] chars long",
 *   "atLeast":  "[name] should be at least [min] chars long",
 *   "between":  "[name] should be betwween [min] and [max] chars long",
 * }
 * var numberErrorMap = map[string]string{
 *   "lessThan": "[name] should be less than [max]",
 *   "equal":    "[name] should be equal [min]",
 *   "atLeast":  "[name] should be at least [min]",
 *   "between":  "[name] should be betwween [min] and [max]",
 * }
 * var arrayErrorMap = map[string]string{
 *   "lessThan": "array [name] length should be less than [max]",
 *   "equal":    "array [name] length should be equal [min]",
 *   "atLeast":  "array [name] length should be at least [min]",
 *   "between":  "array [name] length should be betwween [min] and [max]",
 * }
 */
    RangeEMsg map[string]string
}
  1. required
type RequiredValidator struct {
    EMsg string //自定义错误 msg 格式，默认为 [name] is must required，[name] 表示属性名，下同
}
  1. string
type StringValidator struct {
    EMsg  string //自定义错误 msg 格式，默认为 [name] is not a string
    Range        //涉及到判断范围(字符串长度、数组长度、数字大小)验证器的公共属性
}
  1. integer
type IntegerValidator struct {
    EMsg  string //自定义错误 msg 格式，默认为 [name] is not a integer
    Range        //涉及到判断范围(字符串长度、数组长度、数字大小)验证器的公共属性
}
  1. array
type ArrayValidator struct {
    EMsg  string //自定义错误 msg 格式，默认为 [name] is not a array/map/slice
    Range        //涉及到判断范围(字符串长度、数组长度、数字大小)验证器的公共属性
}
  1. email
type EmailValidator struct {
    EMsg string //自定义错误 msg 格式，默认为 [name] is not a email address
    Reg  string //自定义 email 正则
}
  1. url
type UrlValidator struct {
    EMsg string //自定义错误 msg 格式，默认为 [name] is not a url
    Reg  string //自定义 url 正则
}
  1. in
type InValidator struct {
    EMsg     string //自定义错误 msg 格式，默认为 [name] is not in params [args]
    TypeEMsg string //自定义类型错误 msg 格式，默认为 [name] type invalid
}
  1. datetime
type DateTimeValidator struct {
    EMsg   string //自定义错误 msg 格式，默认为 [name] is not a date time
    FmtStr string //自定义Y m d H i s 组合，默认为 Y-m-d H:i:s
}
  1. unique
type UniqueValidator struct {
    EMsg string //自定义错误 msg 格式，默认为 [name] is not unique
}
如果我们想把刚才的报错信息，都改为中文，那么就可以对每个验证器错误 msg 进行自定义
validator := govalidators.New()
validator.SetValidators(map[string]interface{}{
    "string": &govalidators.StringValidator{
        Range: govalidators.Range{
            RangeEMsg: map[string]string{
                "between": "[name] 长度必须在 [min] 和 [max] 之间",
            },
        },
    },
    "integer": &govalidators.IntegerValidator{
        Range: govalidators.Range{
            RangeEMsg: map[string]string{
                "between": "[name] 的值必须在 [min] 和 [max] 之间",
            },
        },
    },
    "in": &govalidators.InValidator{
        EMsg: "[name] 的值必须为 [args] 中的一个",
    },
    "email": &govalidators.EmailValidator{
        EMsg: "[name] 不是一个有效的email地址",
    },
    "url": &govalidators.UrlValidator{
        EMsg: "[name] 不是一个有效的url地址",
    },
    "datetime": &govalidators.DateTimeValidator{
        EMsg: "[name] 不是一个有效的日期",
    },
    "unique": &govalidators.UniqueValidator{
        EMsg: "[name] 不是唯一的",
    },
})
errList := validator.Validate(student)
if errList != nil {
    for _, err := range errList {
        fmt.Println("err:", err)
    }
}

执行结果：

err: Name 长度必须在 1 和 5 之间
err: Age 的值必须在 10 和 30 之间
err: Sex 的值必须为 [male female] 中的一个
err: Email 不是一个有效的email地址
err: PersonalPage 不是一个有效的url地址
err: Hobby 的值必须为 [swimming running drawing] 中的一个
err: CreateTime 不是一个有效的日期
err: Cname 不是唯一的
err: BeginTime 不是一个有效的日期
如果现有的验证器不够用，还可以进行自定义，只需要满足 ValidatorF 函数类型 或 Validator 接口就可以

ValidatorF 类型

type ValidatorF func(params map[string]interface{}, val reflect.Value, args ...string) (bool, error)

Validator 接口

type Validator interface {
    Validate(params map[string]interface{}, val reflect.Value, args ...string) (bool, error)
}

例子

type UserValidator struct {
    EMsg string
}

func (self *UserValidator) Validate(params map[string]interface{}, val reflect.Value, args ...string) (bool, error) {
    fmt.Println("=====", "UserValidator")
    return true, nil
}

func userMethod(params map[string]interface{}, val reflect.Value, args ...string) (bool, error) {
    fmt.Println("=====", "userMethod")
    return true, nil
}
validator.SetValidators(map[string]interface{}{
    "user": &UserValidator{},
    "vm":   userMethod,
})
errList := validator.Validate(student)
if errList != nil {
    for _, err := range errList {
        fmt.Println("err:", err)
    }
}

struct 中，增加 user 和 vm 验证

Email        string   `validate:"email||user||vm"`

执行结果：

===== UserValidator
===== userMethod

目前 govalidators 的使用已经说完了，项目地址为 https://github.com/smokezl/govalidators，govalidators 欢迎大大们提出宝贵意见

    原文作者：smoke_zl
    原文地址: https://www.jianshu.com/p/64757be312a4
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞