WaitGroup 用于主 goroutine 等待其他 goroutine 完成,Add 必须在 go 语句前调用且与启动 goroutine 数量匹配,否则导致提前返回或 panic;计数器初始为 0,Done 等价于 Add(-1)。
WaitGroup 是 Go 标准库 sync 包里最常用、也最容易用错的并发同步工具之一。它不负责传递数据,只解决「主 goroutine 等待其他 goroutine 执行完毕」这个单一问题——但一旦 Add 和 Done 调用不匹配,就会 panic 或死锁。
WaitGroup 的 Add 必须在 goroutine 启动前调用
这是最常踩的坑:把 Add(1) 放在 go func() 内部,导致主 goroutine 调用 Wait() 时计数器仍是 0,直接返回,后续 goroutine 还没执行完程序就退出了。
正确做法是:
-
Add必须在go语句之前调用,确保计数器已更新 - 如果启动 N 个 goroutine,就要提前
Add(N);不能靠循环里每个 goroutine 自己Add(1) - 计数器初始值为 0,
Add可传负数(但通常只用Done()来减)
示例:
var wg sync.WaitGroup
for i := 0; i < 3; i++ {
wg.Add(1) // ✅ 在 go 前
go func(id int) {
defer wg.Done() // ✅ 或显式调用 wg.Done()
fmt.Printf("task %d done\n", id)
}(i)
}
wg.Wait() // 阻塞直到所有 Done 被调用
Done 和 Add(-1) 的行为完全等价,但别混用
Done() 本质就是 Add(-1),二者可互换。但混用会降低可读性,且容易漏掉 Done ——尤其在有多个 return 分支的函数中。
建议统一用 defer wg.Done(),确保无论从哪个出口退出,计数都能减少。
- 如果函数里有多个 error return,不用每个都写
wg.Done() - 避免在循环体中直接调用
Done()而忘记 defer,容易因 panic 跳过 - 不要在同一个 WaitGroup 上重复调用
Done()超过Add总数,否则 panic: “sync: negative WaitGroup counter”
WaitGroup 不能被复制,必须传指针
sync.WaitGroup 是包含 mutex 和原子计数器的结构体,按值传递会复制一份独立状态,导致主 goroutine 等的不是同一组 goroutine。