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

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

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

快速示例

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

package main

import (
	"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 string
	Email 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 库的高度可扩展性。

在这里插入图片描述

上一篇:8. C#多线程基础概念


下一篇:VMware导入小白分享的MacOS版本之后,无法开机的解决方案