本文深入探讨go语言中`sync.waitgroup`的正确使用方法，特别是`wg.add()`调用时机的关键性。我们将通过示例代码分析，解释为何`wg.add()`必须在`go`语句之前执行，以及go内存模型如何确保这一顺序，从而有效避免竞态条件和潜在的程序崩溃，保障并发程序的稳定运行。
在Go语言的并发编程中，`sync.WaitGroup`是一个至关重要的同步原语，用于等待一组goroutine完成其任务。它通过一个内部计数器来工作：`Add(delta int)`方法增加计数器，`Done()`方法（等价于`Add(-1)`）减少计数器，而`Wait()`方法则会阻塞，直到计数器归零。
`sync.WaitGroup`的基本用法
以下是一个典型的`sync.WaitGroup`使用示例，它启动了多个goroutine并行执行任务，并在所有任务完成后才继续主goroutine的执行：
package main
<p>import (
"fmt"
"sync"
"time"
)</p><p>func dosomething(millisecs time.Duration, wg <em>sync.WaitGroup) {
duration := millisecs </em> time.Millisecond
time.Sleep(duration)
fmt.Println("Function in background, duration:", duration)
wg.Done() // 任务完成后，减少计数器
}</p><p>func main() {
var wg sync.WaitGroup
wg.Add(4) // 预先告知WaitGroup将有4个goroutine需要等待
go dosomething(200, &wg)
go dosomething(400, &wg)
go dosomething(150, &wg)
go dosomething(600, &wg)</p><pre class="brush:php;toolbar:false;">wg.Wait() // 阻塞直到所有goroutine都调用了wg.Done()
fmt.Println("Done")}
在这个例子中，`main`函数启动了四个`dosomething` goroutine。`wg.Add(4)`在所有`go`语句之前被调用，确保了`WaitGroup`的计数器在任何goroutine开始执行并可能调用`wg.Done()`之前就已经被正确设置。`wg.Wait()`则会等待这四个goroutine全部完成，即计数器归零，才会打印"Done"并退出。
`wg.Add()`调用时机的关键性
上述示例中，`wg.Add(4)`在所有`go`语句之前执行是至关重要的。虽然将`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)
<pre class="brush:php;toolbar:false;">wg.Wait()
fmt.Println("Done")}
但当已知goroutine数量时，一次性调用`wg.Add(N)`更为简洁高效。更重要的是，`wg.Add()`的调用必须在对应的`go`语句之前完成，以避免竞态条件和程序崩溃。
`WaitGroup`的内部计数器不能为负值。如果一个`wg.Done()`被调用时，计数器已经为零，程序将会发生`panic`。为了防止这种情况，我们必须确保每次`wg.Done()`被调用时，计数器都已经通过`wg.Add()`递增过。
Go内存模型与并发安全保障
Go语言的内存模型为我们提供了关于并发操作顺序的保证。理解这一点对于正确使用`sync.WaitGroup`至关重要：
- 单个goroutine内的顺序： 在单个goroutine内部，所有语句的执行顺序看起来与它们在代码中出现的顺序一致。
- `go`语句的发生顺序： Go内存模型明确指出，一个goroutine的执行不会在其对应的`go`语句完成之前开始。这意味着，在主goroutine中，`wg.Add()`语句的执行，保证在`go`语句启动的子goroutine开始执行其内部的`wg.Done()`之前。
因此，当我们在`go`语句之前调用`wg.Add()`时，Go的内存模型确保了以下顺序：
- 主goroutine执行`wg.Add(N)`，增加计数器。
- 主goroutine执行`go`语句，启动一个新的goroutine。
- 新的goroutine开始执行，并在完成任务后调用`wg.Done()`，减少计数器。
这种顺序保证了当子goroutine尝试调用`wg.Done()`时，`WaitGroup`的计数器已经被正确地初始化或递增，从而避免了计数器降至负数引发的`panic`。如果`wg.Add()`在`go`语句之后执行，就可能出现竞态条件：主goroutine可能在`wg.Add()`执行之前就启动了子goroutine，并且子goroutine可能在主goroutine执行`wg.Add()`之前就完成了任务并调用了`wg.Done()`，导致`panic`。
注意事项
- `Add()`必须在`go`语句之前： 始终确保`wg.Add()`在启动任何可能调用`wg.Done()`的goroutine之前被调用。这是避免竞态条件和`panic`的核心规则。
-
`Done()`与`Add()`匹配： 每个`wg.Add(1)`或`wg.Add(N)`的增量都必须有对应的`wg.Done()`来抵消。通常，`wg.Done()`会放在`defer`语句中，以确保即使函数发生错误也能被调用，例如：
func worker(id int, wg *sync.WaitGroup) { defer wg.Done() // 确保在函数退出时调用Done // ... 执行任务 ... } - 避免在被等待的goroutine中调用`Wait()`： 不要在被`WaitGroup`等待的goroutine内部调用同一个`WaitGroup`的`Wait()`方法，这会导致死锁。`Wait()`通常由主goroutine或协调goroutine调用。
总结
`sync.WaitGroup`是Go语言中实现并发协作的重要工具。正确理解和运用其`Add()`、`Done()`和`Wait()`方法，特别是`wg.Add()`的调用时机，是编写健壮、高效并发程序的关键。通过遵循Go内存模型的保证，确保`wg.Add()`在`go`语句之前执行，我们可以有效地避免竞态条件和运行时错误，从而构建出更加稳定可靠的并发应用。
