在结构标记验证中使用自定义错误消息

“纵有疾风来，人生不言弃”，这句话送给正在学习Golang的朋友们，也希望在阅读本文《在结构标记验证中使用自定义错误消息》后，能够真的帮助到大家。我也会在后续的文章中，陆续更新Golang相关的技术文章，有好的建议欢迎大家在评论留言，非常感谢！

我正在使用 go 1.17 和 gin，我想在将数据发送到数据库之前实现结构验证。我从 gin 文档中获取了示例。

在结构中，我们可以声明不同的标签来验证字段，如下所示：

type user struct {
    firstname      string `json:"first_name" binding:"required"`
    lastname       string `json:"last_name" binding:"required"`
    age            uint8  `json:"age" binding:"gte=0,lte=130"`
    email          string `json:"email" binding:"required,email"`
    favouritecolor string `json:"favourite_color" binding:"iscolor"`
}

在处理程序中，我可以像这样捕获错误：

var u user
if err := c.shouldbindwith(&u, binding.query); err == nil {
    c.json(http.statusok, gin.h{"message": "good job"})
} else {
    c.json(http.statusbadrequest, gin.h{"error": err.error()})
}

错误消息将是：

{
    "error": "key: 'user.firstname' error:field validation for 'firstname' failed on the 'required' tag\nkey: 'user.lastname' error:field validation for 'lastname' failed on the 'required' tag\nkey: 'user.email' error:field validation for 'email' failed on the 'required' tag\nkey: 'user.favouritecolor' error:field validation for 'favouritecolor' failed on the 'iscolor' tag"
}

错误消息太冗长，如何向用户返回更好的错误？我想对 json 响应进行建模，如下所示：

{
    "errors": [
        "first_name": "This field is required",
        "last_name": "This field is required",
        "age": "This field is required",
        "email": "Invalid email"
    ]
}

解决方案

gin gonic 使用 github.com/go-演示/validator/v10 包来执行绑定验证。如果验证失败，返回的错误为validator.ValidationErrors。

这没有明确提及，但在 Model binding and validation 中指出：

gin 使用 go-演示/validator/v10 进行验证。在此处查看有关标签使用的完整文档。

该链接指向 go-演示/validator/v10 文档，您可以在其中找到段落 Validation Functions Return Type error。

您可以使用标准 errors 包来检查错误是否是这样，将其解开并访问单个字段，即 validator.FieldError。由此，您可以构造您想要的任何错误消息。

给定这样的错误模型：

type apierror struct {
    field string
    msg   string
}

你可以这样做：

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
    }

使用辅助函数为您的验证规则输出自定义错误消息：

func msgfortag(tag string) string {
    switch tag {
    case "required":
        return "this field is required"
    case "email":
        return "invalid email"
    }
    return ""
}

在我的测试中，输出：

{
    "errors": [
        {
            "Field": "Number",
            "Msg": "This field is required"
        }
    ]
}

ps：要获得带有动态键的 json 输出，可以使用 map[string]string 而不是固定的结构模型。

到这里，我们也就讲完了《在结构标记验证中使用自定义错误消息》的内容了。个人认为，基础知识的学习和巩固，是为了更好的将其运用到项目中，欢迎关注golang学习网公众号，带你了解更多关于的知识点！