一个轻量级的基于泛型实现的数据校验库

工作中遇到要做数据校验的需求, 开源的校验库基本都是基于反射实现的. 于是就写了这个非常轻量的数据校验库hvalid.
请各位大佬给点意见, 如果可以, 欢迎提PR一起来丰富这个库.

hvalid

hvalid 是一个用Go语言编写的轻量级验证库,它自定义验证器的接口,以及提供了一系列通用的验证函数,以帮助开发者快速实现数据验证。

Go Report Card
GitHub go.mod Go version

特性

  • 支持泛型: 可以对任何类型的数据进行校验,包括基本类型、结构体、切片等。
  • 易于使用: 提供简洁的 API,方便开发者快速进行参数校验。
  • 可扩展: 可以自定义校验规则,满足不同的校验需求。
  • 错误信息友好: 校验失败时,会返回清晰的错误信息,方便开发者定位问题。

安装

使用go get命令安装:

go get github.com/lyonnee/hvalid

使用示例

基本类型校验

import (
    "errors"
    "github.com/lyonnee/hvalid"
)

func main() {
    // 校验字符串长度
    err := hvalid.Validate[string]("hello", hvalid.MinLen[string](3))
    if err != nil {
        // 处理错误
    }

    // 校验数字范围
    err = hvalid.Validate[int](10, hvalid.Min(5), hvalid.Max(15))
    if err != nil {
        // 处理错误
    }
}

结构体校验

type User struct {
    Name  string
    Email string
    Age   int
}

func UserValidator() hvalid.ValidatorFunc[User] {
    return hvalid.ValidatorFunc[User](func(user User) error {
        if user.Age < 18 {
            return errors.New("年龄必须大于 18 岁")
        }

        return hvalid.Validate[string](user.Email, hvalid.Email())
    })
}

func main() {
    user := User{
        Name:  "张三",
        Email: "zhangsan@example.com",
        Age:   20,
    }

    err := hvalid.Validate[User](user, UserValidator())
    if err != nil {
        // 处理错误
    }
}

自定义校验规则

func IsPositive(errMsg ...string) hvalid.ValidatorFunc[int] {
    return hvalid.ValidatorFunc[int](func(num int) error {
        if num <= 0 {
            if len(errMsg) > 0 {
                return errors.New(errMsg[0])
            }
            return errors.New("数字必须为正数")
        }
        return nil
    })
}

func main() {
    err := hvalid.Validate[int](10, IsPositive())
    if err != nil {
        // 处理错误
    }
}

测试

项目包含单元测试,使用go test命令执行所有测试:

go test ./...

贡献

欢迎提交问题和拉取请求来改进hvalid

许可证

hvalid遵循MIT许可证。查看LICENSE文件以获取更多信息。

讨论数量: 3

不错 比较简洁

6天前 评论
don178 1天前

我很疑惑,这种写法比直接校验有什么优势吗,hvalid.Validate[string]("hello", hvalid.MinLen[string](3)) 和 len("hello")<3,我怎么看都是直接写更好,如果考虑逻辑复用写个函数就行,结构体也是同理,那为什么要用框架写。

1天前 评论

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!