共计 2345 个字符,预计需要花费 6 分钟才能阅读完成。
导读 | 这篇文章主要为大家介绍了 Go sync WaitGroup 使用深入理解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪 |
WaitGroup 是 go 用来做任务编排的一个并发原语,它要解决的就是并发 – 等待的问题:
当有一个 goroutine A 在检查点(checkpoint)等待一组 goroutine 全部完成,如果这些 goroutine 还没全部完成,goroutine A 就会阻塞在检查点,直到所有 goroutine 都完成后才能继续执行
试想如果没有 WaitGroup,想要在协程 A 等到其他协程执行完成后能立马执行,只能不断轮询其他协程是否执行完毕,这样的问题是:
而用 WaitGroup 时,协程 A 只用阻塞,直到其他协程执行完毕后,再通知协程 A, 其他语言也提供了类似的工具,例如 Java 的 CountDownLatch
Waitgroup 提供了 3 个方法:
func (wg *WaitGroup) Add(delta int)
func (wg *WaitGroup) Done()
func (wg *WaitGroup) Wait()
Add:增加计数值
Done:减少计数值
Wait:调用这个方法的 goroutine 会一直阻塞,直到 WaitGroup 的计数值变为 0
type WaitGroup struct {
// 避免复制
noCopy noCopy
// 64 位环境下,高 32 位是计数值,低 32 位记录 waiter 的数量
state1 uint64
// 用于信号量
state2 uint32
}
func (wg *WaitGroup) Add(delta int) {
// 获取状态值,信号量
statep, semap := wg.state()
// 将参数 delta 左 32 位,加到 statep 中,即给计数值加上 delta
state := atomic.AddUint64(statep, uint64(delta)> 32)
// waiter 的数量
w := uint32(state)
// 加后不能是负值
if v 0 && v == int32(delta) {panic( "sync: WaitGroup misuse: Add called concurrently with Wait")
}
// 如果加完后 v 大于 0,或者加完后 v 等于 0,但没有等待者,直接返回
if v > 0 || w == 0 {return}
// 接下来就是 v 等于 0,且 w 大于 0 的情况
// 再次检查是否有 Add 和 Wait 并发调用的情况
if *statep != state {panic( "sync: WaitGroup misuse: Add called concurrently with Wait")
}
// 将计数值和 waiter 数量清 0
*statep = 0
// 唤醒所有的 waiter
for ; w != 0; w-- {runtime_Semrelease(semap, false, 0)
}
}
如果加完后 v 大于 0,或者加完后 v 等于 0,但没有等待者,直接返回
否则就是 v 等于 0,且 w 大于 0 的情况:
自己是最后一个调用 Done 的,且还有等待者,那就唤醒所有等待者
Done 内部调用 Add,只是参数传 -1,表示减少计数值
func (wg *WaitGroup) Done() {wg.Add(-1)
}
func (wg *WaitGroup) Wait() {statep, semap := wg.state()
for {state := atomic.LoadUint64(statep)
// v:计数值
v := int32(state >> 32)
w := uint32(state)
// 如果计数值为 0,自己不需要等到,直接返回
if v == 0 {return}
// 增加 waiter 计数值
if atomic.CompareAndSwapUint64(statep, state, state+1) {
// 自己在信号量上阻塞
runtime_Semacquire(semap)
// 检查 Waitgroup 是否在 wait 返回前被重用
if *statep != 0 {panic( "sync: WaitGroup is reused before previous Wait has returned")
}
return
}
}
}
如果计数值为 0,当前不需要阻塞,直接返回
否则将 waiter 数量加 1,如果添加成功,就把自己阻塞到信号量上
被唤醒时,如果 statep 不为 0,表示该 waitgroup 是否在 wait 返回前被重用了,panic
通过源码分析可以看出,Waitgroup 有以下使用注意事项:
计数器的值必须大于等于 0:
一开始调用 Add 时,不能传负数
调用 Done 的次数不能过多,导致超过了 WaitGroup 的计数值
因此使用 WaitGroup 的正确姿势是,预先确定好 WaitGroup 的计数值,然后调用相同次数的 Done 完成相应的任务
要保证在期望的 Add 调用完成后,再调用 Wait,否则 Wait 发现计数值为 0 时不会阻塞
最好在一个协程中,按顺序先调 Add,再调 Wait
需要重用时,需要在前一组调用 Wait 结束后,再开始新一轮的使用
WaitGroup 是可以重用的。只要 WaitGroup 的计值恢复到零值的状态,那么它就可以被看作是新创建的 WaitGroup,被重复使用,而不能在前一组没使用完的情况下又使用
![post-qrcode](https://www.xgss.net/wp-content/uploads/2023/07/二维码-微信公众号256x256.jpg)