sync.waitgroup是go语言中用于并发控制的重要工具，它能有效协调多个goroutine的执行，确保主goroutine在所有子goroutine完成后再继续。本文将详细阐述waitgroup的核心机制，包括add()、done()和wait()的正确使用方法，并强调wg.add()必须在go语句之前调用的重要性，以避免竞态条件和潜在的panic，结合go内存模型深入分析其原理。
Go语言并发协调：sync.WaitGroup详解
在Go语言中，当我们需要启动多个goroutine并行执行任务，并等待所有这些任务完成后再进行下一步操作时，sync.WaitGroup提供了一种简洁高效的同步机制。它通过一个内部计数器来管理并发任务的状态。
sync.WaitGroup的核心组件
sync.WaitGroup主要由以下三个方法组成：
- Add(delta int): 将WaitGroup的内部计数器增加delta。通常，delta是正数，表示要等待的goroutine数量。
- Done(): 减少WaitGroup的内部计数器。每个goroutine完成其任务后，都应该调用此方法。Done()等价于Add(-1)。
- Wait(): 阻塞当前goroutine，直到WaitGroup的内部计数器归零。
正确使用sync.WaitGroup的示例
以下是一个典型的sync.WaitGroup使用模式，它展示了如何启动多个goroutine并等待它们全部完成：
package main
import (
"fmt"
"sync"
"time"
)
// dosomething 模拟一个耗时操作
func dosomething(millisecs time.Duration, wg *sync.WaitGroup) {
defer wg.Done() // 确保在函数退出时调用wg.Done()
duration := millisecs * time.Millisecond
time.Sleep(duration)
fmt.Println("Function in background, duration:", duration)
}
func main() {
var wg sync.WaitGroup
// 在启动goroutine之前，一次性增加计数器
wg.Add(4)
go dosomething(200, &wg)
go dosomething(400, &wg)
go dosomething(150, &wg)
go dosomething(600, &wg)
// 等待所有goroutine完成
wg.Wait()
fmt.Println("Done")
}示例分析：
立即学习“go语言免费学习笔记（深入）”；
在这个例子中，main函数首先初始化一个sync.WaitGroup实例wg。然后，它通过wg.Add(4)一次性将计数器设置为4，表示将启动4个goroutine。接着，它启动了4个dosomething goroutine，并将wg的地址传递给它们。每个dosomething函数在完成其模拟工作后，会调用defer wg.Done()来减少计数器。最后，main函数调用wg.Wait()，这将阻塞main函数，直到所有4个dosomething goroutine都调用了Done()，使计数器归零。一旦计数器归零，wg.Wait()解除阻塞，main函数继续执行并打印"Done"。
这种模式是正确且推荐的，因为它清晰地表达了需要等待的goroutine数量，并且避免了潜在的竞态条件。
wg.Add()位置的关键性：避免竞态条件
wg.Add()的调用位置至关重要。它必须在对应的go语句之前执行，以确保程序的正确性和稳定性。
1. 避免WaitGroup计数器变为负值引发的Panic
sync.WaitGroup的内部计数器不能为负数。如果一个Done()调用使得计数器低于零，程序将会发生panic。
考虑以下场景：如果wg.Add()在go语句之后执行，或者更糟糕地，在goroutine内部执行，那么就存在一个时间窗口，即在go语句启动goroutine并执行wg.Done()之前，wg.Add()可能尚未被执行。
// 潜在的错误示例（可能导致panic或死锁）
func main() {
var wg sync.WaitGroup
// 假设goroutine执行速度非常快
go func() {
// 如果wg.Add(1)尚未执行，wg.Done()会导致计数器变为负数，引发panic
wg.Done()
}()
wg.Add(1) // 此时Add可能已经太晚了
wg.Wait()
fmt.Println("Done")
}在这种情况下，如果goroutine在wg.Add(1)之前执行了wg.Done()，WaitGroup的计数器将从0变为-1，从而导致程序panic。
2. Go内存模型与执行顺序的保证
Go语言的内存模型提供了一些关于事件顺序的保证，这对于理解WaitGroup的正确使用至关重要。
- 同一goroutine内的语句顺序： 在单个goroutine中，语句的执行顺序与它们在代码中出现的顺序一致。
- go语句的保证： Go内存模型保证，一个goroutine不会在调用它的go语句完成之前开始运行。这意味着，如果wg.Add()在go语句之前，那么wg.Add()的执行是保证在新的goroutine开始执行（包括其内部的wg.Done()）之前的。
因此，当我们在go语句之前调用wg.Add(N)时，我们能确保WaitGroup的计数器在任何Done()调用发生之前已经被正确地增加了。
3. wg.Add(1)的多次调用
虽然一次性调用wg.Add(N)是推荐的做法，但多次调用wg.Add(1)也是正确的，只要它们都在对应的go语句之前：
func main() {
var wg sync.WaitGroup
wg.Add(1)
go dosomething(200, &wg)
wg.Add(1)
go dosomething(400, &wg)
wg.Add(1)
go dosomething(150, &wg)
wg.Add(1)
go dosomething(600, &wg)
wg.Wait()
fmt.Println("Done")
}这种写法在功能上是等价的，因为它同样保证了Add()操作发生在go语句启动goroutine之前。然而，当需要等待的goroutine数量已知时，一次性调用wg.Add(N)更为简洁和高效。
总结与最佳实践
- wg.Add()先行： 始终在启动goroutine（即go语句）之前调用wg.Add()。这是确保WaitGroup正常工作的关键。
- defer wg.Done()： 在goroutine内部，使用defer wg.Done()可以确保无论函数如何退出（正常返回或发生panic），Done()都会被调用，从而避免死锁。
- 一次性Add： 如果需要等待的goroutine数量是已知的，使用wg.Add(N)一次性增加计数器，而不是多次调用wg.Add(1)，以提高代码的清晰度和效率。
- 避免竞态条件： 错误地放置wg.Add()可能导致竞态条件，使wg.Wait()在所有goroutine完成前解除阻塞，或导致WaitGroup计数器变为负数而panic。
遵循这些最佳实践，可以有效地利用sync.WaitGroup来管理Go语言中的并发任务，确保程序的健壮性和正确性。
