Go语言WaitGroup使用时需要注意的坑

前言

waitgroup在go语言中，用于线程同步，单从字面意思理解，wait等待的意思，group组、团队的意思，waitgroup就是指等待一组，等待一个系列执行完成后才会继续向下执行。golang 中的 waitgroup 一直是同步 goroutine 的推荐实践。自己用了两年多也没遇到过什么问题。

直到最近的一天同事扔过来一段奇怪的代码：

第一个坑

package main
 
import (
    "log"
 
    "sync"
)
 
func main() {
    wg := sync.waitgroup{}
 
    for i := 0; i < 5; i++ {
        go func(wg sync.waitgroup, i int) {
            wg.add(1)
            log.printf("i:%d", i)
            wg.done()
        }(wg, i)
    }
 
    wg.wait()
 
    log.println("exit")
}

撇了一眼，觉得没什么问题。

然而，它的运行结果是这样：

2016/11/27 15:12:36 exit
[finished in 0.7s]

或这样：

2016/11/27 15:21:51 i:2
2016/11/27 15:21:51 exit
[finished in 0.8s]

或这样：

2016/11/27 15:22:51 i:3
2016/11/27 15:22:51 i:2
2016/11/27 15:22:51 exit
[finished in 0.8s]

一度让我以为手上的 mac 也没睡醒……

这个问题如果理解了 waitgroup 的设计目的就非常容易 fix 啦。因为 waitgroup 同步的是 goroutine, 而上面的代码却在 goroutine 中进行 add(1) 操作。因此，可能在这些 goroutine 还没来得及 add(1) 已经执行 wait 操作了。

于是代码改成了这样：

第二个坑

package main
 
import (
    "log"
 
    "sync"
)
 
func main() {
    wg := sync.waitgroup{}
 
    for i := 0; i < 5; i++ {
        wg.add(1)
        go func(wg sync.waitgroup, i int) {
            log.printf("i:%d", i)
            wg.done()
        }(wg, i)
    }
 
    wg.wait()
 
    log.println("exit")
}

然而，mac 又睡了过去，而且是睡死了过去：

2016/11/27 15:25:16 i:1
2016/11/27 15:25:16 i:2
2016/11/27 15:25:16 i:4
2016/11/27 15:25:16 i:0
2016/11/27 15:25:16 i:3
fatal error: all goroutines are asleep - deadlock!

wg 给拷贝传递到了 goroutine 中，导致只有 add 操作，其实 done操作是在 wg 的副本执行的。因此 wait 就死锁了。

于是代码改成了这样：

填坑

package main
 
import (
    "log"
 
    "sync"
)
 
func main() {
    wg := &sync.waitgroup{}
 
    for i := 0; i < 5; i++ {
        wg.add(1)
        go func(wg *sync.waitgroup, i int) {
            log.printf("i:%d", i)
            wg.done()
        }(wg, i)
    }
 
    wg.wait()
 
    log.println("exit")
}

 

总结

好了，到这里终于解决了，以上就是关于go语言waitgroup使用时需要注意的一些坑，希望本文中提到的这些问题对大家学习或者使用go语言的时候能有所帮助，如果有疑问大家可以留言交流。