Go 并发编程|sync包--WaitGroup

182 阅读3分钟

本文已参与「新人创作礼」活动,一起开启掘金创作之路

引言

sync是synchronization同步这个词的缩写,所以也会叫做同步包。这里提供了基本同步的操作,比如互斥锁等等。这里除了OnceWaitGroup类型之外,大多数类型都是供低级库例程使用的。更高级别的同步最好通过channel通道和communication通信来完成

1. WaitGroup

WaitGroup,同步等待组。

type WaitGroup

type WaitGroup struct {
    // 包含隐藏或非导出字段
}

在类型上,它是一个结构体。一个WaitGroup的用途是等待一个goroutine的集合执行完成。主goroutine调用了Add()方法来设置要等待的goroutine的数量。然后,每个goroutine都会执行并且执行完成后调用Done()这个方法。与此同时,可以使用Wait()方法来阻塞,直到所有的goroutine都执行完成。

2. Add()方法:

func (wg *WaitGroup) Add(delta int)

Add这个方法,用来设置到WaitGroup的计数器的值。我们可以理解为每个waitgroup中都有一个计数器, 用来表示这个同步等待组中要执行的goroutin的数量。

如果计数器的数值变为0,那么就表示等待时被阻塞的goroutine都被释放,如果计数器的数值为负数,那么就会引发panic,程序就报错。

3. Done()方法

func (wg *WaitGroup) Done()

Done()方法,就是当WaitGroup同步等待组中的某个goroutine执行完毕后,设置这个WaitGroup的counter数值减1。

其实Done()的底层代码就是调用了Add()方法:

// Done decrements the WaitGroup counter by one.
func (wg *WaitGroup) Done() {
    wg.Add(-1)
}

4. Wait()方法

func (wg *WaitGroup) Wait()

Wait()方法,表示让当前的goroutine等待,进入阻塞状态。一直到WaitGroup的计数器为零。才能解除阻塞, 这个goroutine才能继续执行。

示例代码:

我们创建并启动两个goroutine,来打印数字和字母,并在main goroutine中,将这两个子goroutine加入到一个WaitGroup中,同时让main goroutine进入Wait(),让两个子goroutine先执行。当每个子goroutine执行完毕后,调用Done()方法,设置WaitGroup的counter减1。当两条子goroutine都执行完毕后,WaitGroup中的counter的数值为零,解除main goroutine的阻塞。

var wg sync.WaitGroup // 创建同步等待组对象
func main()  {
   /*
      WaitGroup:同步等待组
          可以使用Add(),设置等待组中要 执行的子goroutine的数量,

          在main 函数中,使用wait(),让主程序处于等待状态。直到等待组中子程序执行完毕。解除阻塞

          子gorotuine对应的函数中。wg.Done(),用于让等待组中的子程序的数量减1
   */
   //设置等待组中,要执行的goroutine的数量
   wg.Add(2)
   go fun1()
   go fun2()
   fmt.Println("main进入阻塞状态。。。等待wg中的子goroutine结束。。")
   wg.Wait() //表示main goroutine进入等待,意味着阻塞
   fmt.Println("main,解除阻塞。。")

}
func fun1()  {
   for i:=1;i<=10;i++{
      fmt.Println("fun1.。。i:",i)
   }
   wg.Done() //给wg等待中的执行的goroutine数量减1.同Add(-1)
}
func fun2()  {
   defer wg.Done()
   for j:=1;j<=10;j++{
      fmt.Println("\tfun2..j,",j)
   }
}

运行结果:

image.png