Golang WaitGroup
关于go语言中的WaitGroup
如果你刚接触Go语言并且想用它构建高并发,高性能的应用,弄明白WaitGroups是怎么回事很重要。
在本教程中,我们将掌握以下内容:
- WaitGroups的用途
- 一个WaitGroups的简单示例
学习完本教程,你将会对WaitGroups有个全面的了解并且可以在你的高并发go应用中使用它。
标准库文档描述如下:
type WaitGroup
type WaitGroup struct { // 包含隐藏或非导出字段 }
WaitGroup用于等待一组线程的结束。父线程调用Add方法来设定应等待的线程的数量。每个被等待的线程在结束时应调用Done方法。同时,主线程里可以调用Wait方法阻塞至所有线程结束。
Example
func (*WaitGroup) Add
func (wg *WaitGroup) Add(delta int)
Add方法向内部计数加上delta,delta可以是负数;如果内部计数器变为0,Wait方法阻塞等待的所有线程都会释放,如果计数器小于0,方法panic。注意Add加上正数的调用应在Wait之前,否则Wait可能只会等待很少的线程。一般来说本方法应在创建新的线程或者其他应等待的事件之前调用。
func (*WaitGroup) Done
func (wg *WaitGroup) Done()
Done方法减少WaitGroup计数器的值,应在线程的最后执行。
func (*WaitGroup) Wait
func (wg *WaitGroup) Wait()
Wait方法阻塞直到WaitGroup计数器减为0。
理解WaitGroups
接下来我们就来看一下WaitGroups是什么以及它能为我们解决什么问题
当你在程序中使用go语言的协程的时候,在协程执行完成之前,你需要阻塞程序的执行。
请看以下代码示例 :
1 package main
2
3 import (
4 "fmt"
5 )
6
7 func main() {
8 fmt.Println("Hello World")
9 go myFunc()
10 fmt.Println("Finished Execution")
11 }
12
13 func myFunc() {
14 fmt.Println("Inside my goroutine")
15 }
程序输出如下:
Hello World
Finished Execution
我们发现,程序并没有输出"Inside my goroutine",原因是主程序在协程执行之前就已经退出了。
如何解决?使用WaitGroups
WaitGroups可以通过阻塞主函数来帮我们解决上面的问题。
请看以下代码:
1 package main
2
3 import (
4 "sync"
5 "fmt"
6 )
7
8 func main() {
9 fmt.Println("Hello World")
10 var waitgroup sync.WaitGroup
11 waitgroup.Add(1)
12 go myFunc(&waitgroup)
13 waitgroup.Wait()
14
15 fmt.Println("Finished Execution")
16 }
17
18 func myFunc(waitgroup *sync.WaitGroup) {
19 fmt.Println("Inside my goroutine")
20 waitgroup.Done()
21 }
上面代码输出结果为:
Hello World
Inside my goroutine
Finished Execution
达到了我们想要的结果。
接下来对上面的代码做一些解释:
我们在开启协程之前,先调用了WaitGroup的Add(1)方法,是要设置主函数需要等待完成的协程数为1,Wait()方法是等待协程的完成。我们在协程中调用的WaitGroup的Done()方法,意思是当前协程执行完成(Done()做的工作其实就是把需要等待的协程个数减1),当需要等待的协程数为0时,则不需要再等待,继续执行以下的代码。
改造成匿名函数
我们可以把上面的例子改造成匿名函数的,代码如下:
package main
import (
"sync"
"fmt"
)
func main() {
fmt.Println("Hello World")
var waitgroup sync.WaitGroup
waitgroup.Add(1)
go func(){
fmt.Println("Inside my goroutine")
waitgroup.Done()
}()
waitgroup.Wait()
fmt.Println("Finished Execution")
}
上面代码输出结果依然为:
Hello World
Inside my goroutine
Finished Execution