使用 omg.jsonparser 实现 Golang JSON 条件验证

omg.jsonparser 是一个基于结构体标签实现 JSON 条件验证的 Golang 库，它允许你通过简单的标签定义来验证 JSON 数据。

安装

go get github.com/dragon-zhang/omg.jsonparser

基本用法

1. 定义结构体与标签

type User struct {
    ID       int    `json:"id" validate:"required,min=1"`
    Username string `json:"username" validate:"required,min=3,max=20"`
    Email    string `json:"email" validate:"required,email"`
    Age      int    `json:"age" validate:"min=18,max=120"`
    Password string `json:"password" validate:"required,min=8,max=64"`
}

2. 解析并验证 JSON

package main

import (
    "fmt"
    "github.com/dragon-zhang/omg.jsonparser"
)

func main() {
    jsonStr := `{
        "id": 1,
        "username": "john_doe",
        "email": "john@example.com",
        "age": 25,
        "password": "secure123"
    }`

    var user User
    err := omg.jsonparser.ParseJSON(jsonStr, &user)
    if err != nil {
        fmt.Println("Validation error:", err)
        return
    }

    fmt.Printf("Valid user: %+v\n", user)
}

支持的验证标签

omg.jsonparser 支持以下验证规则：

• required - 字段必须存在且不为零值
• min=n - 最小长度/数值
• max=n - 最大长度/数值
• email - 必须是有效的电子邮件格式
• url - 必须是有效的 URL
• regexp=pattern - 必须匹配正则表达式
• enum=val1,val2,... - 必须是枚举值之一

高级用法

自定义验证函数

type Product struct {
    Name  string `json:"name" validate:"required"`
    Price float64 `json:"price" validate:"required,custom=validatePrice"`
}

func validatePrice(value interface{}) error {
    price, ok := value.(float64)
    if !ok {
        return fmt.Errorf("price must be a number")
    }
    if price <= 0 {
        return fmt.Errorf("price must be positive")
    }
    return nil
}

func main() {
    omg.jsonparser.RegisterCustomValidator("validatePrice", validatePrice)
    
    jsonStr := `{"name": "Laptop", "price": 999.99}`
    var product Product
    err := omg.jsonparser.ParseJSON(jsonStr, &product)
    if err != nil {
        fmt.Println("Error:", err)
        return
    }
    fmt.Printf("Valid product: %+v\n", product)
}

嵌套结构验证

type Address struct {
    Street  string `json:"street" validate:"required"`
    City    string `json:"city" validate:"required"`
    Country string `json:"country" validate:"required,len=2"`
}

type Customer struct {
    Name    string  `json:"name" validate:"required"`
    Age     int     `json:"age" validate:"min=18"`
    Address Address `json:"address"`
}

func main() {
    jsonStr := `{
        "name": "Alice",
        "age": 30,
        "address": {
            "street": "123 Main St",
            "city": "New York",
            "country": "US"
        }
    }`

    var customer Customer
    err := omg.jsonparser.ParseJSON(jsonStr, &customer)
    if err != nil {
        fmt.Println("Error:", err)
        return
    }
    fmt.Printf("Valid customer: %+v\n", customer)
}

错误处理

omg.jsonparser 提供了详细的错误信息：

jsonStr := `{
    "id": 0,
    "username": "jo",
    "email": "invalid-email",
    "age": 17,
    "password": "short"
}`

var user User
err := omg.jsonparser.ParseJSON(jsonStr, &user)
if err != nil {
    if validationErr, ok := err.(*omg.jsonparser.ValidationError); ok {
        for _, fieldErr := range validationErr.Errors {
            fmt.Printf("Field %s: %s\n", fieldErr.Field, fieldErr.Message)
        }
    } else {
        fmt.Println("Parse error:", err)
    }
    return
}

性能考虑

omg.jsonparser 在性能上做了优化：

1. 使用反射缓存减少反射开销
2. 预编译正则表达式
3. 批量验证减少函数调用次数

对于高性能场景，建议在初始化时预注册所有自定义验证器。

总结

omg.jsonparser 提供了一种简洁而强大的方式来验证 JSON 数据，通过结构体标签定义验证规则，使得代码更加清晰易读。它特别适合 REST API 开发中请求参数的验证。