Go语言并发编程中的sync.WaitGroup: Add(1) 使用详解及误区分析

在Go语言的并发编程中，sync.WaitGroup 是一个强大的同步工具，用于等待一组 goroutine 完成。然而，其使用方法中存在一些容易混淆的点，特别是Add()方法的时机选择。本文将通过示例代码深入探讨sync.WaitGroup 的正确使用方法，并解释为什么在某些情况下必须预先设置 Add() 的值。

以下代码展示了一个使用sync.WaitGroup 的函数 wg() 及其辅助函数 wgcore()。在第一个版本中，wg.Add(1) 被放置在 wgcore 函数内部：

func wg() {
    wg := &sync.WaitGroup{}
    go wgcore(1, wg)
    go wgcore(2, wg)
    go wgcore(3, wg)
    wg.Wait()
}

func wgcore(i int64, wg *sync.WaitGroup) {
    wg.Add(1)
    defer wg.Done()
    fmt.Println(i)
}

这段代码的预期输出是 1, 2, 3，然后 wg.Wait() 阻塞直到三个 goroutine 都执行完毕。然而，实际结果可能并非如此。这是因为 wg.Add(1) 在 wgcore 函数内部被调用，而 wg.Wait() 并不知道有多少 goroutine 会被启动。每个 wgcore 函数并发执行，wg.Add(1) 的调用时机不确定，wg.Wait() 可能在所有 wg.Add(1) 调用完成之前就执行了 Wait()，导致程序提前结束。

为了解决这个问题，我们修改代码，将 wg.Add(3) 放置在 wg() 函数的开始部分：

func Wg() {
    wg := &sync.WaitGroup{}
    wg.Add(3)
    go wgCore(1, wg)
    go wgCore(2, wg)
    go wgCore(3, wg)
    wg.Wait()
}

func wgCore(i int64, wg *sync.WaitGroup) {
    defer wg.Done()
    fmt.Println(i)
}

在这个修改后的版本中，wg.Add(3) 明确地告诉 WaitGroup 需要等待三个 goroutine 完成。这样，wg.Wait() 就能正确阻塞，直到三个 goroutine 都执行了 wg.Done()，程序才会继续执行，最终打印出预期的结果。

关键在于，sync.WaitGroup 的计数器必须在启动 goroutine 之前 预先设置好，而不是在 goroutine 内部动态增加。如果不事先设置 Add() 的值，WaitGroup 就无法准确跟踪 goroutine 的数量，导致 Wait() 无法正常工作。 defer wg.Done() 确保每个 goroutine 完成后计数器都会正确递减。