阅读 305

Go中slice作为参数传递的一些“坑”

看到这个题目,可能大家都觉得是一个老生常谈的月经topic了。一直以来其实把握一个“值传递”基本上就能理解各种情况了,不过最近遇到了更深一点的“小坑”,与大家分享一下。

首先还是从最简单的说起,看下面代码:

func main() {
        a := []int{7,8,9}
        fmt.Printf("len: %d cap:%d data:%+v\n", len(a), cap(a), a)
        ap(a)
        fmt.Printf("len: %d cap:%d data:%+v\n", len(a), cap(a), a)
}

func ap(a []int) {
        a = append(a, 10)
}
复制代码

可以点击这里运行代码,以上代码的输出是什么呢?

我这里不卖关子了直接说,再调用ap函数进行append操作后,a依然是[]int{7,8,9}。原因很简单,Go中没有引用传递全是值传递,值传递意味着传递的是数据的拷贝。这句话新手可能稍微有点云里雾里,而实际情况又比较诡异,比如说下面代码:

func main() {
        a := []int{7,8,9}
        fmt.Printf("len: %d cap:%d data:%+v\n", len(a), cap(a), a)
        ap(a)
        fmt.Printf("len: %d cap:%d data:%+v\n", len(a), cap(a), a)
}

func ap(a []int) {
        a[0] = 1
        a = append(a, 10)
}
复制代码

点击这里运行代码,这时ap后再输出a,会看到a[0]变成了1,但a的cap依然是3,看起来10并没有被append进去?

这看起来就比较匪夷所思了,不是说值传递吗,为什么还是影响外部变量的值了呢?按理说要么都变要么都不变才说得过去啊。

这实际上并不是匪夷所思,因为Go和C不一样,slice看起来像数组,实际上是一个结构体,在源码中的数据结构是:

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

这个结构体其实也很好理解,array是一个真正的数组指针,指向一段连续内存空间的头部,len和cap代表长度和容量。

换句话说,你看起来在代码里传参时写的是ap(a []int),实际上在代码编译期,这段代码变成了ap(a runtime.slice)

你可以尝试这么理解,把ap(a)替换成ap(array: 0x123, len: 3, cap: 3)。可以很明显的看到,传递到ap函数的三个参数,仅仅是3个数值,并没有和外部变量a建立任何引用关系。这便是值传递。

但是,你可能会疑惑,为什么我改了a[0]的值,也会在外面体现呢?其实看到这里你应该已经可以自己想明白了,因为array是一个地址值(比如0x123),这个地址传入了ap函数,但是它代表的地址0x123和外部a的0x123是一个内存地址,这时候你修改a[0],实际上是修改0x123地址中存放的值,所以外部当然会受影响了。

举个形象点的例子,假设你是火车站货物管理员,你管理的是第1到第3节车厢(车厢是互通的)的装卸货货。有一天你生病了,找个人(叫A)临时来接手一下。但是火车的货不是谁想碰就碰的,你得有证明才行。于是你把你手上的证明原件复印了一份给A,同时把第一节车厢的钥匙给A。由于刚好那几天比较忙,站长又让A也负责第四节车厢,于是A也得到了车厢4的证明原件。一段时间后,你生病回来,你依然只有1到3节车厢的证件,你可以看到最近A在1到3车厢搞的事情,但是你没有资格去4车厢。

以上例子应该可以很好的说明slice传参的场景,记住,Go中只有值传递。

是不是就完事儿了呢?然而事情并没有这么简单。最近我工作时就遇到这个问题了。按照上面的举例,虽然你没有资格去查看4车厢,但是如果你好奇,你可以偷看啊,因为它们是连续的互通的,正如数组也是一段连续的内存,于是就有这样的代码:

func main() {
        a := []int{}
        a = append(a, 7,8,9)
        fmt.Printf("len: %d cap:%d data:%+v\n", len(a), cap(a), a)
        ap(a)
        fmt.Printf("len: %d cap:%d data:%+v\n", len(a), cap(a), a)
        p := unsafe.Pointer(&a[2])
        q := uintptr(p)+8
        t := (*int)(unsafe.Pointer(q))
        fmt.Println(*t)
}

func ap(a []int) {
        a = append(a, 10)
}
复制代码

点击这里运行代码

虽然外部的cap和len并没有改变,但是ap函数往同一段内存地址append了一个10,那我是不是可以用比较trick的方法去偷看呢?比如找到a[2]的地址,往后挪一个int的长度,就应该是ap函数新增的10了吧?这里需要注意,Go官网的server是32位的,所以在go playground执行这段代码时,int是4字节。

执行结果和我预想的一样!

但是问题接踵而至

func main() {
        a := []int{7,8,9}
        fmt.Printf("len: %d cap:%d data:%+v\n", len(a), cap(a), a)
        ap(a)
        fmt.Printf("len: %d cap:%d data:%+v\n", len(a), cap(a), a)
        p := unsafe.Pointer(&a[2])
        q := uintptr(p)+8
        t := (*int)(unsafe.Pointer(q))
        fmt.Println(*t)
}

func ap(a []int) {
        a = append(a, 10)
}
复制代码

这段代码你再试试

这和上面一个例子唯一的区别就是slice一开始是用[]int{7,8,9}这种方式初始化。执行结果*t是3而不是10,这就比较困惑了。为啥?不是一段连续的内存空间吗?

这里其实涉及到的问题是slice的growth问题,当append时发现cap不够了,会重新分配空间,具体源码参见 runtime/slice.go中的growslice函数。我这里就不讲太多细节,只讲结果。当发生growslice时,会给slice重新分配一段更大的内存,然后把原来的数据copy过去,把slice的array指针指向新内存。也就是说,假如之前的数据是存放到内存地址 0x0 0x8 0x10,当不发生growslice,新append的数值会存到0x18,然而当发生growslice,以前的所有数据被copy到新的地址0x1000 0x1008 0x1010,新append的值放到0x1018了。

这时候你就可以理解为什么有时候用unsafe能拿到数据,有时候拿不到了。或许你可以理解为什么这个包叫做unsafe了。不过unsafe不是真的unsafe,是说如果你使用的姿势不对就非常容易unsafe。但是如果姿势优雅,其实很safe。对于slice操作,如果要使用unsafe,千万记得关注cap是否发送变化,它意味着内存的迁移

关注下面的标签,发现更多相似文章
评论