WaitGroup用于同步等待多个goroutine完成,通过Add增加计数、Done减少计数、Wait阻塞直至计数为零,适用于并发任务控制。

在Go语言中,WaitGroup 是一种常用的同步机制,用于等待一组并发执行的 Goroutine 完成任务。它属于 sync 包,适用于主线程需要等待多个子任务结束后再继续执行的场景。这种模式常用于批量处理、并发请求、数据采集等。
WaitGroup 的基本结构和方法
sync.WaitGroup 内部维护一个计数器,用来记录正在运行的 Goroutine 数量。主要提供三个方法:
- Add(delta int):增加或减少计数器值。通常传入正整数来设置需要等待的 Goroutine 数量。
- Done():将计数器减1,通常在 Goroutine 结束时调用,等价于
Add(-1)。 - Wait():阻塞当前协程,直到计数器归零,表示所有任务完成。
使用 WaitGroup 的典型模式
以下是一个使用 WaitGroup 等待多个 Goroutine 完成的示例:
package main import ( "fmt" "sync" "time" ) func worker(id int, wg *sync.WaitGroup) { defer wg.Done() // 任务完成,计数器减1 fmt.Printf("Worker %d startingn", id) time.Sleep(time.Second) fmt.Printf("Worker %d donen", id) } func main() { var wg sync.WaitGroup for i := 1; i <= 3; i++ { wg.Add(1) // 增加计数器 go worker(i, &wg) } wg.Wait() // 阻塞,直到所有 worker 调用 Done() fmt.Println("All workers completed") }
输出结果为:
立即学习“go语言免费学习笔记(深入)”;
Worker 1 starting Worker 2 starting Worker 3 starting Worker 1 done Worker 2 done Worker 3 done All workers completed
在这个例子中,主线程通过 wg.Wait() 等待所有 worker 执行完毕,确保最后的提示信息在所有任务结束后才打印。
使用注意事项和常见问题
使用 WaitGroup 时需注意以下几点以避免死锁或 panic:
- 确保 Add 在 Goroutine 启动前调用:如果在
go语句之后调用Add,可能因竞态导致计数器未及时更新,造成漏计。 - 每个 Add 必须有对应的 Done:Add 和 Done 的调用次数必须匹配,否则会导致
Wait永不返回或 panic。 - 传递指针给 Goroutine:应将
*sync.WaitGroup的指针传入函数,避免值拷贝导致无法正确同步。 - 避免重复调用 Wait:同一个 WaitGroup 可以复用,但必须保证计数器归零后才能再次使用,否则行为未定义。
WaitGroup 与 channel 的对比
虽然也可以使用 channel 实现类似功能(如通过关闭 channel 广播完成信号),但 WaitGroup 更简洁直观,特别适合“只关心完成、不传递数据”的场景。而 channel 更适合需要传递状态或结果的复杂同步逻辑。
基本上就这些。WaitGroup 是 Go 中轻量且高效的同步工具,掌握它的正确用法对编写可靠的并发程序至关重要。