使用govalid进行Golang结构体验证

govalid是一个基于标签的Golang结构体验证库，它允许开发者通过结构体标签快速定义验证规则，简化了数据验证的过程。下面我将详细介绍govalid的使用方法。

安装govalid

首先需要安装govalid库：

go get github.com/gopherd/govalid

基本用法

1. 定义带有验证标签的结构体

type User struct {
    Name     string `valid:"required,minlen=4,maxlen=20"`
    Age      int    `valid:"required,min=18,max=120"`
    Email    string `valid:"required,email"`
    Password string `valid:"required,minlen=8"`
    Phone    string `valid:"phone"`
}

2. 验证结构体

package main

import (
    "fmt"
    "github.com/gopherd/govalid"
)

func main() {
    user := User{
        Name:     "John",
        Age:      17,
        Email:    "invalid-email",
        Password: "short",
    }

    err := govalid.Validate(user)
    if err != nil {
        if verr, ok := err.(*govalid.ValidationError); ok {
            for field, msg := range verr.Fields {
                fmt.Printf("%s: %s\n", field, msg)
            }
        } else {
            fmt.Println("Validation error:", err)
        }
    } else {
        fmt.Println("Validation passed!")
    }
}

常用验证标签

govalid支持多种验证规则：

1. required - 字段必须存在且非零值
2. minlen=n - 字符串最小长度
3. maxlen=n - 字符串最大长度
4. min=n - 数字最小值
5. max=n - 数字最大值
6. email - 必须是有效的电子邮件格式
7. phone - 必须是有效的电话号码格式
8. regex=pattern - 必须匹配正则表达式
9. in=value1,value2,… - 必须在指定值列表中
10. notin=value1,value2,… - 不能在指定值列表中

自定义验证器

1. 定义自定义验证函数

func isAdminUser(value interface{}) error {
    s, ok := value.(string)
    if !ok {
        return fmt.Errorf("expected string type")
    }
    if s != "admin" {
        return fmt.Errorf("must be admin user")
    }
    return nil
}

2. 注册自定义验证器

func init() {
    govalid.RegisterValidator("admin", isAdminUser)
}

3. 使用自定义验证器

type Admin struct {
    Username string `valid:"required,admin"`
}

嵌套结构体验证

govalid支持嵌套结构体的验证：

type Address struct {
    Street  string `valid:"required"`
    City    string `valid:"required"`
    Country string `valid:"required"`
}

type Person struct {
    Name    string  `valid:"required"`
    Age     int     `valid:"required,min=18"`
    Address Address `valid:"required"`
}

切片和数组验证

type Team struct {
    Members []string `valid:"required,minlen=1,maxlen=10,unique"`
    Scores  []int    `valid:"required,min=0,max=100"`
}

条件验证

可以使用requiredIf和requiredUnless实现条件验证：

type Order struct {
    PaymentMethod string `valid:"required,in=cash,credit"`
    CreditCard    string `valid:"requiredIf=PaymentMethod credit"`
    CashReceipt   bool   `valid:"requiredUnless=PaymentMethod credit"`
}

性能优化

对于频繁验证的场景，可以预编译验证规则：

type Product struct {
    ID    string `valid:"required,uuid"`
    Name  string `valid:"required"`
    Price float64 `valid:"required,min=0"`
}

func main() {
    validator, err := govalid.Compile(Product{})
    if err != nil {
        panic(err)
    }
    
    // 然后可以重复使用validator
    product := Product{ID: "123", Name: "Laptop", Price: -1}
    err = validator.Validate(product)
    // 处理错误...
}

错误消息自定义

可以通过实现govalid.ErrorTransformer接口来自定义错误消息：

type customErrorTransformer struct{}

func (t *customErrorTransformer) Transform(err error) error {
    if verr, ok := err.(*govalid.ValidationError); ok {
        // 自定义错误消息格式
        var msgs []string
        for field, msg := range verr.Fields {
            msgs = append(msgs, fmt.Sprintf("%s: %s", field, msg))
        }
        return fmt.Errorf("验证失败: %s", strings.Join(msgs, "; "))
    }
    return err
}

func main() {
    govalid.SetErrorTransformer(&customErrorTransformer{})
    // 现在所有验证错误都会使用自定义格式
}

govalid是一个轻量级但功能强大的验证库，通过结构体标签可以快速实现复杂的数据验证逻辑，非常适合在Golang项目中使用。