开源项目 `gookit/validate` 使用教程

开源项目 gookit/validate 使用教程

validate⚔ Go package for data validation and filtering. support Map, Struct, Form data. Go通用的数据验证与过滤库，使用简单，内置大部分常用验证、过滤器，支持自定义验证器、自定义消息、字段翻译。项目地址:https://gitcode.com/gh_mirrors/va/validate

1. 项目的目录结构及介绍

gookit/validate
├── examples  // 示例代码目录
│   ├── basic_test.go
│   ├── custom_message_test.go
│   ├── custom_rule_test.go
│   ├── struct_validate_test.go
│   └── ...
├── locale  // 多语言支持目录
│   ├── en.go
│   ├── zh-CN.go
│   └── ...
├── testdata  // 测试数据目录
│   └── ...
├── validate  // 核心验证逻辑目录
│   ├── error.go
│   ├── filter.go
│   ├── rule.go
│   ├── validate.go
│   └── ...
├── .gitignore
├── .travis.yml
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── go.mod
├── go.sum
└── ...

目录结构介绍

• examples: 包含项目的示例代码，展示了如何使用不同的验证功能。
• locale: 提供多语言支持的错误消息。
• testdata: 包含测试数据，用于单元测试。
• validate: 核心验证逻辑的实现，包括错误处理、过滤器、规则定义等。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• CHANGELOG.md: 项目更新日志。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• README.md: 项目介绍和使用说明。
• go.mod 和 go.sum: Go 模块依赖管理文件。

2. 项目的启动文件介绍

项目的启动文件通常是指入口文件，但在 gookit/validate 项目中，没有明确的“启动文件”，因为这是一个库项目，而不是一个可执行的应用程序。用户在使用时，会根据需要在自己的代码中引入并使用 validate 包。

例如，一个基本的验证示例可能如下：

package main

import (
    "fmt"
    "github.com/gookit/validate"
)

func main() {
    v := validate.Struct(MyStruct{})
    if v.Validate() {
        // 验证通过
    } else {
        // 验证失败，输出错误信息
        fmt.Println(v.Errors)
    }
}

type MyStruct struct {
    Name  string `validate:"required|minLen:5"`
    Email string `validate:"required|email"`
}

3. 项目的配置文件介绍

在 gookit/validate 项目中，没有传统意义上的配置文件，因为所有的配置和规则定义都是通过代码实现的。用户可以根据需要在代码中定义验证规则和错误消息。

例如，自定义错误消息的示例如下：

package main

import (
    "fmt"
    "github.com/gookit/validate"
)

func main() {
    v := validate.Map(map[string]interface{}{
        "name":  "",
        "email": "invalid-email",
    })

    v.AddRule("name", "required")
    v.AddRule("email", "email")

    v.AddMessages(map[string]string{
        "name.required": "The name field is required.",
        "email.email":   "The email field must be a valid email.",
    })

    if v.Validate() {
        // 验证通过
    } else {
        // 验证失败，输出错误信息
        fmt.Println(v.Errors)
    }
}

通过这种方式，用户可以在代码中灵活地定义和配置验证规则和错误消息。

validate⚔ Go package for data validation and filtering. support Map, Struct, Form data. Go通用的数据验证与过滤库，使用简单，内置大部分常用验证、过滤器，支持自定义验证器、自定义消息、字段翻译。项目地址:https://gitcode.com/gh_mirrors/va/validate