Valgo,类型安全,表达能⼒强的go验证器

2024-06-05 11:28

本文主要是介绍Valgo,类型安全,表达能⼒强的go验证器,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

valgo 是一个为 Go 语言设计的类型安全、表达性强且可扩展的验证库。该库的特点包括:
github.com/cohesivestack/valgo

  • 类型安全:利用 Go 语言的泛型特性(从 Go 1.18 版本开始支持),确保验证逻辑的类型安全。
  • 表达性:验证规则通过函数链式调用来定义,而非传统的结构体标签,这提供了更灵活和自由的方式来决定数据在哪里及如何被验证。
  • 可扩展性:支持自定义验证器和局部化验证消息,使得库能够适应多种场景。
  • 灵活性:验证规则直接写在函数中,而非依赖于结构体标签,提高了代码的可读性和可维护性。
  • 局部化:支持验证消息的定制和本地化,便于多语言环境下的错误反馈。
  • JSON 输出:错误信息可以输出为 JSON 格式,便于集成到 RESTful API 中。

快速示例

以下是一个使用 valgo 进行基本验证的示例:

package mainimport ("encoding/json""fmt""github.com/cohesivestack/valgo"
)func main() {validation := valgo.Is(valgo.String("test", "name").Not().Blank().OfLengthBetween(8, 20),valgo.Number(18, "age").GreaterThan(20),)if !validation.Valid() {out, _ := json.MarshalIndent(validation.Error(), "", "  ")fmt.Println(string(out))}
}

在这个例子中,我们验证了两个条件:

  1. name(全名)必须是非空字符串且长度在8到20个字符之间。
  2. age(年龄)必须大于20。

输出结果(当验证不通过时)可能是这样的 JSON 错误信息:

{"age": ["Age must be greater than 20"],"name": ["name must have a length between  8 and 20"]
}

自定义验证器

valgo 还允许创建自定义验证器。例如,假设我们想验证一个自定义的 ID 结构体:

type ID struct {Phone stringEmail string
}func IDValue(value ID, nameAndTitle ...string) *valgo.ValidatorID {return &valgo.ValidatorID{context: valgo.NewContext(value, nameAndTitle...)}
}type ValidatorID struct {context *valgo.ValidatorContext
}func (validator *ValidatorID) Context() *valgo.ValidatorContext {return validator.context
}// 示例验证规则:至少提供 Phone 或 Email
func (validator *ValidatorID) HasContactInfo() *ValidatorID {validator.context.Add(func() bool {return validator.context.Value().(*ID).Phone != "" || validator.context.Value().(*ID).Email != ""},"At least one contact method (phone or email) must be provided.",)return validator
}

使用自定义验证器示例

id := ID{Phone: "1234567890"}
validation := valgo.Is(IDValue(id).HasContactInfo())if !validation.Valid() {// 处理错误
}

这个例子展示了如何定义一个 ID 类型的验证器,并添加了一个规则来检查是否至少提供了一种联系方式(电话或电子邮件)。这体现了 valgo 库的高度可扩展性。

在这里插入图片描述

这篇关于Valgo,类型安全,表达能⼒强的go验证器的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1032917

相关文章

Python中Json和其他类型相互转换的实现示例

《Python中Json和其他类型相互转换的实现示例》本文介绍了在Python中使用json模块实现json数据与dict、object之间的高效转换,包括loads(),load(),dumps()... 项目中经常会用到json格式转为object对象、dict字典格式等。在此做个记录,方便后续用到该方

GO语言短变量声明的实现示例

《GO语言短变量声明的实现示例》在Go语言中,短变量声明是一种简洁的变量声明方式,使用:=运算符,可以自动推断变量类型,下面就来具体介绍一下如何使用,感兴趣的可以了解一下... 目录基本语法功能特点与var的区别适用场景注意事项基本语法variableName := value功能特点1、自动类型推

GO语言中函数命名返回值的使用

《GO语言中函数命名返回值的使用》在Go语言中,函数可以为其返回值指定名称,这被称为命名返回值或命名返回参数,这种特性可以使代码更清晰,特别是在返回多个值时,感兴趣的可以了解一下... 目录基本语法函数命名返回特点代码示例命名特点基本语法func functionName(parameters) (nam

Go之errors.New和fmt.Errorf 的区别小结

《Go之errors.New和fmt.Errorf的区别小结》本文主要介绍了Go之errors.New和fmt.Errorf的区别,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考... 目录error的基本用法1. 获取错误信息2. 在条件判断中使用基本区别1.函数签名2.使用场景详细对

python中的显式声明类型参数使用方式

《python中的显式声明类型参数使用方式》文章探讨了Python3.10+版本中类型注解的使用,指出FastAPI官方示例强调显式声明参数类型,通过|操作符替代Union/Optional,可提升代... 目录背景python函数显式声明的类型汇总基本类型集合类型Optional and Union(py

MySQL中查询和展示LONGBLOB类型数据的技巧总结

《MySQL中查询和展示LONGBLOB类型数据的技巧总结》在MySQL中LONGBLOB是一种二进制大对象(BLOB)数据类型,用于存储大量的二进制数据,:本文主要介绍MySQL中查询和展示LO... 目录前言1. 查询 LONGBLOB 数据的大小2. 查询并展示 LONGBLOB 数据2.1 转换为十

Go语言连接MySQL数据库执行基本的增删改查

《Go语言连接MySQL数据库执行基本的增删改查》在后端开发中,MySQL是最常用的关系型数据库之一,本文主要为大家详细介绍了如何使用Go连接MySQL数据库并执行基本的增删改查吧... 目录Go语言连接mysql数据库准备工作安装 MySQL 驱动代码实现运行结果注意事项Go语言执行基本的增删改查准备工作

Go中select多路复用的实现示例

《Go中select多路复用的实现示例》Go的select用于多通道通信,实现多路复用,支持随机选择、超时控制及非阻塞操作,建议合理使用以避免协程泄漏和死循环,感兴趣的可以了解一下... 目录一、什么是select基本语法:二、select 使用示例示例1:监听多个通道输入三、select的特性四、使用se

Go语言使用Gin处理路由参数和查询参数

《Go语言使用Gin处理路由参数和查询参数》在WebAPI开发中,处理路由参数(PathParameter)和查询参数(QueryParameter)是非常常见的需求,下面我们就来看看Go语言... 目录一、路由参数 vs 查询参数二、Gin 获取路由参数和查询参数三、示例代码四、运行与测试1. 测试编程路

Go语言使用net/http构建一个RESTful API的示例代码

《Go语言使用net/http构建一个RESTfulAPI的示例代码》Go的标准库net/http提供了构建Web服务所需的强大功能,虽然众多第三方框架(如Gin、Echo)已经封装了很多功能,但... 目录引言一、什么是 RESTful API?二、实战目标:用户信息管理 API三、代码实现1. 用户数据