Go语言结合validator包实现表单验证_Golang

在现代 web 开发中，表单验证和错误处理是至关重要的环节，尤其是在多语言环境下。

本文将通过一个实际的示例，演示如何使用 go 语言的 gin 框架结合 validator 包，实现高级的表单验证功能，并且支持国际化（i18n）的错误信息提示。

背景与需求

假设我们正在开发一个用户注册功能，需要对用户提交的信息进行严格的验证。例如，用户名不能为空、邮箱格式必须正确、密码和确认密码必须一致、用户年龄应在合理范围内（如 1 到 130 岁），并且日期字段不能早于当前日期。除此之外，系统还需要根据用户的语言偏好提供相应语言的错误提示信息。

代码示例

我们将从以下几个方面展开：

表单数据的结构定义
表单验证器的初始化与自定义
多语言支持的实现
处理表单提交与错误返回

package main

import (
	"fmt"
	"net/http"
	"reflect"
	"strings"
	"time"

	"github.com/gin-gonic/gin"
	"github.com/gin-gonic/gin/binding"
	"github.com/go-playground/locales/en"
	"github.com/go-playground/locales/zh"
	ut "github.com/go-playground/universal-translator"
	"github.com/go-playground/validator/v10"
	entranslations "github.com/go-playground/validator/v10/translations/en"
	zhtranslations "github.com/go-playground/validator/v10/translations/zh"
)

// 定义一个全局翻译器
var trans ut.translator

表单数据结构定义

首先，我们定义用户提交的表单数据结构 signupparam。这个结构体中包含了用户注册时所需的各个字段，并通过结构标签（tags）指定了验证规则。

type signupparam struct {
	age        uint8  `json:"age" binding:"gte=1,lte=130"`
	name       string `json:"name" binding:"required"`
	email      string `json:"email" binding:"required,email"`
	password   string `json:"password" binding:"required"`
	repassword string `json:"re_password" binding:"required,eqfield=password"`
	date       string `json:"date" binding:"required,datetime=2006-01-02,checkdate"`
}

age 字段必须在 1 到 130 岁之间。
name 字段不能为空。
email 字段必须是有效的电子邮件地址。
password 和 repassword 字段必须一致。
date 字段需要使用自定义校验方法 checkdate，确保输入日期晚于当前日期。

初始化与自定义表单验证器

在 gin 框架中，我们可以通过 binding.validator.engine() 获取到内置的验证器，并对其进行自定义。

在下面的代码中，我们完成了翻译器的初始化，并注册了自定义的标签名称和验证方法。

func inittrans(locale string) (err error) {
	if v, ok := binding.validator.engine().(*validator.validate); ok {

		// 注册获取 json tag 的自定义方法
		v.registertagnamefunc(func(fld reflect.structfield) string {
			name := strings.splitn(fld.tag.get("json"), ",", 2)[0]
			if name == "-" {
				return ""
			}
			return name
		})

		// 注册结构体级别的验证函数
		v.registerstructvalidation(signupparamstructlevelvalidation, signupparam{})

		// 注册自定义校验方法
		if err := v.registervalidation("checkdate", customfunc); err != nil {
			return err
		}

		// 初始化多语言支持
		zht := zh.new() 
		ent := en.new()
		uni := ut.new(ent, zht, ent)

                var ok bool
		trans, ok = uni.gettranslator(locale)
		if !ok {
			return fmt.errorf("uni.gettranslator(%s) failed", locale)
		}

		// 注册语言翻译
		switch locale {
		case "en":
			err = entranslations.registerdefaulttranslations(v, trans)
		case "zh":
			err = zhtranslations.registerdefaulttranslations(v, trans)
		default:
			err = entranslations.registerdefaulttranslations(v, trans)
		}
		if err != nil {
			return err
		}

		// 注册自定义翻译
		if err := v.registertranslation(
			"checkdate",
			trans,
			registertranslator("checkdate", "{0}必须晚于当前日期"),
			translate,
		); err != nil {
			return err
		}
		return
	}
	return
}

实现自定义校验逻辑

在上面的代码中，我们自定义了两个校验函数：

customfunc：用于校验日期是否晚于当前日期。
signupparamstructlevelvalidation：用于校验两个密码字段是否一致。

func customfunc(fl validator.fieldlevel) bool {
	date, err := time.parse("2006-01-02", fl.field().string())
	if err != nil {
		return false
	}
	return date.after(time.now())
}

func signupparamstructlevelvalidation(sl validator.structlevel) {
	su := sl.current().interface().(signupparam)
	if su.password != su.repassword {
		sl.reporterror(su.repassword, "re_password", "repassword", "eqfield", "password")
	}
}

处理多语言错误提示

为了确保错误信息能够根据用户的语言偏好正确返回，我们注册了一个自定义的翻译函数 registertranslator，并在验证失败时使用该函数对错误信息进行翻译。

// registertranslator 为自定义字段添加翻译功能
func registertranslator(tag string, msg string) validator.registertranslationsfunc {
	return func(trans ut.translator) error {
		if err := trans.add(tag, msg, false); err != nil {
			return err
		}
		return nil
	}
}

// translate 自定义字段的翻译方法
func translate(trans ut.translator, fe validator.fielderror) string {
	msg, err := trans.t(fe.tag(), fe.field())
	if err != nil {
		panic(fe.(error).error())
	}
	return msg
}

主程序逻辑

最后，我们在 gin 中处理用户的注册请求。当用户提交的数据验证失败时，系统会自动返回翻译后的错误提示信息。

// removetopstruct 去除字段名中的结构体名称标识
// refer from:https://github.com/go-playground/validator/issues/633#issuecomment-654382345
func removetopstruct(fields map[string]string) map[string]string {
	res := map[string]string{}
	for field, err := range fields {
		res[field[strings.index(field, ".")+1:]] = err
	}
	return res
}

func main() {
	// 初始化翻译器
	if err := inittrans("zh"); err != nil {
		fmt.printf("初始化翻译器失败: %v\n", err)
		return
	}

	r := gin.default()

	r.post("/signup", func(c *gin.context) {
		var u signupparam
		if err := c.shouldbind(&u); err != nil {
			errs, ok := err.(validator.validationerrors)
			if !ok {
				c.json(http.statusok, gin.h{"msg": err.error()})
				return
			}
			c.json(http.statusok, gin.h{"msg": removetopstruct(errs.translate(trans))})
			return
		}

		// 其他的一些业务逻辑操作……

		c.json(http.statusok, gin.h{"msg": "success"})
	})

	err := r.run(":8080")
	if err != nil {
		fmt.printf("服务器运行失败: %v\n", err)
	}
}