validator

Index

• 安装
• 常用验证规则
• 基本使用
• 自定义验证
• 错误信息转中文

安装

• 验证器 go get github.com/go-playground/validator/v10
• 翻译
  1. go get github.com/go-playground/universal-translator
  2. github.com/go-playground/locales

常用内置验证规则

基本使用

package main

import (
	"fmt"
	"github.com/go-playground/validator/v10"
)

type Data struct {
	Name       string `validate:"required" label:"姓名"`
	Age        uint   `validate:"gte=0,lte=100" label:"年龄"`
	Password   string `validate:"required,alphanum,min=6" label:"密码"`
	RePassword string `validate:"eqfield=Password" label:"重密密码"`
}

var (
	validate = validator.New()
	d        = &Data{
		Name:       "",
		Age:        101,
		Password:   "a123456",
		RePassword: "a123456",
	}
)

func example() {
	if err := validate.Struct(d); err != nil {
		for _, v := range err.(validator.ValidationErrors) {
			// v.Field() 表示验证失败的字段
			// v.Value() 表示验证失败所传入的值
			// v.Tag() 表示导致验证失败的规则
			// v.Param() 表示导致验证失败的规则所定义的参数，例如 gt=1，若是实际的值小于 1 ，则返回 1
			fmt.Println(v.Value())
		}
		return
	}

	fmt.Println("success")
}

自定义验证

package main

import (
	"fmt"
	"log"
	"github.com/go-playground/validator/v10"
)

var validate = validator.New()

// 自定义验证，返回 bool 决定了验证是否通过
//	fl validator.FieldLevel 包含了字段的所有信息以及相关的助手函数
func MyValidation(fl validator.FieldLevel) bool {
	if fl.Field().String() == "jack" {
		return true
	} else {
		return false
	}
}

// 自定义验证示例
func customValidationExample() {

	type tmp struct {
		Name       string `validate:"required,myValidation"`
		Age        uint   `validate:"gte=0,lte=100"`
		Password   string `validate:"required,alphanum,min=6"`
		RePassword string `validate:"eqfield=Password"`
	}

	t := &tmp{
		Name:       "pony",
		Age:        101,
		Password:   "a123456",
		RePassword: "a123456",
	}

	// RegisterValidation(tag string, fn validator.Func, callValidationEvenIfNull ...bool) 用于注册自定义验证
	if err := validate.RegisterValidation("myValidation", MyValidation); err != nil {
		log.Fatalln(err)
	}

	if err := validate.Struct(t); err != nil {
		fmt.Println(err)
		return
	}
	fmt.Println("success")
}

错误信息转中文

package main

import (
	"fmt"
	"log"
	"reflect"

	"github.com/go-playground/locales/zh"
	ut "github.com/go-playground/universal-translator"
	"github.com/go-playground/validator/v10"
	zh_translations "github.com/go-playground/validator/v10/translations/zh"
)

type Data struct {
	Name       string `validate:"required" label:"姓名"`
	Age        uint   `validate:"gte=0,lte=100" label:"年龄"`
	Password   string `validate:"required,alphanum,min=6" label:"密码"`
	RePassword string `validate:"eqfield=Password" label:"重密密码"`
}

var (
	validate = validator.New()
	d        = &Data{
		Name:       "",
		Age:        101,
		Password:   "a123456",
		RePassword: "a123456",
	}
)

func zhExample() {

	uni := ut.New(zh.New()) // 万能翻译器，保存所有的语言环境和翻译数据
	trans, _ := uni.GetTranslator("zh")

	// 验证器注册翻译器
	if err := zh_translations.RegisterDefaultTranslations(validate, trans); err != nil {
		log.Fatalln(err)
	}

	// 注册 tag 作为错误信息的字段名，此处设置 tag 为 label
	validate.RegisterTagNameFunc(func(field reflect.StructField) string {
		return field.Tag.Get("label")
	})

	err := validate.Struct(d)
	if err != nil {
		// 获取经过翻译的验证错误 map
		// err.(validator.ValidationErrors).Translate(trans)

		// 逐条翻译
		for _, v := range err.(validator.ValidationErrors) {
			fmt.Println(v.Translate(trans))
		}
	}
}