详解go-zero如何使用validator进行参数校验

更新时间：2024年01月26日 08:18:29 作者：lovevivi121

这篇文章主要介绍了如何使用validator库做参数校验的一些十分实用的使用技巧,包括翻译校验错误提示信息、自定义提示信息的字段名称、自定义校验方法等,感兴趣的可以了解下

validator库参数校验若干实用技巧

在web开发中一个不可避免的环节就是对请求参数进行校验，通常我们会在代码中定义与请求参数相对应的模型（结构体），借助模型绑定快捷地解析请求中的参数。本文就以 go-zero 框架的请求参数校验为例，介绍一些validator库的实用技巧。

go-zero框架使用github.com/go-playground/validator进行参数校验，目前已经支持github.com/go-playground/validator/v10了，我们需要在定义结构体时使用 validate tag标识相关校验规则，可以查看validator文档查看支持的所有 tag。

安装validator库

go get github.com/go-playground/validator/v10

基本示例

首先来看go-zero框架内置使用validator做参数校验的基本示例。

在api层编写Req时进行validator标签的编辑

生成.go文件的时候type就会带上相关标签(types里面)

type (
    TestReq {
        Age        int64  `json:"age" validate:"gte=1,lte=130"`
        Name       string `json:"name" validate:"required"`
        Email      string `json:"email" validate:"required,email"`
        Password   string `json:"password" validate:"required"`
        RePassword string `json:"re_password" validate:"required,eqfield=Password"`
    }
    TestResp {
    }
)

在handler层调用validator库

这个是没有使用validator前的handler

func TestApiHandler(svcCtx *svc.ServiceContext) http.HandlerFunc {
    return func(w http.ResponseWriter, r *http.Request) {
        var req types.TestReq
        if err := httpx.Parse(r, &req); err != nil {
            httpx.ErrorCtx(r.Context(), w, err)
            return
        }
        l := lottery.NewTestApiLogic(r.Context(), svcCtx)
        resp, err := l.TestApi(&req)
        if err != nil {
            result.ParamErrorResult(r, w, err)
        } else {
            result.HttpResult(r, w, resp, err)
        }
    }
}

使用validator校验

err := validator.New().StructCtx(r.Context(), req)
if err != nil {
    httpx.ErrorCtx(r.Context(), w, err)
    return
}

后续配合模板，直接生成这段代码即可，这样handler层可以不必再编辑

翻译校验错误提示信息

validator库本身是支持国际化的，借助相应的语言包可以实现校验错误提示信息的自动翻译。下面的示例代码演示了如何将错误提示信息翻译成中文，翻译成其他语言的方法类似。

安装翻译相关包

go get github.com/go-playground/universal-translator

编写validate的方法

func Validate(dataStruct interface{}) error {
    zh_ch := zh.New()
    validate := validator.New()
    // 注册一个函数，获取struct tag里自定义的label作为字段名
    validate.RegisterTagNameFunc(func(fld reflect.StructField) string {
        name := strings.SplitN(fld.Tag.Get("json"), ",", 2)[0]
        if name == "-" {
            return ""
        }
        return name
    })

    uni := ut.New(zh_ch)
    trans, _ := uni.GetTranslator("zh")
    // 验证器注册翻译器
    zh_translations.RegisterDefaultTranslations(validate, trans)
    err := validate.Struct(dataStruct)
    if err != nil {
        for _, err := range err.(validator.ValidationErrors) {
            return errors.New(err.Translate(trans))
        }
    }
    return nil
}

编写handler中的拦截（直接放模板里面去）

validateErr := translator.Validate(&req)
if validateErr != nil {
    result.ParamErrorResult(r, w, validateErr)
    return
}

自定义结构体校验方法

上面的校验还是有点小问题，就是当涉及到一些复杂的校验规则，比如re_password字段需要与password字段的值相等这样的校验规则，我们的自定义错误提示字段名称方法就不能很好解决错误提示信息中的其他字段名称了。

当我们测试re_password字段的时候，可以看到re_password字段的提示信息中还是出现了Password这个结构体字段名称。这有点小小的遗憾，毕竟自定义字段名称的方法不能影响被当成param传入的值。

{
    "code": 100002,
    "msg": "参数错误 ,re_password必须等于Password"
}

此时如果想要追求更好的提示效果，将上面的Password字段也改为和json tag一致的名称，就需要我们自定义结构体校验的方法。

例如，我们为SignUpParam自定义一个校验方法如下：

// SignUpParamStructLevelValidation 自定义SignUpParam结构体校验函数
func SignUpParamStructLevelValidation(sl validator.StructLevel) {
	su := sl.Current().Interface().(types.TestReq)

	if su.Password != su.RePassword {
		// 输出错误提示信息，最后一个参数就是传递的param
		sl.ReportError(su.RePassword, "re_password", "RePassword", "eqfield", "password")
	}
}

并且删掉原先的校验

eqfield=Password // api中的这个校验不要，重新生成.go文件

然后在初始化校验器的函数中注册该自定义校验方法即可：

validate.RegisterStructValidation(lottery.SignUpParamStructLevelValidation, types.TestReq{})

最终再请求一次，看一下效果：

{
    "code": 100002,
    "msg": "参数错误 ,re_password必须等于password"
}

这一次re_password字段的错误提示信息就符合我们预期了。

自定义字段校验方法

除了上面介绍到的自定义结构体校验方法，validator还支持为某个字段自定义校验方法，并使用RegisterValidation()注册到校验器实例中。

接下来我们来为SignUpParam添加一个需要使用自定义校验方法checkDate做参数校验的字段Date。

TestReq {
    Age        int64  `json:"age" validate:"gte=1,lte=130"`
    Name       string `json:"name" validate:"required"`
    Email      string `json:"email" validate:"required,email"`
    Password   string `json:"password" validate:"required"`
    RePassword string `json:"re_password" validate:"required"`
    // 需要使用自定义校验方法checkDate做参数校验的字段Date
    Date       string `json:"date" validate:"required,datetime=2006-01-02,checkDate"`
}

其中datetime=2006-01-02是内置的用于校验日期类参数是否满足指定格式要求的tag。如果传入的date参数不满足2006-01-02这种格式就会提示如下错误：

{
"code": 100002,
"msg": "参数错误 ,date的格式必须是2006-01-02"
}

针对date字段除了内置的datetime=2006-01-02提供的格式要求外，假设我们还要求该字段的时间必须是一个未来的时间（晚于当前时间），像这样针对某个字段的特殊校验需求就需要我们使用自定义字段校验方法了。

首先我们要在需要执行自定义校验的字段后面添加自定义tag，这里使用的是checkDate，注意使用英文分号分隔开。

// customFunc 自定义字段级别校验方法
func customFunc(fl validator.FieldLevel) bool {
	date, err := time.Parse("2006-01-02", fl.Field().String())
	if err != nil {
		return false
	}
	if date.Before(time.Now()) {
		return false
	}
	return true
}

定义好了字段及其自定义校验方法后，就需要将它们联系起来并注册到我们的校验器实例中。

// 注册自定义结构体字段校验方法
if err := validate.RegisterValidation("checkDate", customFunc); err != nil {
    return err
}

这样，我们就可以对请求参数中date字段执行自定义的checkDate进行校验了。我们发送如下请求测试一下,得到响应结果如下：

{
"code": 100002,
"msg": "参数错误 ,Key: 'TestReq.date' Error:Field validation for 'date' failed on the 'checkDate' tag"
}

这…自定义字段级别的校验方法的错误提示信息很“简单粗暴”，和我们上面的中文提示风格有出入，必须想办法搞定它呀！

自定义翻译方法

我们现在需要为自定义字段校验方法提供一个自定义的翻译方法，从而实现该字段错误提示信息的自定义显示。

// 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
}

定义好了相关翻译方法之后，我们在InitTrans函数中通过调用RegisterTranslation()方法来注册我们自定义的翻译方法。

// InitTrans 初始化翻译器
func InitTrans(locale string) (err error) {
	// ...liwenzhou.com...
	
		// 注册翻译器
		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
		}
		// 注意！因为这里会使用到trans实例
		// 所以这一步注册要放到trans初始化的后面
		if err := v.RegisterTranslation(
			"checkDate",
			trans,
			registerTranslator("checkDate", "{0}必须要晚于当前日期"),
			translate,
		); err != nil {
			return err
		}
		return
	}
	return
}

这样再次尝试发送请求，就能得到想要的错误提示信息了。

{
"code": 100002,
"msg": "参数错误 ,date的格式必须是2006-01-02"
}

总结

本文总结的go-zero框架中validator的使用技巧同样也适用于直接使用validator库，区别仅仅在于我们配置的是go-zero框架中的校验器还是由validator.New()创建的校验器。同时使用validator库确实能够在一定程度上减少我们的编码量，但是它不太可能完美解决我们所有需求，所以你需要找到两者之间的平衡点。

以上就是详解go-zero如何使用validator进行参数校验的详细内容，更多关于go validator参数校验的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

详解如何在Go服务中做链路追踪
使用 Go 语言开发微服务的时候，需要追踪每一个请求的访问链路，本文主要介绍了如何在Go 服务中做链路追踪，感兴趣的可以了解一下
2021-09-09
详解Go语言中net/http包的使用
Go语言内置的 net/http 包十分的优秀，提供了HTTP客户端和服务端的实现，本文主要就来和大家聊聊net/http包的使用，感兴趣的可以了解一下
2023-07-07
Go语言实现定时器的原理及使用详解
这篇文章主要为大家详细介绍了Go语言实现定时器的两种方法：一次性定时器（Timer）和周期性定时器(Ticker)，感兴趣的小伙伴可以跟随小编一起学习一下
2022-12-12
详解go语言中sort如何排序
我们的代码业务中很多地方需要我们自己进行排序操作，本文主要介绍了详解go语言中sort如何排序，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-03-03
go中值传递和指针传递的使用
在Go语言中,使用&和*可以分别取得变量的地址和值,解引用未初始化或为nil的指针会引发空指针异常,正确的做法是先进行nil检查,此外,nil在Go中用于多种类型的空值表示,值传递和指针传递各有适用场景,通常小型数据结构优先考虑值传递以减少解引用开销
2024-10-10
使用goland调试远程代码的操作步骤
大家都知道如何在goland调试远程代码吗？今天小编给大家分享一篇教程帮助大家学习goland调试远程代码的操作步骤，感兴趣的朋友跟随小编一起看看吧
2021-06-06
Go Interface接口初学者手册
这篇文章主要为大家介绍了Go Interface接口的基础用法实例,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2024-01-01
Go项目中的GOPROXY设置
GOPROXY是Go语言中用于指定模块代理服务器的环境变量,设置GOPROXY可以通过操作系统环境变量、Go命令行参数或Go环境配置文件进行,感兴趣的可以了解一下
2024-09-09
Golang语言如何避免空指针引发的panic详解
简单地说go语言的指针类型和C/C++的指针类型用法是一样的,除了出去安全性的考虑,go语言增加了一些限制,这篇文章主要给大家介绍了关于Golang语言如何避免空指针引发panic的相关资料,需要的朋友可以参考下
2022-01-01
Go iota关键字与枚举类型实现原理
这篇文章主要介绍了Go iota关键字与枚举类型实现原理，iota是go语言的常量计数器，只能在常量的表达式中使用，更多相关内容需要的小伙伴可以参考一下
2022-07-07