Go 切片绕坑指南

在Go中按值传递时，为何有时会更改切片？

不知道你们有没有发如今一个函数内部对切片参数进行了排序后也会改变函数外部原来的切片中元素的顺序，可是在函数内向切片增长了元素后在函数外的原切片却没有新增元素，更奇怪的是添加并排序后，外部的切片有可能元素数量和元素顺序都不会变，这是为何呢？咱们经过三个小测验来解释形成这个现象的缘由。

测验一

下面的代码的输出什么？

func main() {
  var s []int
  for i := 1; i <= 3; i++ {
    s = append(s, i)
  }
  reverse(s)
  fmt.Println(s)
}

func reverse(s []int) {
  for i, j := 0, len(s) - 1; i < j; i++ {
    j = len(s) - (i + 1)
    s[i], s[j] = s[j], s[i]
  }
}
复制代码

Run it on the Go Playground → play.golang.org/p/faJ3WNxpR…

上面的代码中虽然经过值传递了s，为何在函数调用后在外部仍能看到s的变化？

你们都知道切片是指向底层数组的指针，切片自己不存储任何数据。这意味着即便在这里按值传递切片，函数中的切片仍指向相同的内存地址。因此在reverse()内部使用的切片是一个不一样的指针对象，但仍将指向相同的内存地址，共享相同的数组。因此在函数调用以后，该数组中的数字从新排列，函数外部的切片与内部的切片共享着相同的底层数组，因此外部的 s 表现出来的就是它也被排序了。

测验二

咱们将在reverse（）函数内稍微更改一下代码，在函数里添加单个append调用。它如何改变咱们的输出？

func main() {
  var s []int
  for i := 1; i <= 3; i++ {
    s = append(s, i)
  }
  reverse(s)
  fmt.Println(s)
}

func reverse(s []int) {
  s = append(s, 999)
  for i, j := 0, len(s) - 1; i < j; i++ {
    j = len(s) - (i + 1)
    s[i], s[j] = s[j], s[i]
  }
}
复制代码

Run it on the Go Playground → play.golang.org/p/tZpkaLA9c…

这一次，在函数外面输出s时能够看到它保持了排序后的顺序，可是以前的元素1去哪了？

咱们先看一下 slice 的定义

type slice struct {
  array unsafe.Pointer
  len   int
  cap   int
}
复制代码

当咱们调用append时，将建立一个新切片。新切片具备新的“长度”属性，该属性不是指针，但仍指向同一数组。所以，咱们函数内的代码最终会反转原始切片所引用的数组，可是原始切片的长度属性仍是以前的长度值，这就是形成了上面 1被丢掉的缘由。

最终测验

最后咱们在reverse（）函数内部的切片中添加一些额外的数字。函数执行完后在外部打印切片s看看会输出什么。

func main() {
  var s []int
  for i := 1; i <= 3; i++ {
    s = append(s, i)
  }
  reverse(s)
  fmt.Println(s)
}

func reverse(s []int) {
  s = append(s, 999, 1000, 1001)
  for i, j := 0, len(s)-1; i < j; i++ {
    j = len(s) - (i + 1)
    s[i], s[j] = s[j], s[i]
  }
}
复制代码

Run it on the Go Playground → play.golang.org/p/dnbKtLZG8…

在咱们的最终测验中，不只切片长度没有保留，并且切片的顺序也不受影响。为何？

如前所述，当咱们调用append时，会建立一个新的切片。在第二个测验中，此新切片仍指向同一底层数组，由于它具备足够的容量来添加新元素，所以该数组没有更改，可是在此示例中，咱们添加了三个元素，而咱们的切片没有足够的容量。因而 系统分配了一个新数组，让切片指向该数组。当咱们最终在reverse函数内开始反转切片中的元素时，它再也不影响咱们的初始数组，而是在彻底不一样的数组上运行。

经过 cap 函数验证咱们的结论

咱们能够经过使用cap函数来检查传递给reverse（）的切片的容量来验证正在发生的事情。

func reverse(s []int) {
  newElem := 999
  for len(s) < cap(s) {
    fmt.Println("Adding an element:", newElem, "cap:", cap(s), "len:", len(s))
    s = append(s, newElem)
    newElem++
  }
  for i, j := 0, len(s)-1; i < j; i++ {
    j = len(s) - (i + 1)
    s[i], s[j] = s[j], s[i]
  }
}
复制代码

Run it on the Go Playground → play.golang.org/p/SBHRj4dPF…

只要不超出切片的容量，咱们最终就会在main（）函数中看到reverse函数对切片进行的更改。咱们仍然看不到长度的变化，可是咱们将看到切片的底层数组中元素的从新排列。

若是在将切片填充到容量长度后，在s上再调用append（），咱们将不会再在main（）函数中看到这些更改，由于咱们的reverse 函数中的代码将一个新切片指向到了一个彻底不一样的数组。

从切片或数组派生的切片也会受到影响

若是咱们恰巧在代码中建立了从现有切片或数组派生的新切片，那么咱们也能够看到相同的效果。例如，若是您调用s2：= s [：]而后将s2传递到咱们的reverse（）函数中，则可能最终仍会影响s，由于s2和s都指向同一个支持数组。一样，若是咱们向s2附加新元素，最终致使其超出支持数组，咱们将再也不看到对一个切片的更改会影响另外一个切片。

严格来讲，这不是一件坏事。经过在绝对须要以前不随意复制基础数组，咱们最终得到了效率更高的代码，但编写代码时须要考虑到这一点，因此想确保在函数外也能看到函数内程序对切片的更改，那么在函数中必定要把新切片 return 给外部，即便切片是一种引用类型。这也是不要其余编程语言经验带入到 Go上的缘由。

这个问题不只限于切片类型

这不只限于切片。切片是最容易陷入此陷阱的类型，可是任何带有指针的类型均可能受到影响。以下所示。

type A struct {
  Ptr1 *B
  Ptr2 *B
  Val B
}

type B struct {
  Str string
}

func main() {
  a := A{
    Ptr1: &B{"ptr-str-1"},
    Ptr2: &B{"ptr-str-2"},
    Val: B{"val-str"},
  }
  fmt.Println(a.Ptr1)
  fmt.Println(a.Ptr2)
  fmt.Println(a.Val)
  demo(a)
  fmt.Println(a.Ptr1)
  fmt.Println(a.Ptr2)
  fmt.Println(a.Val)
}

func demo(a A) {
  // Update a value of a pointer and changes will persist
  a.Ptr1.Str = "new-ptr-str1"
  // Use an entirely new B object and changes won't persist
  a.Ptr2 = &B{"new-ptr-str-2"}
  a.Val.Str = "new-val-str"
}
复制代码

Run it on the Go Playground → play.golang.org/p/8X-57DvgM…

和这个例子相似，在 Go 中切片的定义以下：

type slice struct {
  array unsafe.Pointer
  len   int
  cap   int
}
复制代码

注意到array字段其实是一个指针了吗？这意味着切片会表现得像Go中其余具备嵌套指针的任何类型同样，实际上一点都不特殊，它只是刚好是不多有人关注其内部的类型。

最终，这意味着开发人员须要知道他们传递的数据类型以及所调用的函数可能会如何影响它们。当你将切片传递给其余函数或方法时，应该注意函数可能会，也可能不会更改原始切片中的元素。

一样，你应始终意识到，内部带有指针的结构很容易陷入相同的状况。除非指针自己被更新为引用内存中的另外一个对象，不然指针内部数据的任何更改都将被保留。