Go语言中常见100问题-#22 空切片与nil切片最佳实践

站长

2024年04月01日 09:25 · 阅读数 4

空切片与nil切片定义

很多开发人员经常混淆nil切片和空切片,不清楚什么时候使用空切片什么时候使用nil，而有些库函数又对这两者使用进行了区分。下面先来看看它们的定义。

空切片是length为0的切片
当切片等于nil时为nil切片

空切片与nil切片初始化

下面是几种不同空切片和nil切片的初始化方法，对于每种情况，都会打印它们的输出。你知道下面程序的输出结果是什么吗?

func main() {
    var s []string
    log(1, s)
    s = []string(nil)
    log(2, s)
    s = []string{}
    log(3, s)
    s = make([]string, 0)
    log(4, s)
}

func log(i int, s []string) {
    fmt.Printf("%d: empty=%t\tnil=%t\n", i, len(s) == 0, s == nil)
}

上面程序的运行结果如下：

1: empty=true nil=true
2: empty=true nil=true
3: empty=true nil=false
4: empty=true nil=false

通过输出可以看到，上面四种切片empty都为true，即它们都是空切片，它们的length都为0. 因此nil切片都是空切片。但是只有前两种情况是nil切片。

空切片与nil切片最佳实践

在具体环境中，使用哪种方法更好呢？有两点需要注意：

两者在内存分配方面有很大的不同，初始化一个nil切片不会实际分配内存，相反，初始化一个空切片会分配内存
无论是nil切片还是空切片，都可以调用内置的append函数，例如。

var s1 []string
fmt.Println(append(s1, "foo")) // [foo]

因此，如果一个函数返回一个切片，我们不应该像在其它编程语言中那样，出于防御原因返回一个空切片。因为nil切片不需要任何分配，所以我们应该倾向于返回nil切片而不是空切片。下面这个函数返回一个字符串：

func f() []string {
    var s []string
    if foo() {
       s = append(s, "foo")
    }
    if bar() {
       s = append(s, "bar")
    }
    return s
}

如果foo和bar都为false,不会向s中添加任何内容。为了防止多余的分配内存操作，最佳的方法采用上面的方法1（var s []string). 虽然也可以采用第4种方法（ make([]string,0)), 但是与方法1相比，不会带来任何收益，因为它会分配内存。但是，在我们已知要申请切片的长度情况下，应该使用方法4. s:=make([]string,length), 像下面的程序一开始就初始化切片长度，这样可以避免额外的内存分配和复制。

func intsToStrings(ints []int) []string {
    s := make([]string, len(ints))
    for i, v := range ints {
       s[i] = strconv.Itoa(v)
    }
    return s
}

剩余未讨论的方法2 s:=[]string(nil)和方法3 s:=[]string{}中，方法2使用的最不广泛，只是可以用作语法糖，因为我们可以在一行代码中完成定义一个nil切片并完成元素添加操作，示例程序如下。如果采用方法1（var s []string), 则需要两行代码, 虽然这种优化对可读性没有实质性帮助，但仍值得了解。

s := append([]int(nil), 42)

现在来看方法3，s:=[]string{}, 它比较适用在创建具有初始元素切片的场景。

s := []string{"foo", "bar", "baz"}

如果我们创建的切片没有初始化元素，则没有必要使用上述方法。一些golang linter会捕获到方法3在没有初始化元素的时候，推荐使用方法1，我们应该知道这种修改实质是将空切片调整为nil切片。

nil切片引发的bug

我们也要留意，有些库对空切片和nil切片在处理时有区别。例如json库 encoding/json. 下面的例子中都是对struct进行序列化，结构体1中赋值的是nil切片，结构体2中赋值的是空切片。

var s1 []float32
customer1 := customer{
    ID:         "foo",
    Operations: s1,
}
b, _ := json.Marshal(customer1)
fmt.Println(string(b))

s2 := make([]float32, 0)
customer2 := customer{
    ID:         "bar",
    Operations: s2,
}
b, _ = json.Marshal(customer2)
fmt.Println(string(b))

运行上述程序得到如下结果，可以看到它们的结果是不同的。nil切片序列化后的值为null, 空切片序列化后的值为[]. 如果解析JSON的客户端对null和[]有严格的区分，需要特别留意这一点，否则会产生bug.

{"ID":"foo","Operations":null}
{"ID":"bar","Operations":[]}

encoding/json 并不是唯一一个区分 nil 切片和空切片的标准库，标准库 reflect 中 DeepEqual函数在比较nil切片和空切片时会返回false, 这一点在单元测试的时候要特别小心。

思考总结

不管什么场合，无论是标准库还是第三方库，我们都要留意nil切片和空切片存在区别，如果使用不当，可能会引发问题。在Go语言中，nil切片和空切片是有区别的。nil切片与nil相等，空切片的长度为0，但是它不等于nil。重要的一点是 nil切片不会分配内存，空切片会分配内存。具体使用哪种方法更好需要具体问题具体分析。如果能够确定最后返回的切片为空，则推荐使用 var s []string, 如果在初始化时已知道切片的长度，则采用make([]string,length)最好，[]string(nil)提供了一种语法糖，方便添加元素操作。最后一点，如果在进行初始化时没有元素，则避免使用 []string{}, 还要留意标准库和第三方库对nil切片和空切片处理可能存在不同，如果使用不当会产生意料之外的结果。