Go - validators 对 Struct 的字段校验

1、需求:

有时我们需要对接收到的struct字段内容进行验证,比如:

type Student struct {
    Uid   int64
    Name  string
    Age   int64
    Sex   string
    Email string
}
我们需要对结构体内的字段进行验证合法性:
  • Uid的值在某一个范围内
  • Name值的长度在某一个范围内
  • Sex的值符合男或女
  • Email格式正确等等
2、安装:

go get github.com/smokezl/govalidators

3、先来个简单例子,通过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"`
}
  • required 判断字段对应的值是否是对应类型的零值
  • 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
  • array、string 同 integer,array=?,? 表示元素个数范围,string=?,? 表示字符串长度范围
  • email 表示字段值是否是合法的email地址
  • url 表示字段值是否是合法的url地址
  • in 表示字段值在in指定的值中,比如 Hobby 字段中,in=swimming,running,drawing,表示 Hobby 字段的值,只能是swimming,running,drawing中的一个或多个
  • datetime 表示字段值符合日期类型,如果datetime后边不接=?,那么默认为Y-m-d H:i:s,否则验证器会按照指定格式判断,比如 datetime=Y-m、datetime=Y/m/d H:i:s等,可以是Y m d H i s 的随意拼接
  • unique 表示字段值唯一,比如 Hobby 字段的 unique,表示 Hobby 字段值唯一,Class 中,Cname 字段的 unique,表示 Cname 字段值唯一。
package main

import (
    "fmt"
    "github.com/smokezl/govalidators"
)

//把上面的两个Struct复制到此处

func 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)
        }
    }
    
}

func main() {
    goValidators()
}

执行结果:

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: validator user not exist
err: validator vm not exist
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

如果我们想把刚才的报错信息,都改为中文,那么就可以对每个验证器错误 msg 进行自定义:

//自定义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: validator user not exist
err: validator vm not exist
err: PersonalPage 不是一个有效的url地址
err: Hobby 的值必须为 [swimming running drawing] 中的一个
err: CreateTime 不是一个有效的日期
err: Cname 不是唯一的
err: BeginTime 不是一个有效的日期

在校验Struct时是根据下面链接中的文章做的,其中还有一些扩展目前还没有测。
更多详情点击:https://www.jianshu.com/p/64757be312a4

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,125评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,293评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,054评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,077评论 1 291
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,096评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,062评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,988评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,817评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,266评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,486评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,646评论 1 347
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,375评论 5 342
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,974评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,621评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,796评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,642评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,538评论 2 352

推荐阅读更多精彩内容