Golang 数据验证框架 validate 使用指南

validate 是 Go 语言中一个流行的数据验证库，它提供了结构体标签的方式来定义验证规则。下面我将详细介绍如何使用这个库。

安装

首先安装 validate 库：

go get github.com/go-playground/validator/v10

基本用法

package main

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

type User struct {
	FirstName      string     `validate:"required"`
	LastName       string     `validate:"required"`
	Age            uint8      `validate:"gte=0,lte=130"`
	Email          string     `validate:"required,email"`
	FavouriteColor string     `validate:"iscolor"`                // alias for 'hexcolor|rgb|rgba|hsl|hsla'
	Addresses      []*Address `validate:"required,dive,required"` // dive 表示深入验证嵌套结构
}

type Address struct {
	Street string `validate:"required"`
	City   string `validate:"required"`
	Planet string `validate:"required"`
	Phone  string `validate:"required"`
}

func main() {
	validate := validator.New()

	user := &User{
		FirstName:      "Badger",
		LastName:       "Smith",
		Age:            135,
		Email:          "Badger.Smith@gmail.com",
		FavouriteColor: "#000-",
		Addresses: []*Address{
			{
				Street: "Eavesdown Docks",
				Planet: "Persphone",
				Phone:  "none",
			},
		},
	}

	err := validate.Struct(user)
	if err != nil {
		for _, err := range err.(validator.ValidationErrors) {
			fmt.Println(err.Namespace()) // 字段全路径
			fmt.Println(err.Field())     // 字段名
			fmt.Println(err.StructNamespace())
			fmt.Println(err.StructField())
			fmt.Println(err.Tag())       // 验证标签
			fmt.Println(err.ActualTag())// 实际使用的验证标签
			fmt.Println(err.Kind())      // 字段类型
			fmt.Println(err.Type())     // 字段类型
			fmt.Println(err.Value())     // 字段值
			fmt.Println(err.Param())     // 验证参数
			fmt.Println()
		}
	}
}

常用验证标签

自定义验证

可以注册自定义验证函数：

package main

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

// 自定义验证函数
func validateVATNumber(fl validator.FieldLevel) bool {
	vatNumber := fl.Field().String()
	// 这里实现你的验证逻辑
	return len(vatNumber) == 10
}

type Invoice struct {
	VATNumber string `validate:"vatnumber"`
}

func main() {
	validate := validator.New()
	
	// 注册自定义验证函数
	err := validate.RegisterValidation("vatnumber", validateVATNumber)
	if err != nil {
		panic(err)
	}

	invoice := &Invoice{
		VATNumber: "1234567890",
	}

	err = validate.Struct(invoice)
	if err != nil {
		fmt.Println(err)
	} else {
		fmt.Println("验证通过")
	}
}

国际化错误消息

validate 支持错误消息的国际化：

package main

import (
	"fmt"
	"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 User struct {
	Username string `validate:"required"`
	Email    string `validate:"required,email"`
}

func main() {
	// 中文翻译器
	zh_ch := zh.New()
	uni := ut.New(zh_ch, zh_ch)
	trans, _ := uni.GetTranslator("zh")
	
	validate := validator.New()
	// 注册中文翻译
	zh_translations.RegisterDefaultTranslations(validate, trans)
	
	user := User{
		Username: "",
		Email:    "invalid_email",
	}
	
	err := validate.Struct(user)
	if err != nil {
		errs := err.(validator.ValidationErrors)
		for _, e := range errs {
			// 翻译错误信息
			fmt.Println(e.Translate(trans))
		}
	}
}

验证单个值

除了验证结构体，也可以验证单个值：

package main

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

func main() {
	validate := validator.New()
	
	// 验证单个字符串
	err := validate.Var("example@gmail.com", "required,email")
	if err != nil {
		fmt.Println(err)
	}
	
	// 验证数字范围
	err = validate.Var(15, "gte=10,lte=20")
	if err != nil {
		fmt.Println(err)
	}
}

性能考虑

validate 库在性能上做了很多优化，但在高频场景下仍有一些建议：

1. 重用 validator 实例（它是并发安全的）
2. 避免在热路径上频繁创建 validator 实例
3. 对于简单验证，可以考虑直接使用标准库函数

validate 是一个功能强大且灵活的数据验证库，适合大多数 Go 应用程序的数据验证需求。