如何在 Go 中使用 Struct 标签自定义验证错误消息？

使用结构体标签自定义验证错误消息

在使用 Gin 的 Go Web 开发中，结构体验证在持久化之前确保数据完整性方面起着至关重要的作用。然而，底层验证库提供的默认错误消息可能很冗长且不太用户友好。本文探讨了如何根据结构体标签返回自定义错误消息，让开发者能够向用户提供更有意义、更可操作的反馈。

理解 Validator.ValidationErrors

Gin 利用用于验证的 github.com/go-playground/validator/v10 库。当验证失败时，会返回 validator.ValidationErrors 类型的错误。此错误类型包含一个 validator.FieldError 实例片段，每个实例代表一个无效字段。

自定义错误消息

要自定义错误消息，您可以解开验证器。 ValidationErrors错误使用errors包，访问validator.FieldError，并根据字段的标签构造自定义错误消息。结构体字段中的 tag 属性允许开发人员指定自定义验证规则和错误消息。

例如，考虑以下代码片段：

type ApiError struct {
    Field string
    Msg   string
}

func msgForTag(tag string) string {
    switch tag {
    case "required":
        return "This field is required"
    case "email":
        return "Invalid email"
    }
    return ""
}

此代码定义了一个 ApiError 结构体和一个辅助函数函数 msgForTag 将标签映射到自定义错误消息。使用它们，您可以实现以下处理程序：

var u User
err := c.BindQuery(&u);
if err != nil {
    var ve validator.ValidationErrors
    if errors.As(err, &ve) {
        out := make([]ApiError, len(ve))
        for i, fe := range ve {
            out[i] = ApiError{fe.Field(), msgForTag(fe.Tag())}
        }
        c.JSON(http.StatusBadRequest, gin.H{"errors": out})
    }
    return
}

在此处理程序中，validator.ValidationErrors 错误被展开，并且每个 validator.FieldError 都会转换为带有基于字段标签的自定义消息的 ApiError 。然后对 ApiError 切片进行 JSON 编码，并作为错误响应返回，其中包含与字段对应的动态键。

结论

通过使用结构标记自定义验证错误消息，开发人员可以在数据验证期间提供更加用户友好且信息丰富的反馈。这种方法增强了用户体验并简化了调试过程，从而更容易识别和纠正输入错误。

以上是如何在 Go 中使用 Struct 标签自定义验证错误消息？的详细内容。更多信息请关注PHP中文网其他相关文章！