Go：nil切片的JSON序列化

【译文】原文地址
Go最令人沮丧的事之一是它在编码JSON的时候如何对nil切片的处理。其并不是返回我们期望的空数组，而是返回Null，如下代码所示：

package main

import (
    "encoding/json"
    "fmt"
)

// Bag holds items
type Bag struct {
    Items []string
}

// PrintJSON converts payload to JSON and prints it
func PrintJSON(payload interface{}) {
    response, _ := json.Marshal(payload)
    fmt.Printf("%s\n", response)
}


func main() {
    bag1 := Bag{}
    PrintJSON(bag1)
}

Outputs:

{"Items":null}

这是根据json包对nil切片处理方式决定的：

数组和切片值编码为JSON数组,除了[]byte编码为base64字符串，nil切片编码为null JSON值。

有一些建议可以修改json包来处理nil切片：

  • encoding/json nilasempty将nil-slice编码为[]
  • encoding/json: "nonil"结构体标签将空切片映射为non-null
    目前这些建议还没有在json包中实现。因此，为了解决null数组的问题，必须将nil切片设置为空切片。看如下修改：

package main

import (
    "encoding/json"
    "fmt"
)

// Bag holds items
type Bag struct {
    Items []string
}

// PrintJSON converts payload to JSON and prints it
func PrintJSON(payload interface{}) {
    response, _ := json.Marshal(payload)
    fmt.Printf("%s\n", response)
}


func main() {
    bag1 := Bag{}
    bag1.Items = make([]string, 0)
    PrintJSON(bag1)
}

输出更改为：

{"Items":[]}

然而，在任何可能存在nil切片的地方都要这样设置为空切片是很繁琐的。有没有更好的方法？

方法1：自定义Marshaler

根据Go json文档：

Marshal递归地遍历值v。如果遇到的值实现了Marshaler接口并且不是空指针，Marshal函数会调用对应类型的MarshalJSON方法来编码JSON。

因此，如果我们实现了Marshaler接口：

// Marshaler is the interface implemented by types that
// can marshal themselves into valid JSON.
type Marshaler interface {
    MarshalJSON() ([]byte, error)
}

对象在编码成JSON的时候，自定义的MarshalJSON方法会被调用。看如下修改：

package main

import (
    "encoding/json"
    "fmt"
)

// Bag holds items
type Bag struct {
    Items []string
}

// MarshalJSON initializes nil slices and then marshals the bag to JSON
func (b Bag) MarshalJSON() ([]byte, error) {
    type Alias Bag
    
    a := struct {
        Alias
    }{
        Alias:    (Alias)(b),
    }

    if a.Items == nil {
        a.Items = make([]string, 0)
    }

    return json.Marshal(a)
}

// PrintJSON converts payload to JSON and prints it
func PrintJSON(payload interface{}) {
    response, _ := json.Marshal(payload)
    fmt.Printf("%s\n", response)
}


func main() {
    bag1 := Bag{}
    PrintJSON(bag1)
}

Outputs:

{"Items":[]}

代码中Alias类型别名是必须的，为了防止调用json.Marshal时候陷入无限循环。

方法2：动态初始化

另一种处理nil切片的方法是使用reflect包动态地检查结构体中的每个字段，如果是nil切片就用空切片来替换。如下所示：

package main

import (
    "encoding/json"
    "fmt"
    "reflect"
)

// Bag holds items
type Bag struct {
    Items []string
}

// NilSliceToEmptySlice recursively sets nil slices to empty slices
func NilSliceToEmptySlice(inter interface{}) interface{} {
    // original input that can't be modified
    val := reflect.ValueOf(inter)

    switch val.Kind() {
    case reflect.Slice:
        newSlice := reflect.MakeSlice(val.Type(), 0, val.Len())
        if !val.IsZero() {
            // iterate over each element in slice
            for j := 0; j < val.Len(); j++ {
                item := val.Index(j)

                var newItem reflect.Value
                switch item.Kind() {
                case reflect.Struct:
                    // recursively handle nested struct
                    newItem = reflect.Indirect(reflect.ValueOf(NilSliceToEmptySlice(item.Interface())))
                default:
                    newItem = item
                }

                newSlice = reflect.Append(newSlice, newItem)
            }

        }
        return newSlice.Interface()
    case reflect.Struct:
        // new struct that will be returned
        newStruct := reflect.New(reflect.TypeOf(inter))
        newVal := newStruct.Elem()
        // iterate over input's fields
        for i := 0; i < val.NumField(); i++ {
            newValField := newVal.Field(i)
            valField := val.Field(i)
            switch valField.Kind() {
            case reflect.Slice:
                // recursively handle nested slice
                newValField.Set(reflect.Indirect(reflect.ValueOf(NilSliceToEmptySlice(valField.Interface()))))
            case reflect.Struct:
                // recursively handle nested struct
                newValField.Set(reflect.Indirect(reflect.ValueOf(NilSliceToEmptySlice(valField.Interface()))))
            default:
                newValField.Set(valField)
            }
        }

        return newStruct.Interface()
    case reflect.Map:
        // new map to be returned
        newMap := reflect.MakeMap(reflect.TypeOf(inter))
        // iterate over every key value pair in input map
        iter := val.MapRange()
        for iter.Next() {
            k := iter.Key()
            v := iter.Value()
            // recursively handle nested value
            newV := reflect.Indirect(reflect.ValueOf(NilSliceToEmptySlice(v.Interface())))
            newMap.SetMapIndex(k, newV)
        }
        return newMap.Interface()
    case reflect.Ptr:
        // dereference pointer
        return NilSliceToEmptySlice(val.Elem().Interface())
    default:
        return inter
    }
}

// PrintJSON converts payload to JSON and prints it
func PrintJSON(payload interface{}) {
    newPayload := NilSliceToEmptySlice(payload)
    response, _ := json.Marshal(newPayload)
    fmt.Printf("%s\n", response)
}

func main() {
    bag1 := Bag{}
    PrintJSON(bag1)
}

Output:

{"Items":[]}

总结

使用自定义Marshaler的缺点是必须为每个包含切片的结构体实现Marshaler接口。动态初始化方式肯定会慢一些，因为需要对结构体的每个字段都进行检查。然而这种方法，在有许多带切片的结构体，并且需要调用json.Marshal()方法的情况，可以很好的工作。

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 215,133评论 6赞 497
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 91,682评论 3赞 390
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 160,784评论 0赞 350
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 57,508评论 1赞 288
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 66,603评论 6赞 386
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 50,607评论 1赞 293
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,604评论 3赞 415
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 38,359评论 0赞 270
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,805评论 1赞 307
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,121评论 2赞 330
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,280评论 1赞 344
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 34,959评论 5赞 339
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,588评论 3赞 322
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,206评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,442评论 1赞 268
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 47,193评论 2赞 367
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 44,144评论 2赞 352