go validators用法詳解 對struct字段進行參數驗證
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可以對數據進行基本驗證,也可高度定制.
安裝方式如下
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"`}
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 并且 <= 20array
、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 字段值唯一
介紹了各驗證器的作用,現在來開始使用吧
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 正則進行自定義,先看下各個驗證器可以自定義的參數
公共 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
}
required
type RequiredValidator struct {
EMsg string //自定義錯誤 msg 格式,默認為 [name] is must required,[name] 表示屬性名,下同
}
string
type StringValidator struct {
EMsg string //自定義錯誤 msg 格式,默認為 [name] is not a string
Range //涉及到判斷范圍(字符串長度、數組長度、數字大小)驗證器的公共屬性
}
integer
type IntegerValidator struct {
EMsg string //自定義錯誤 msg 格式,默認為 [name] is not a integer
Range //涉及到判斷范圍(字符串長度、數組長度、數字大小)驗證器的公共屬性
}
array
type ArrayValidator struct {
EMsg string //自定義錯誤 msg 格式,默認為 [name] is not a array/map/slice
Range //涉及到判斷范圍(字符串長度、數組長度、數字大小)驗證器的公共屬性
}
email
type EmailValidator struct {
EMsg string //自定義錯誤 msg 格式,默認為 [name] is not a email address
Reg string //自定義 email 正則
}
url
type UrlValidator struct {
EMsg string //自定義錯誤 msg 格式,默認為 [name] is not a url
Reg string //自定義 url 正則
}
in
type InValidator struct {
EMsg string //自定義錯誤 msg 格式,默認為 [name] is not in params [args]
TypeEMsg string //自定義類型錯誤 msg 格式,默認為 [name] type invalid
}
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
}
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
來源https://www.cnblogs.com/yangxinpython/p/13161454.html