Go轻量级结构体验证库 - gody 使用指南

gody 是一个轻量级的 Go 结构体验证库，它简单易用且不依赖反射，适合需要快速验证结构体数据的场景。

安装

go get github.com/guiferpa/gody

基本使用

1. 简单验证

package main

import (
	"fmt"
	"github.com/guiferpa/gody"
)

type User struct {
	Name  string `json:"name" validate:"not_empty"`
	Email string `json:"email" validate:"not_empty,email"`
	Age   int    `json:"age" validate:"min=18"`
}

func main() {
	user := User{
		Name:  "John Doe",
		Email: "john@example.com",
		Age:   25,
	}

	// 注册默认验证规则
	gody.RegisterDefaultRules()

	// 验证结构体
	if err := gody.Validate(user); err != nil {
		fmt.Println("Validation error:", err)
	} else {
		fmt.Println("Validation passed!")
	}
}

2. 内置验证规则

gody 提供了一些内置验证规则：

• not_empty - 字段不能为空
• email - 必须是有效的电子邮件格式
• min - 数字最小值 (如 min=18)
• max - 数字最大值 (如 max=100)
• len - 字符串长度 (如 len=10)
• uuid - 必须是有效的UUID
• regexp - 正则表达式匹配 (如 regexp=^[a-zA-Z]+$)

3. 自定义验证规则

package main

import (
	"fmt"
	"github.com/guiferpa/gody"
	"strings"
)

type Product struct {
	Code  string `json:"code" validate:"not_empty,starts_with_P"`
	Price int    `json:"price" validate:"min=1"`
}

// 自定义验证函数
func startsWithP(rule string, value interface{}) error {
	s, ok := value.(string)
	if !ok {
		return fmt.Errorf("starts_with_P: value must be a string")
	}
	
	if !strings.HasPrefix(s, "P") {
		return fmt.Errorf("starts_with_P: value must start with 'P'")
	}
	
	return nil
}

func main() {
	product := Product{
		Code:  "P12345",
		Price: 100,
	}

	// 注册默认规则
	gody.RegisterDefaultRules()
	
	// 注册自定义规则
	gody.RegisterRule("starts_with_P", startsWithP)

	if err := gody.Validate(product); err != nil {
		fmt.Println("Validation error:", err)
	} else {
		fmt.Println("Validation passed!")
	}
}

4. 验证嵌套结构体

package main

import (
	"fmt"
	"github.com/guiferpa/gody"
)

type Address struct {
	Street string `json:"street" validate:"not_empty"`
	City   string `json:"city" validate:"not_empty"`
}

type Customer struct {
	Name    string  `json:"name" validate:"not_empty"`
	Address Address `json:"address" validate:"struct"`
}

func main() {
	customer := Customer{
		Name: "Jane Smith",
		Address: Address{
			Street: "123 Main St",
			City:   "",
		},
	}

	gody.RegisterDefaultRules()

	if err := gody.Validate(customer); err != nil {
		fmt.Println("Validation error:", err)
		// 输出: Validation error: address.city: cannot be empty
	}
}

5. 切片验证

package main

import (
	"fmt"
	"github.com/guiferpa/gody"
)

type Item struct {
	ID    string `json:"id" validate:"not_empty,uuid"`
	Name  string `json:"name" validate:"not_empty"`
	Count int    `json:"count" validate:"min=1"`
}

type Order struct {
	Items []Item `json:"items" validate:"not_empty"`
}

func main() {
	order := Order{
		Items: []Item{
			{
				ID:    "550e8400-e29b-41d4-a716-446655440000",
				Name:  "Laptop",
				Count: 1,
			},
			{
				ID:    "",
				Name:  "Mouse",
				Count: 0,
			},
		},
	}

	gody.RegisterDefaultRules()

	if err := gody.Validate(order); err != nil {
		fmt.Println("Validation error:", err)
		// 输出: Validation error: items[1].id: cannot be empty; items[1].count: must be greater than or equal to 1
	}
}

性能考虑

gody 相比其他验证库(如 go-playground/validator)有以下特点：

1. 不使用反射，性能更好
2. 验证规则更简单，功能相对较少
3. 适合简单到中等复杂度的验证需求

总结

gody 是一个轻量级的验证库，适合那些：

• 需要简单快速验证的场景
• 对性能有要求的应用
• 不需要复杂验证逻辑的项目

对于更复杂的验证需求，可能需要考虑其他功能更全面的验证库。但如果你需要一个小巧、快速的验证工具，gody 是一个不错的选择。