hvalid 一个轻量级(不使用反射)的验证库 hvalid

LyonNee2024-04-23 16:10:50 • 1257 次点击    
这是一个分享于 2024-04-23 16:10:50 的项目,其中的信息可能已经有所发展或是发生改变。

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文件以获取更多信息。

hvalid is a lightweight validation library written in Go language.(一个用Go语言编写的轻量级验证库)Read More

Latest commit to the main branch on 5-9-2024
Download as zip
授权协议:
MIT
开发语言:
Go 查看源码»
1257 次点击  ∙  1 赞  
加入收藏 微博
暂无回复
添加一条新回复 (您需要 登录 后才能回复 没有账号 ?)
  • 请尽量让自己的回复能够对别人有帮助
  • 支持 Markdown 格式, **粗体**、~~删除线~~、`单行代码`
  • 支持 @ 本站用户;支持表情(输入 : 提示),见 Emoji cheat sheet
  • 图片支持拖拽、截图粘贴等方式上传