如何不使用 Go 将空结构编组为 JSON？

正如文档所说，“任何 nil 指针”。 -- 使结构成为指针。指针具有明显的“空”值：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 */ }

---

正如@chakrit 在评论中提到的那样，您无法通过在 MyStruct 上实现 json.Marshaler 来实现它，并且在每个使用它的结构上实现自定义 JSON 编组函数可能需要更多的工作。这实际上取决于您的用例是否值得额外的工作，或者您是否准备好在 JSON 中使用空结构，但这是我用于 Result 的模式：

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 和代码完成功能，所以我更喜欢内联以避免混乱。

---

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

遗憾的是，目前无法从 json.Marshaler 返回 nil：

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

您也可以给 Result 一个封送处理程序，但这不值得。

正如马特建议的那样，唯一的选择是使 Data 成为指针并将值设置为 nil。

---

这个特性有一个出色的 Golang proposal，它已经活跃了 4 年多，所以在这一点上，可以肯定地假设它不会很快进入标准库。正如@Matt 所指出的，传统的 方法是将structs 转换为pointers-to-structs。如果这种方法不可行（或不切实际），那么另一种方法是使用支持省略零值结构的替代 json 编码器。

我创建了 Golang json 库 (clarketm/json) 的镜像，添加了在应用 omitempty 标记时省略零值结构的支持。该库检测 zeroness 的方式与 recursively checking the public struct fields 的流行 YAML 编码器 go-yaml 类似。

例如

$ go get -u "github.com/clarketm/json"

import (
    "fmt"
    "github.com/clarketm/json" // drop-in replacement for `encoding/json`
)

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

j, _ := json.Marshal(&Result{
    Status: "204",
    Reason: "No Content",
})

fmt.Println(string(j))

// Note: `data` is omitted from the resultant json.
{
  "status": "204"
  "reason": "No Content"
}

---