Golang通过结构体标签验证用户输入数据插件库checker的使用

Checker是一个轻量级的Go库，用于高效验证用户输入。它支持验证结构体字段和单个输入值。

安装

使用以下命令安装Checker库：

go get github.com/cinar/checker/v2

然后在代码中导入：

import (
	checker "github.com/cinar/checker/v2"
)

基本用法

验证结构体中的用户输入

Checker可以通过在结构体标签中列出检查器来验证存储在结构体中的用户输入：

type Person struct {
	Name string `checkers:"trim required"`
}

person := &Person{
	Name: " Onur Cinar ",
}

errors, valid := checker.CheckStruct(person)
if !valid {
	// 处理验证错误
}

验证单个用户输入

你可以直接调用检查器函数来验证单个用户输入：

name := " Onur Cinar "

name, err := checker.Check(name, checker.Trim, checker.Required)
if err != nil {
	// 处理验证错误
}

或者使用配置字符串：

name := " Onur Cinar "

name, err := checker.CheckWithConfig(name, "trim required")
if err != nil {
	// 处理验证错误
}

简单验证

对于更简单的验证，你可以调用单个检查器函数：

name := "Onur Cinar"

err := checker.IsRequired(name)
if err != nil {
	// 处理验证错误
}

检查器和标准化器

检查器验证用户输入，而标准化器将其转换为首选格式。例如，标准化器可以修剪字符串中的空格或将其转换为标题大小写。

type Person struct {
	Name string `checkers:"trim required"`
}

提供的检查器

• ascii: 确保字符串仅包含ASCII字符
• alphanumeric: 确保字符串仅包含字母和数字
• credit-card: 确保字符串是有效的信用卡号
• cidr: 确保字符串是有效的CIDR表示法
• digits: 确保字符串仅包含数字
• email: 确保字符串是有效的电子邮件地址
• fqdn: 确保字符串是有效的完全限定域名
• gte: 确保值大于或等于指定数字
• hex: 确保字符串仅包含十六进制数字
• ip: 确保字符串是有效的IP地址
• ipv4: 确保字符串是有效的IPv4地址
• ipv6: 确保字符串是有效的IPv6地址
• isbn: 确保字符串是有效的ISBN
• lte: 确保值小于或等于指定数字
• luhn: 确保字符串是有效的LUHN号码
• mac: 确保字符串是有效的MAC地址
• max-len: 确保给定值(字符串、切片或映射)的长度最多为n
• min-len: 确保给定值(字符串、切片或映射)的长度至少为n
• required: 确保提供了值
• regexp: 确保字符串匹配模式
• time: 确保字符串匹配提供的时间布局
• url: 确保字符串是有效的URL

提供的标准化器

• lower: 将字符串转换为小写
• title: 将字符串转换为标题大小写
• trim-left: 从字符串左侧修剪空白
• trim-right: 从字符串右侧修剪空白
• trim: 从字符串两侧修剪空白
• upper: 将字符串转换为大写
• html-escape: 转义字符串中的特殊字符以用于HTML
• html-unescape: 取消转义字符串中的特殊字符以用于HTML
• url-escape: 转义字符串中的特殊字符以用于URL
• url-unescape: 取消转义字符串中的特殊字符以用于URL

自定义检查器和标准化器

你可以定义自定义检查器或标准化器并注册它们以供在验证逻辑中使用：

checker.RegisterMaker("is-fruit", func(params string) v2.CheckFunc[reflect.Value] {
	return func(value reflect.Value) (reflect.Value, error) {
		stringValue := value.Interface().(string)

		if stringValue == "apple" || stringValue == "banana" {
			return value, nil
		}

		return value, v2.NewCheckError("NOT_FRUIT")
	}
})

注册后，你可以在结构体标签中使用自定义检查器：

type Item struct {
	Name string `checkers:"is-fruit"`
}

item := &Item{
	Name: "banana",
}

errors, valid := v2.CheckStruct(item)
if !valid {
	fmt.Println(errors)
}

切片和项目级检查器

当向切片添加检查器结构标签时，可以使用@前缀表示检查器应应用于切片本身。没有@前缀的检查器将应用于切片中的各个项目：

type Person struct {
	Name   string   `checkers:"required"`
	Emails []string `checkers:"@max-len:2 max-len:64"`
}

在这个例子中：

• @max-len:2确保Emails切片本身最多有两个项目
• max-len:64确保Emails切片中的每个电子邮件字符串的最大长度为64个字符

本地化错误消息

当验证失败时，Checker会返回一个错误。默认情况下，Error()函数提供en-US语言环境的人类可读错误消息。

_, err := checker.IsEmail("abcd")
if err != nil {
	fmt.Println(err)
	// 输出: Not a valid email address.
}

要获取其他语言的错误消息，可以使用ErrorWithLocale()函数。默认情况下，只注册了en-US。你可以通过调用RegisterLocale来注册其他语言。

// 注册de-DE本地化错误消息
checker.RegisterLocale(locales.DeDE, locales.DeDEMessages)

_, err := checker.IsEmail("abcd")
if err != nil {
	fmt.Println(err.ErrorWithLocale(locales.DeDE))
	// 输出: Keine gültige E-Mail-Adresse.
}

你还可以自定义现有错误消息或向locales.EnUSMessages和其他语言环境映射添加新消息。

// 为自定义NOT_FRUIT错误代码注册en-US本地化错误消息
locales.EnUSMessages["NOT_FRUIT"] = "Not a fruit name."

errors, valid := v2.CheckStruct(item)
if !valid {
	fmt.Println(errors)
	// 输出: map[Name:Not a fruit name.]
}

错误消息是使用Golang模板函数生成的，允许它们包含变量。

// 包含项目名称的自定义检查器错误
err := checker.NewCheckErrorWithData(
	"NOT_FRUIT",
	map[string]interface{}{
		"name": "abcd",
	},
)

// 为自定义NOT_FRUIT错误代码注册en-US本地化错误消息
locales.EnUSMessages["NOT_FRUIT"] = "Name {{ .name }} is not a fruit name."

errors, valid := v2.CheckStruct(item)
if !valid {
	fmt.Println(errors)
	// 输出: map[Name:Name abcd is not a fruit name.]
}

许可证

该库可以自由使用、修改和分发，遵循MIT许可证的条款。完整的许可证文本可以在LICENSE文件中找到。