validator

Documentation

Index

• type Translation
• type Translator
  • func ENTranslator() Translator
  • func ZHTranslator() Translator
  • func (translator Translator) RegisterDefaultTranslations(v *validator.Validate, trans ut.Translator) (err error)
• type ValidErrors
  • func (validErrors *ValidErrors) Add(key, value string)
  • func (validErrors *ValidErrors) Error() string
  • func (validErrors *ValidErrors) IsValid() bool
  • func (validErrors *ValidErrors) String() (errString string)
• type Validation
• type ValidationErrors
  • func (ve ValidationErrors) Translate(locales ...string) validator.ValidationErrorsTranslations
• type Validator
  • func New(translators ...Translation) *Validator
  • func (v *Validator) Bind(c *gin.Context, param interface{}) *ValidErrors
  • func (v *Validator) Engine() interface{}
  • func (v *Validator) GetTranslator(locale string) ut.Translator
  • func (v *Validator) OnChange(viper *viper.Viper)
  • func (v *Validator) RegisterDefaultTranslations(locale string, ...) error
  • func (v *Validator) RegisterTagNameFunc(tags ...string)
  • func (v *Validator) RegisterValidation(validation Validation) error
  • func (v *Validator) SetTagName(tag string)
  • func (v *Validator) ValidateStruct(obj interface{}) error

Types

type Translation

type Translation interface {
	locales.Translator
	RegisterDefaultTranslations(v *validator.Validate, trans ut.Translator) (err error)
}

Translation translation interface

type Translator

type Translator struct {
	locales.Translator
}

Translator one-layer encapsulation of github.com/go-playground/locales

func ENTranslator

func ENTranslator() Translator

ENTranslator English translator

func ZHTranslator

func ZHTranslator() Translator

ZHTranslator chinese translator

func (Translator) RegisterDefaultTranslations

func (translator Translator) RegisterDefaultTranslations(v *validator.Validate, trans ut.Translator) (err error)

RegisterDefaultTranslations locale

type ValidErrors

type ValidErrors struct {
	ErrorsInfo map[string]string
	// contains filtered or unexported fields
}

ValidErrors 验证之后的错误信息

func (*ValidErrors) Add

func (validErrors *ValidErrors) Add(key, value string)

Add 添加错误信息

func (*ValidErrors) Error

func (validErrors *ValidErrors) Error() string

Error return valid error's string

func (*ValidErrors) IsValid

func (validErrors *ValidErrors) IsValid() bool

IsValid 是否验证成功

func (*ValidErrors) String

func (validErrors *ValidErrors) String() (errString string)

String return valid error's string

type Validation

type Validation interface {
	Tag() string
	Validate(fl validator.FieldLevel) bool
	CallValidationEvenIfNull() bool
	Locale() string
	TranslateTmpl(ut ut.Translator) error
	TranslateParameters(ut ut.Translator, fe validator.FieldError) string
}

Validation custom validation interface

type ValidationErrors

type ValidationErrors struct {
	validator.ValidationErrors
	// contains filtered or unexported fields
}

ValidationErrors 对验证错误的一层封装

func (ValidationErrors) Translate

func (ve ValidationErrors) Translate(locales ...string) validator.ValidationErrorsTranslations

Translate localize errors after validation

type Validator

type Validator struct {
	// contains filtered or unexported fields
}

Validator validator

func New

func New(translators ...Translation) *Validator

New 获取验证器对象 translators 必须传值, 第一个值将作为默认值

func (*Validator) Bind

func (v *Validator) Bind(c *gin.Context, param interface{}) *ValidErrors

Bind gin controller

func (*Validator) Engine

func (v *Validator) Engine() interface{}

Engine 获取验证器

func (*Validator) GetTranslator

func (v *Validator) GetTranslator(locale string) ut.Translator

GetTranslator get translator

func (*Validator) OnChange

func (v *Validator) OnChange(viper *viper.Viper)

OnChange 配置发生变动时重新初始化

func (*Validator) RegisterDefaultTranslations

func (v *Validator) RegisterDefaultTranslations(locale string, translation func(v *validator.Validate, trans ut.Translator) (err error)) error

RegisterDefaultTranslations custom translation

func (*Validator) RegisterTagNameFunc

func (v *Validator) RegisterTagNameFunc(tags ...string)

RegisterTagNameFunc custom tag name

func (*Validator) RegisterValidation

func (v *Validator) RegisterValidation(validation Validation) error

RegisterValidation set custom validation

func (*Validator) SetTagName

func (v *Validator) SetTagName(tag string)

SetTagName set validator 获取验证规则的结构体 tag name

func (*Validator) ValidateStruct

func (v *Validator) ValidateStruct(obj interface{}) error

ValidateStruct 验证结构体

Can be asserted as ValidationErrors,  if the err returned by validation is validator.ValidationErrors, Will be forced to ValidationErrors