一、waitgroup介绍
多线程编程中,经常会遇到这样的一种场景:main函数中为了等待其他线程执行完,在return之前都要执行sleep以争取更多的时间给其他线程执行。例如:
1 2 3 4 5 6 7 8 9 10 11 12 13 |
package main import ( "fmt" "time" ) func main(){ for i := 0; i < 100 ; i++{ go fmt.Println(i) } time.Sleep(time.Second) } |
主线程为了等待goroutine都运行完毕,不得不在程序的末尾使用time.Sleep()
来睡眠一段时间,等待其他线程充分运行。对于简单的代码,100个for循环可以在1秒之内运行完毕,time.Sleep()
也可以达到想要的效果。但是对于实际场景来说,大多无法预知for循环内代码运行时间的长短,因此1秒可能是不够的。所以睡眠也就达不到我们想要的效果。
那么我们可能又会想到使用管道来完成同步,因为管道本身就是用来作为数据通信使用的,用在此处也合理。于是就有了这样的代码:
1 2 3 4 5 6 7 8 9 10 11 12 13 |
unc main() { c := make(chan bool, 100) for i := 0; i < 100; i++ { go func(i int) { fmt.Println(i) c <- true }(i) } for i := 0; i < 100; i++ { <-c } } |
首先可以肯定的是使用管道是能达到我们的目的的,但是问题是管道用在这里真的合适吗?管道是go中用来给多个线程(协程)间通信的,使用它来仅仅作为状态同步,是不是有点大材小用了。而且,管道是基于共享内存实现的,假设我们有一万、十万甚至更多的for循环,也要申请同样数量大小的管道出来,对系统性能也会造成更多的负载。
WaitGroup(等待组)就是用来解决这种问题的,它主要用于同步多个协程间的状态(例如等待所有协程都执行完)。
在WaitGroup
对象实现中,内部有一个计数器,最初从0开始,它有三个方法:
Add()
:计数器加一Done()
:计数器减一Wait()
:等待计数器清零
执行Wait
方法的函数在等待组内部计数器不为0的时候回阻塞,一旦计数器为0了,程序就会继续往下执行。
利用WaitGroup
实现上面的代码:
1 2 3 4 5 6 7 8 9 10 11 |
func main() { wg := sync.WaitGroup{} wg.Add(100) for i := 0; i < 100; i++ { go func(i int) { fmt.Println(i) wg.Done() }(i) } wg.Wait() } |
程序刚开始首先把wg
计数设置为100,然后开启100个协程执行任务,每个协程执行完成之后把计数器减1,主线程中等待计数清零。当wg.Wait()
继续向下执行了,也就说明所有的协程都执行完了。
可以看出,相较于管道来说,WaitGroup
更简单,也更轻量。
二、注意事项
2.1 计数器不能为负值
使用等待组时注意不能通过Add()
给wg
设置一个负值,否则代码将会报错:
1 2 3 4 5 6 7 |
panic: sync: negative WaitGroup counter goroutine 1 [running]: sync.(*WaitGroup).Add(0xc000014060, 0xffffffffffffffff) /usr/local/go/src/sync/waitgroup.go:74 +0x139 main.main() /Users/maqian/code/go/src/awesomeProject/waitgroup/waitgroup.go:10 +0x4d |
同样使用Done()
也要特别注意不要把计数器设置成负数了。
2.2 WaitGroup对象不是一个引用类型
WaitGroup对象不是一个引用类型,在通过函数传值的时候需要使用地址:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
// 一定要通过指针传值,不然进程会进入死锁状态 func f(i int, wg *sync.WaitGroup) { fmt.Println(i) wg.Done() } func main() { wg := sync.WaitGroup{} wg.Add(100) for i := 0; i < 100; i++ { go f(i, &wg) } wg.Wait() } |
评论