为空自定义类型省略 JSON

Question

我正在尝试为可能的 nil 数据库类型编写自定义封送拆收器。它的结构与 sql.NullFloat64 类型完全相同：

type NullFloat64 sql.NullFloat64

func (ni *NullFloat64) MarshalJSON() ([]byte, error) {
    if !ni.Valid {
        return []byte("null"), nil
    }
    return json.Marshal(ni.Float64)
}

要整理的较大 struct 的一部分：

type Data struct {
    X time.Time `json:"x"`
    Y float32 `json:"y"`
    Stderr NullFloat64 `json:"stderr"`
}

如果我尝试 json.Marshal() 这个 struct，它会正常工作，创建：

{"x":"2017-01-12T23:36:12-05:00","y":4,"stderr":null}

如果值为 null，我想完全省略 JSON 键。我将 json:"stderr,omitempty" 添加到 Data。

根据建议 here，我尝试只从 MarshalJSON 返回一个 nil 值，但得到：

json: error calling MarshalJSON for type common.NullFloat64: unexpected end of JSON input

我还尝试将 Data 更新为：

type Data struct {
    X time.Time `json:"x"`
    Y float32 `json:"y"`
    Stderr *NullFloat64 `json:"stderr,omitempty"`
}

和编组：

Data {
    X: datetime,
    Y: value,
    Stderr: &stderr,
}

但是从 MarshalJSON 返回 nil 时出现了和以前一样的错误。

那么，如何为自定义类型实现 MarshalJSON 并在编组时省略密钥？谢谢您的帮助！

Answer 1

如果你创建你这样输入：

Data {
    X: datetime,
    Y: value,
    Stderr: nil,
}

omitempty 将开始并且 "do the right thing"。遗憾的是，我很确定这对你没有帮助。

如果你真的想省略一个基于字段的内部状态，你需要在你的结构上实现 json.Marshaller，而不是它的 children。最简单的方法如下：

func (d Data) MarshalJSON() ([]byte, error) {
    if !d.Stderr.Valid {
        return json.Marshal(Data{d.X, d.Y, nil})
    }
    return json.Marshal(d)
}

为空自定义类型省略 JSON

Omitting JSON for Empty Custom Type

marshalling

go