Go语言：如何仅在切片非nil时序列化？nil切片不生成JSON字段

方案一：自定义切片类型并实现JSON序列化接口 #

这是最通用的方案，适合多个结构体复用该切片类型的场景。

1. 定义自定义切片类型

type HouseSlice []House

2. 实现json.Marshaler接口
   通过判断切片是否为nil，决定返回的序列化结果：

import "encoding/json"

func (hs HouseSlice) MarshalJSON() ([]byte, error) {
    // 当切片为nil时，返回nil，配合omitempty标签会省略该字段
    if hs == nil {
        return nil, nil
    }
    // 非nil切片（包括空切片）使用默认序列化逻辑
    return json.Marshal([]House(hs))
}

3. 修改原结构体字段类型
   将Foo中的NextSet字段类型替换为自定义的HouseSlice，并保留omitempty标签：

type Foo struct {
    NextSet HouseSlice `json:"next_set,omitempty"`
}

4. （可选）实现反序列化接口
   如果需要支持反序列化，还需实现json.Unmarshaler接口，确保nil和空切片的状态能正确还原：

func (hs *HouseSlice) UnmarshalJSON(data []byte) error {
    var temp []House
    if err := json.Unmarshal(data, &temp); err != nil {
        return err
    }
    if temp == nil {
        *hs = nil
    } else {
        *hs = HouseSlice(temp)
    }
    return nil
}

方案二：给结构体直接实现JSON序列化接口 #

如果仅针对Foo结构体处理，也可以直接给Foo实现json.Marshaler接口，无需修改切片类型：

func (f Foo) MarshalJSON() ([]byte, error) {
    // 定义结构体别名，避免递归序列化
    type Alias Foo

    if f.NextSet == nil {
        // NextSet为nil时，序列化不包含该字段的结构体
        return json.Marshal(struct {
            Alias
            NextSet []House `json:"next_set,omitempty"`
        }{
            Alias: Alias(f),
            NextSet: nil, // 显式设为nil，配合omitempty省略
        })
    }
    // NextSet非nil（包括空切片）时，序列化完整结构体
    return json.Marshal(Alias(f))
}

测试验证 #

运行以下测试代码可以验证效果：

func main() {
    // 测试1：NextSet为nil
    fooNil := Foo{}
    dataNil, _ := json.Marshal(fooNil)
    println(string(dataNil)) // 输出: {}

    // 测试2：NextSet为空切片
    fooEmpty := Foo{NextSet: []House{}}
    dataEmpty, _ := json.Marshal(fooEmpty)
    println(string(dataEmpty)) // 输出: {"next_set":[]}

    // 测试3：NextSet包含元素
    fooWithData := Foo{NextSet: []House{{Name: "别墅"}}} // 假设House有Name字段
    dataWithData, _ := json.Marshal(fooWithData)
    println(string(dataWithData)) // 输出: {"next_set":[{"Name":"别墅"}]}
}

原理说明 #

Go标准库的encoding/json包中，当字段使用omitempty标签时，如果该字段的序列化结果为nil，则会省略该字段。通过自定义序列化逻辑，我们让nil切片返回nil，空切片返回[]的JSON数据，从而实现了两者的区分。

内容的提问来源于stack exchange，提问作者bcsta