中文说明

Go Doc

Validate Struct

Config the struct use tags

package mainimport ("fmt""time""github.com/gookit/validate")// UserForm structtypeUserFormstruct {Namestring`validate:"required|min_len:7" message:"required:{field} is required" label:"User Name"`Emailstring`validate:"email" message:"email is invalid" label:"User Email"`Ageint`validate:"required|int|min:1|max:99" message:"int:age must int|min:age min value is 1"`CreateAtint`validate:"min:1"`Safeint`validate:"-"`UpdateAt time.Time`validate:"required" message:"update time is required"`Codestring`validate:"customValidator"`// ExtInfo nested structExtInfostruct{Homepagestring`validate:"required" label:"Home Page"`CityNamestring}`validate:"required" label:"Home Page"`}// CustomValidator custom validator in the source struct.func (fUserForm)CustomValidator(valstring)bool {returnlen(val)==4}

Config validate use struct methods

package mainimport ("fmt""time""github.com/gookit/validate")// UserForm structtypeUserFormstruct {Namestring`validate:"required|min_len:7"`Emailstring`validate:"email"`Ageint`validate:"required|int|min:1|max:99"`CreateAtint`validate:"min:1"`Safeint`validate:"-"`UpdateAt time.Time`validate:"required"`Codestring`validate:"customValidator"`// ExtInfo nested structExtInfostruct{Homepagestring`validate:"required"`CityNamestring}`validate:"required"`}// CustomValidator custom validator in the source struct.func (fUserForm)CustomValidator(valstring)bool {returnlen(val)==4}// ConfigValidation config the Validation// eg:// - define validate scenesfunc (fUserForm)ConfigValidation(v*validate.Validation) {v.WithScenes(validate.SValues{"add":    []string{"ExtInfo.Homepage","Name","Code"},"update": []string{"ExtInfo.CityName","Name"},})}// Messages you can custom validator error messages.func (fUserForm)Messages()map[string]string {return validate.MS{"required":"oh! the {field} is required","email":"email is invalid","Name.required":"message for special field","Age.int":"age must int","Age.min":"age min value is 1",}}// Translates you can custom field translates.func (fUserForm)Translates()map[string]string {return validate.MS{"Name":"User Name","Email":"User Email","ExtInfo.Homepage":"Home Page",}}

Create and validating

package mainimport ("fmt""github.com/gookit/validate")funcmain() {u:=&UserForm{Name:"inhere",}v:=validate.Struct(u)// v := validate.New(u)ifv.Validate() {// validate ok// do something ...}else {fmt.Println(v.Errors)// all error messagesfmt.Println(v.Errors.One())// returns a random error message textfmt.Println(v.Errors.OneError())// returns a random errorfmt.Println(v.Errors.Field("Name"))// returns error messages of the field}}

Validate Map

package mainimport ("fmt""github.com/gookit/validate")funcmain()  {m:=map[string]any{"name":"inhere","age":100,"oldSt":1,"newSt":2,"email":"some@email.com","tags": []string{"go","php","java"},}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")// can alsov.StringRule("age","required|int|min:1|max:99")v.StringRule("name","required|minLen:7")v.StringRule("tags","required|slice|minlen:1")// feat: support check sub-item in slicev.StringRule("tags.*","required|string|min_len:7")// v.WithScenes(map[string]string{// "create": []string{"name", "email"},// "update": []string{"name"},// })ifv.Validate() {// validate oksafeData:=v.SafeData()// do something ...}else {fmt.Println(v.Errors)// all error messagesfmt.Println(v.Errors.One())// returns a random error message text}}

Validate Request

package mainimport ("fmt""net/http""time""github.com/gookit/validate")// UserForm structtypeUserFormstruct {NamestringEmailstringAgeintCreateAtintSafeintUpdateAt time.TimeCodestring}funcmain()  {handler:=http.HandlerFunc(func(w http.ResponseWriter,r*http.Request) {data,err:=validate.FromRequest(r)iferr!=nil {panic(err)}v:=data.Create()// setting rulesv.FilterRule("age","int")// convert value to intv.AddRule("name","required")v.AddRule("name","minLen",7)v.AddRule("age","max",99)v.StringRule("code",`required|regex:\d{4,6}`)ifv.Validate() {// validate ok// safeData := v.SafeData()userForm:=&UserForm{}v.BindSafeData(userForm)// do something ...fmt.Println(userForm.Name)}else {fmt.Println(v.Errors)// all error messagesfmt.Println(v.Errors.One())// returns a random error message text}})http.ListenAndServe(":8090",handler)}

Quick Method

d:=FromMap(map[string]any{"key":"val"})v:=d.Validation()

Methods In Validation

More Usage

Validate Error

// do validatingifv.Validate() {returnnil}// get errorses:=v.Errors// checkes.Empty()// bool// returns an random error, if no error returns nilfmt.Println(v.Errors.OneError())fmt.Println(v.Errors.ErrOrNil())fmt.Println(v.Errors)// all error messagesfmt.Println(v.Errors.One())// returns a random error message textfmt.Println(v.Errors.Field("Name"))// returns error messages of the field

{"field1": {"required":"error msg0"    }}

{"field1": {"minLen":"error msg1","required":"error msg0"    },"field2": {"min":"error msg2"    }}

Global Option

// GlobalOption settings for validatetypeGlobalOptionstruct {// FilterTag name in the struct tags.//// default: filterFilterTagstring// ValidateTag in the struct tags.//// default: validateValidateTagstring// FieldTag the output field name in the struct tags.// it as placeholder on error message.//// default: jsonFieldTagstring// LabelTag the display name in the struct tags.// use for define field translate name on error.//// default: labelLabelTagstring// MessageTag define error message for the field.//// default: messageMessageTagstring// StopOnError If true: An error occurs, it will cease to continue to verifyStopOnErrorbool// SkipOnEmpty Skip check on field not exist or value is emptySkipOnEmptybool// UpdateSource Whether to update source field value, useful for struct validateUpdateSourcebool// CheckDefault Whether to validate the default value set by the userCheckDefaultbool// CheckZero Whether validate the default zero value. (intX,uintX: 0, string: "")CheckZerobool// CheckSubOnParentMarked True: only collect sub-struct rule on current field has rule.CheckSubOnParentMarkedbool// ValidatePrivateFields Whether to validate private fields or not, especially when inheriting other other structs.////  type foo struct {//  Field int `json:"field" validate:"required"`//  }//  type bar struct {//    foo // <-- validate this field//    Field2 int `json:"field2" validate:"required"`//  }//// default: falseValidatePrivateFieldsbool}

// change global optsvalidate.Config(func(opt*validate.GlobalOption) {opt.StopOnError=falseopt.SkipOnEmpty=false})

Validating Private (Unexported fields)

typefoostruct {somefieldint}typeBarstruct {fooSomeOtherFieldstring}

validate.Config(func(opt*validate.GlobalOption) {opt.ValidatePrivateFields=true})

Custom Error Messages

import"github.com/gookit/validate/locales/zhcn"// for all Validation.// NOTICE: must be registered before on validate.New(), it only need call at once.zhcn.RegisterGlobal()// ... ...v:=validate.New()// only for current Validationzhcn.Register(v)

validate.AddGlobalMessages(map[string]string{"minLength":"OO! {field} min length is %d",})

v:=validate.New(map[string]any{"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",})

typeUserFormstruct {Namestring`validate:"required|minLen:7" label:"User Name"`Emailstring`validate:"email" message:"email is invalid" label:"User Email"`}

// Messages you can custom validator error messages.func (fUserForm)Messages()map[string]string {return validate.MS{"required":"oh! the {field} is required","Name.required":"message for special field",}}

Add Custom Validator

Add Global Validator

validate.AddValidator("myCheck0",func(valany)bool {// do validate val ...returntrue})validate.AddValidators(validate.M{"myCheck1":func(valany)bool {// do validate val ...returntrue},})

Add Temporary Validator

v:=validate.Struct(u)v.AddValidator("myFunc3",func(valany)bool {// do validate val ...returntrue})v.AddValidators(validate.M{"myFunc4":func(valany)bool {// do validate val ...returntrue},})

Add Custom Filter

Add Global Filter

package mainimport"github.com/gookit/validate"funcinit() {validate.AddFilter("myToIntFilter0",func(valany)int {// do filtering val ...return1})validate.AddFilters(validate.M{"myToIntFilter1":func(valany) (int,error) {// do filtering val ...return1,nil},})}

Add Temporary Filter

package mainimport"github.com/gookit/validate"funcmain() {v:=validate.New(&someStrcut{})v.AddFilter("myToIntFilter0",func(valany)int {// do filtering val ...return1})v.AddFilters(validate.M{"myToIntFilter1":func(valany) (int,error) {// do filtering val ...return1,nil},})// use the added filterv.FilterRule("field","myToIntFilter0")}

Customrequired validation

typeDatastruct {Ageint`validate:"required_custom" message:"age is required"`Namestring`validate:"required"`}v:=validate.New(&Data{Name:"tom",Age:0,})v.AddValidator("required_custom",func(valany)bool {// do check valuereturnfalse})ok:=v.Validate()assert.False(t,ok)

Use on gin framework

package mainimport ("github.com/gin-gonic/gin/binding""github.com/gookit/validate")// implements the binding.StructValidatortypecustomValidatorstruct {}func (c*customValidator)ValidateStruct(ptrany)error {v:=validate.Struct(ptr)v.Validate()// do validatingifv.Errors.Empty() {returnnil    }returnv.Errors}func (c*customValidator)Engine()any {returnnil}funcmain()  {// ...// after init gin, set custom validatorbinding.Validator=&customValidator{}}

Built In Validators

Built In Filters

Gookit packages

See also

License