ZOG - 运行时数据解析与验证

ZOG - 运行时数据解析与验证

zog Go with Zod inspired simple schema validation 项目地址: https://gitcode.com/gh_mirrors/zo/zog

1. 项目介绍

ZOG 是一个运行时数据解析和验证的库，它允许开发者定义一个模式（schema），然后将数据解析和验证以符合该模式。ZOG 的设计旨在提供简洁且强大的模式接口，支持从简单到复杂的数据模型。它的特点包括：

• 类似于 Zod 的 API，支持链式调用构建模式，类型安全。
• 可扩展性，允许添加自定义的测试和模式。
• 丰富的错误信息，提供详细的上下文，便于调试。
• 快速，是性能最佳的 Go 验证库之一。
• 内置类型强制转换支持。
• 零依赖。

2. 项目快速启动

首先，确保你已经安装了 Go 环境。然后，通过以下命令获取 ZOG：

go get github.com/Oudwins/zog

创建一个用户模式及其结构体：

import (
    "github.com/Oudwins/zog"
)

type User struct {
    Name string
    Age  int
}

var userSchema = z.Struct(z.Schema{
    "name": z.String().Min(3, z.Message("名称至少3个字符")).Max(10),
    "age":  z.Int().GT(18),
})

使用模式进行验证：

func main() {
    u := User{}
    m := map[string]string{
        "name": "Zog",
        "age":  "",
    }
    
    errsMap := userSchema.Parse(m, &u)
    if errsMap != nil {
        // 处理错误
    }

    // 输出解析后的数据
    println(u.Name) // "Zog"
    println(u.Age)  // 0
}

3. 应用案例和最佳实践

ZOG 可以用于解析和验证来自不同来源的数据，例如 HTTP 请求、JSON 数据或环境变量。以下是一些使用案例：

• 解析 HTTP 请求：

import (
    "github.com/Oudwins/zog/zhttp"
)

err := userSchema.Parse(zhttp.Request(r), &user)

• 解析 JSON 数据：

import (
    "github.com/Oudwins/zog/zjson"
    "bytes"
)

err := userSchema.Parse(zjson.Decode(bytes.NewReader(jsonBytes)), &user)

• 验证环境变量：

import (
    "github.com/Oudwins/zog/zenv"
)

err := envSchema.Parse(zenv.NewDataProvider(), &envs)

• 解析和转换单个字段：

var t time.Time
errsList := Time().Required().Parse("2020-01-01T00:00:00Z", &t)

4. 典型生态项目

ZOG 的生态系统中包括几个辅助包，它们可以帮助你更容易地处理特定的数据格式：

• zenv：用于解析环境变量。
• zhttp：用于处理 HTTP 请求，包括表单和查询参数。
• zjson：用于解析 JSON 数据。
• i18n：提供国际化的错误处理。

ZOG 旨在帮助开发者构建健壮、易于维护的数据验证逻辑，无论是简单的数据校验还是复杂的数据转换。通过遵循上述指南，你可以快速开始使用 ZOG 并将其集成到你的项目中。

zog Go with Zod inspired simple schema validation 项目地址: https://gitcode.com/gh_mirrors/zo/zog