Go sync.WaitGroup结构体

sync.WaitGroup结构体对象

在Go语言中，sync.WaitGroup结构体对象用于等待一组线程的结束；WaitGroup是go并发中最常用的工具，我们可以通过WaitGroup来表达这一组协程的任务是否完成，以决定是否继续往下走，或者取任务结果；

WaitGroup的结构体

结构如下所示：

type WaitGroup struct { 
    noCopy noCopy 
    state1 [3]uint32 
}

在sync.WaitGroup结构体对象中有三个方法，Add()、Done()、Wait()

Add()方法

主要为WaitGroup的等待数+1或者+n；

Add()方法的定义如下：

func(*WaitGroup） Add()

• Add()方法内部计数器加上delta，delta可以是负数；
• 如果内部计数器变为0，则Wait()方法会将处于阻塞等待的所有goroutine释放；
• 如果计数器小于0，则调用panic()函数；
• Add()方法加上正数的调用应在Wait()方法之前，否则Wait()方法可能只会等待很少的goroutine；
• Add()方法在创建新的goroutine或者其它等待的事件之前调用；

Done()方法

Done函数调用的也是Add函数，主要用于-1操作；

Done()方法的定义如下：

func(wg *WaitGroup) Done()

• Done()方法会减少WaitGroup计数器的值，一般在goroutine的最后执行；

Wait()方法

阻塞当前协程，直到等待数归为0才继续向下执行；

Wait()方法的定义如下：

func (wg *WaitGroup) Wait()

Wait()方法会阻塞，知道WaitGroup计数器减为0.

Add()、Done()、Wait()三者对比

• 在三个方法中，使用Add()方法添加计数，使用Done()方法减掉一个计数，如果计数不为0，则会阻塞Wait()方法的运行；
• 一个goroutine调用Add()方法来设定等待的goroutine的数量；
• 每个被等待的goroutine在结束时调用Done()方法；
• 在主goroutine里可以调用Wait()方法阻塞至所有goroutine结束；

sync.WaitGroup使用示例

使用sync.WaitGroup等待goroutine结束的示例如下图所示：