go - 当字段实现 UnmarshalJSON 时，Unmarshal 嵌入式字段指针会出现困惑

Question

我有一个 struct，它嵌入了一个指向另一个 struct 的嵌入式指针。当我使用默认的 json.Unmarshal 行为时，它工作得很好。但是当我为 embedded struct 的类型实现 UnmarshalJSON 而不是 外部 struct，然后使用空指针解引用进行 panic 。

如果我也为外部 struct 类型实现 UnmarshalJSON，那么它就可以工作。但是，外部结构有许多字段，我宁愿不必手动解码。

1. 为什么在一个而不是另一个上实现 UnmarshalJSON 会导致 panic ？
2. 有没有办法在不为外部类型实现 UnmarshalJSON 的情况下让它工作？
3. 如果没有，是否有更简单/更少手动的方法来为外部类型实现 UnmarshalJSON？

注意: 有一个标题相似的问题，“json.Unmarshal fails when embedded type has UnmarshalJSON”，但那里的问题与我的不同。

tl;dr:这个问题的其余部分只是上述问题的一个冗长示例。

基本示例

(play.golang.org version 的例子)

两个结构，一个带有指向另一个的嵌入式字段指针:

(例如经过简化——这实际上并不需要它自己的 UnmarshalJSON，但它演示了问题。)

type Obj struct {
    X int `json:"x"`
}

type Container struct {
    *Obj
    Y int `json:"y"`
}

调用解码:

func main() {
    b := []byte(`{"x": 5, "y": 3}`)
    c := &Container{}
    err := json.Unmarshal(b, c)
    if err != nil {
        fmt.Printf("error ummarshalling json: %+v\n", err)
        return
    }
    fmt.Printf("unmarshalled: %+v --> %+v\n", c, c.Obj)
}

没有实现任何 UnmarshalJSON 函数，这工作正常:

unmarshalled: &{Obj:0x416080 Y:3} --> &{X:5}

panic

但是，如果我将 UnmarshalJSON 添加到嵌入的 Obj 类型中，那么程序会出现困惑，因为 json.Unmarshal 调用传递了一个nil 指针，当它试图解码 *Obj 时。

func (o *Obj) UnmarshalJSON(b []byte) (err error) {
    m := make(map[string]int)
    err = json.Unmarshal(b, &m)
    if err != nil {
        return nil
    }
    o.X = m["x"] // the line indicated by panic
    return nil
}

输出:

panic: runtime error: invalid memory address or nil pointer dereference
[...]
main.(*Obj).UnmarshalJSON(0x0, 0x416030, 0x10, 0x10, 0x0, 0x0)
    /tmp/sandbox185809294/main.go:18 +0x130
[...]

问题:为什么这里会出现 panic ，但默认的解码行为不会出现 panic ？我想如果一个 nil *Obj 被传递到这里，那么默认行为也会传递一个 nil 指针...

修复 panic

当我为外部 Container 类型实现 UnmarshalJSON 时，它不再 panic :

func (c *Container) UnmarshalJSON(b []byte) (err error) {
    m := make(map[string]int)
    err = json.Unmarshal(b, &m)
    if err != nil {
        return err
    }
    c.Obj = &Obj{X: m["x"]}
    c.Y = m["y"]
    return nil
}

但是，如果真正的 Container 和真正的 Obj 都有比这更多的字段，每个字段都有不同的类型，那么以这种方式手动解码 Container 会很乏味.

问题:有没有更简单的方法来防止这种 panic ？

Answer 1

因为默认行为会检查 nil 而您的自定义解码程序不会。您需要在 UnmarshalJSON 中使用一些逻辑来检查 o 是否为 nil 并表现得适当，而不是假设 o 是不是 nil(通过尝试访问其字段之一)，从而引发 panic 。

func (o *Obj) UnmarshalJSON(b []byte) (err error) {
    if o == nil {
        return nil // maybe? What do you want to happen in this case?
    }
    m := make(map[string]int)
    err = json.Unmarshal(b, &m)
    if err != nil {
        return nil
    }
    o.X = m["x"] // the line indicated by panic
    return nil
}

同样仅供将来引用，您的*Obj 字段不是“匿名字段”，它是一个嵌入 字段:https://golang.org/ref/spec#Struct_types