如何在 gin c.BindJSON 中处理 json.UnmarshalTypeError 的错误

亲爱的编程学习爱好者，如果你点开了这篇文章，说明你对《如何在 gin c.BindJSON 中处理 json.UnmarshalTypeError 的错误》很感兴趣。本篇文章就来给大家详细解析一下，主要介绍一下，希望所有认真读完的童鞋们，都有实质性的提高。

我正在尝试使用 gin gonic 捕获绑定错误，并且它可以很好地处理 go-演示/validator/v10 中的所有验证错误，但在解组到正确的数据类型时遇到捕获错误的问题。

结构体字段验证失败将返回 gin.errortypebind 使用验证器标记时的错误类型（必需，...）

但是如果我有一个结构

type foo struct {
  id int `json:"id"`
  bar string `json:"bar"`
}

我尝试传递的 json 格式错误（传递字符串而不是 id 的数字）

{
    "id":"string",
    "bar":"foofofofo"
}

它将失败并显示错误 json: cannot unmarshal string into go struct field foo.id of type int

它仍然在我的处理程序中被捕获为 gin.errortypebind 作为绑定错误，但由于我需要区分验证错误和解组错误，所以我遇到了问题。

我尝试过验证错误上的类型转换不适用于解组： e.err.(validator.validationerrors) 会出现恐慌

或者只是错误。但是这根本不会捕获错误

if errors.is(e.err, &json.unmarshaltypeerror{}) {
        log.println("json binding error")
    }

我这样做的目标是向用户返回格式正确的错误消息。目前它对于所有验证逻辑都运行良好，但我似乎无法使其适用于 json 数据，因为错误的数据会发送给我。

有什么想法吗？

编辑：

添加示例以重现：

package main

import (
    "encoding/json"
    "errors"
    "log"
    "net/http"

    "github.com/gin-gonic/gin"
    "github.com/go-playground/validator/v10"
)

type foo struct {
    id  int    `json:"id" binding:"required"`
    bar string `json:"bar"`
}

func fooendpoint(c *gin.context) {
    var foojson foo
    err := c.bindjson(&foojson)
    if err != nil {
        // caught and answer in the error mw
        return
    }
    c.json(200, "test")
}

func main() {
    api := gin.default()
    api.use(errormw())
    api.post("/foo", fooendpoint)
    api.run(":5000")
}

func errormw() gin.handlerfunc {
    return func(c *gin.context) {
        c.next()
        if len(c.errors) > 0 {
            for _, e := range c.errors {
                switch e.type {
                case gin.errortypebind:
                    log.println(e.err)
                    var jsonerr json.unmarshaltypeerror
                    if errors.is(e.err, &jsonerr) {
                        log.println("json binding error")
                    }
                    // if errors.as(e.err, &jsonerr) {
                    //  log.println("json binding error")
                    // }
                    // in reality i'm making it panic.
                    // errs := e.err.(validator.validationerrors)
                    errs, ok := e.err.(validator.validationerrors)
                    if ok {
                        log.println("error trying to cast validation type")
                    }
                    log.println(errs)
                    status := http.statusbadrequest
                    if c.writer.status() != http.statusok {
                        status = c.writer.status()
                    }
                    c.json(status, gin.h{"error": "error"})
                default:
                    log.println("other error")
                }

            }
            if !c.writer.written() {
                c.json(http.statusinternalservererror, gin.h{"error": "internal error"})
            }
        }
    }
}

尝试发送带有正文的 post 请求

{
  "id":"rwerewr",
   "bar":"string"
}

接口转换：错误是*json.unmarshaltypeerror，而不是validator.validationerrors

这会起作用：

{
  "id":1,
   "bar":"string"
}

这将（正确地）返回 键：'foo.id' 错误：'id' 的字段验证在'必需'标签 上失败

{ “栏”：“字符串” }

解决方案

[更新]：sice 版本 1.7.0，集成了 this PR，现在可以在 gin.error 上使用 errors.is / errors.as。

所以你可以写：

err := c.bindjson(&foojson)

if err != nil {
var jserr *json.unmarshaltypeerror
  if errors.as(err, &jserr) {
    fmt.println("the json is invalid")
  } else {
    fmt.println("this is something else")
  }
}

[编辑]：嗯，它不会修复@flimzy的答案：看看the docs，gin.error没有实现.unwrap()方法。

您必须首先将错误转换为 gin.error，然后检查 ginerr.err ：

// you can probably work with straight conversion from interface to target type :
if g, ok := err.(*gin.error); ok {
    if _, ok := g.err.(*json.unmarshaltypeerror); ok {
        log.println("json binding error")
    }
}

// or use errors.as() :
var g *gin.error
if errors.as(err, &g) {
    var j *json.unmarshaltypeerror
    if errors.as(g.err, &j) {
        log.println("json binding error")
    }
}

我最初的回答：

（修复@fllimzy 的答案）

1. 使用 errors.as
2. 由于 json.unmarshaltypeerror 是一个结构体（而不是接口），因此您必须显式区分 json.unmarshaltypeerror 和 *json.unmarshaltypeerror

尝试运行：

var jsonerr *json.unmarshaltypeerror  // emphasis on the '*'
if errors.as(e.err, &jsonerr) {
    log.println("json binding error")
}

以下是 errors.as() 行为方式的说明：
https://play.golang.org/p/RVz6xop5k4u

errors.is 查找完全匹配（在您的情况下，是 json.unmarshaltypeerror 的空实例）。使用 errors.as 代替：

var jsonErr *json.UnmarshalTypeError
if errors.As(e.Err, &jsonErr) {
    log.Println("Json binding error")
}

Playground example

但是，正如 @legec 所指出的，这假设 gin 的错误符合标准 unwrapper 接口，但事实并非如此。

理论要掌握，实操不能落！以上关于《如何在 gin c.BindJSON 中处理 json.UnmarshalTypeError 的错误》的详细介绍，大家都掌握了吧！如果想要继续提升自己的能力，那么就来关注golang学习网公众号吧！