如何不使用Go将空结构封送到JSON中？

Question

我有一个这样的结构：

type Result struct {
    Data       MyStruct  `json:"data,omitempty"`
    Status     string    `json:"status,omitempty"`
    Reason     string    `json:"reason,omitempty"`
}

但是，即使MyStruct的实例完全为空（也就是说，所有值都是默认值），它也被序列化为：

"data":{}

我知道编码/json文档指定“空”字段是：

false、0、任何nil指针或接口值，以及任何长度为零的数组、切片、映射或字符串

但不考虑所有空/默认值的结构。它的所有字段也用omitair标记，但这没有效果。

如何让JSON包不封送我的空结构字段？

Answer 1

Data是一个初始化的结构，因此它不被认为是空的，因为encoding/json只查看立即数，而不查看结构中的字段。

不幸的是，从json返回nil。封送拆收器当前不工作：

func (_ MyStruct) MarshalJSON() ([]byte, error) {
    if empty {
        return nil, nil // unexpected end of JSON input
    }
    // ...
}

您也可以给Result一个封送拆收器，但这不值得付出努力。

正如马特所建议的，唯一的选择是将数据设为指针，并将值设置为nil。

Answer 2

正如@chakrit在一篇评论中提到的，您无法通过实现json来实现这一点。MyStruct上的封送拆收器，并在使用它的每个结构上实现自定义JSON封送函数可能需要做很多工作。这实际上取决于您的用例是否值得付出额外的工作，或者您是否准备在JSON中使用空结构，但下面是我用于结果的模式：

type Result struct {
    Data       MyStruct
    Status     string   
    Reason     string    
}

func (r Result) MarshalJSON() ([]byte, error) {
    return json.Marshal(struct {
        Data     *MyStruct   `json:"data,omitempty"`
        Status   string      `json:"status,omitempty"`
        Reason   string      `json:"reason,omitempty"`
    }{
        Data:   &r.Data,
        Status: r.Status,
        Reason: r.Reason,
    })        
}

func (r *Result) UnmarshalJSON(b []byte) error {
    decoded := new(struct {
        Data     *MyStruct   `json:"data,omitempty"`
        Status   string      `json:"status,omitempty"`
        Reason   string      `json:"reason,omitempty"`
    })
    err := json.Unmarshal(b, decoded)
    if err == nil {
        r.Data = decoded.Data
        r.Status = decoded.Status
        r.Reason = decoded.Reason
    }
    return err
}

如果你有一个包含很多字段的巨大结构，这可能会变得很乏味，尤其是以后更改结构的实现，但是除了重新编写整个json包以满足你的需要（这不是一个好主意），这几乎是我能想到的唯一一种方法，在保持非指针MyStruct的同时完成这项工作。

此外，您不必使用内联结构，您可以创建命名结构。不过，我使用LiteIDE来完成代码，所以我更喜欢内联以避免混乱。

Answer 3

正如医生所说，“任何零指针。”使结构成为指针。指针具有明显的“空”值：nil。

修复-定义具有结构指针字段的类型：

type Result struct {
    Data       *MyStruct `json:"data,omitempty"`
    Status     string    `json:"status,omitempty"`
    Reason     string    `json:"reason,omitempty"`
}

然后是这样的值：

result := Result{}

将列表为：

{}

说明：注意类型定义中的*MyStruct。JSON序列化并不关心它是否是指针——这是一个运行时细节。因此，将结构字段变成指针只会影响编译和运行时）。

请注意，如果将字段类型从MyStruct更改为*MyStruct，则需要指向结构值的指针来填充它，如下所示：

Data: &MyStruct{ /* values */ }