Go語(yǔ)言WaitGroup使用時(shí)需要注意的坑

更新時(shí)間：2016年12月06日 09:58:24 投稿：daisy

Go語(yǔ)言中WaitGroup的用途是它能夠一直等到所有的goroutine執(zhí)行完成，并且阻塞主線(xiàn)程的執(zhí)行，直到所有的goroutine執(zhí)行完成。之前一直使用也沒(méi)有問(wèn)題，但最近通過(guò)同事的一段代碼引起了關(guān)于WaitGroup的注意，下面這篇文章就介紹了WaitGroup使用時(shí)需要注意的坑及填坑。

前言

WaitGroup在go語(yǔ)言中，用于線(xiàn)程同步，單從字面意思理解，wait等待的意思，group組、團(tuán)隊(duì)的意思，WaitGroup就是指等待一組，等待一個(gè)系列執(zhí)行完成后才會(huì)繼續(xù)向下執(zhí)行。Golang 中的 WaitGroup 一直是同步 goroutine 的推薦實(shí)踐。自己用了兩年多也沒(méi)遇到過(guò)什么問(wèn)題。

直到最近的一天同事扔過(guò)來(lái)一段奇怪的代碼：

第一個(gè)坑

復(fù)制代碼代碼如下:

package main

import (

    "log"

    "sync"

)

func main() {

    wg := sync.WaitGroup{}

    for i := 0; i &lt; 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")

}

撇了一眼，覺(jué)得沒(méi)什么問(wèn)題。

然而，它的運(yùn)行結(jié)果是這樣：

復(fù)制代碼代碼如下:

2016/11/27 15:12:36 exit

[Finished in 0.7s]

或這樣：

復(fù)制代碼代碼如下:

2016/11/27 15:21:51 i:2

2016/11/27 15:21:51 exit

[Finished in 0.8s]

或這樣：

復(fù)制代碼代碼如下:

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 也沒(méi)睡醒……

這個(gè)問(wèn)題如果理解了 WaitGroup 的設(shè)計(jì)目的就非常容易 fix 啦。因?yàn)?WaitGroup 同步的是 goroutine, 而上面的代碼卻在 goroutine 中進(jìn)行 Add(1) 操作。因此，可能在這些 goroutine 還沒(méi)來(lái)得及 Add(1) 已經(jīng)執(zhí)行 Wait 操作了。

于是代碼改成了這樣：

第二個(gè)坑

復(fù)制代碼代碼如下:

package main

import (

    "log"

    "sync"

)

func main() {

    wg := sync.WaitGroup{}

    for i := 0; i &lt; 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 又睡了過(guò)去，而且是睡死了過(guò)去：

復(fù)制代碼代碼如下:

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 中，導(dǎo)致只有 Add 操作，其實(shí) Done操作是在 wg 的副本執(zhí)行的。因此 Wait 就死鎖了。

于是代碼改成了這樣：

填坑

復(fù)制代碼代碼如下:

package main

import (

    "log"

    "sync"

)

func main() {

    wg := &amp;sync.WaitGroup{}

    for i := 0; i &lt; 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")

}