Go并发编程：sync.WaitGroup详解与使用方法

Go语言以其轻量级的goroutine和channel机制，为并发编程提供了强大的支持。然而，在实际应用中，我们经常会遇到这样的场景：主程序启动了多个并发任务（goroutine），并且需要等待所有这些任务都执行完毕后才能继续执行后续逻辑或安全退出。如果没有有效的同步机制，主程序可能会在子任务完成之前就结束，导致数据不一致、资源未释放或程序崩溃。sync.WaitGroup正是为了解决这类问题而设计的。

sync.WaitGroup的工作原理

sync.WaitGroup内部维护一个计数器。它的核心方法有三个：

1. Add(delta int): 用于增加WaitGroup的计数器。当启动一个新的goroutine时，通常会调用Add(1)来表示有一个新的任务被加入。delta可以是正数也可以是负数，但通常只用正数来增加计数。
2. Done(): 用于减少WaitGroup的计数器。当一个goroutine完成其任务时，会调用Done()（等同于Add(-1)）来表示一个任务已完成。
3. Wait(): 阻塞当前goroutine，直到WaitGroup的计数器归零。这意味着所有通过Add增加的任务都已通过Done标记为完成。

通过这三个方法，WaitGroup实现了一个简单的“等待所有任务完成”的机制。

sync.WaitGroup的基本使用示例

下面通过一个简单的例子来演示sync.WaitGroup如何协调多个并发工作者goroutine：

package main

import (
    "fmt"
    "sync"
    "time"
)

// worker 函数模拟一个耗时任务
func worker(id int, wg *sync.WaitGroup) {
    // 在函数退出时调用 wg.Done()，无论正常返回还是发生panic
    defer wg.Done() 

    fmt.Printf("Worker %d: 正在开始工作...\n", id)
    // 模拟一些工作，耗时与ID相关
    time.Sleep(time.Duration(id) * 200 * time.Millisecond) 
    fmt.Printf("Worker %d: 工作完成。\n", id)
}

func main() {
    var wg sync.WaitGroup // 声明一个 WaitGroup 变量
    numWorkers := 3       // 我们将启动3个工作协程

    fmt.Println("主goroutine: 启动工作协程...")

    for i := 1; i <= numWorkers; i++ {
        // 每启动一个goroutine前，计数器加1
        wg.Add(1) 
        // 启动一个goroutine，并将 WaitGroup 的指针传递给它
        go worker(i, &wg) 
    }

    fmt.Println("主goroutine: 等待所有工作协程完成...")
    // 阻塞主goroutine，直到所有 Add 对应的 Done 都被调用，即计数器归零
    wg.Wait() 

    fmt.Println("主goroutine: 所有工作协程已完成。程序退出。")
}

代码解析：

1. 在main函数中，我们首先声明了一个sync.WaitGroup类型的变量wg。
2. 通过一个for循环，我们计划启动numWorkers个worker goroutine。
3. 在每次循环中，wg.Add(1)被调用，这会增加WaitGroup的内部计数器。这意味着我们预期有一个新的goroutine将要启动并完成任务。注意：Add必须在go语句之前调用，以确保即使goroutine执行速度极快，主goroutine在调用Wait时也能正确计数。
4. go worker(i, &wg)启动了一个新的goroutine。我们将wg的地址（指针）传递给worker函数，因为worker函数需要修改wg的内部状态（调用Done）。
5. 在worker函数内部，defer wg.Done()确保了无论worker函数如何结束（正常返回或panic），wg.Done()都会被调用，从而将WaitGroup的计数器减一。这是最佳实践，可以避免因goroutine异常退出而导致Wait永远阻塞。
6. 在main函数的最后，wg.Wait()被调用。这会阻塞main goroutine，直到wg的计数器归零。一旦所有worker goroutine都调用了Done()，计数器归零，main goroutine就会解除阻塞，继续执行后续代码。

注意事项与最佳实践

• Add的调用时机： 务必在启动goroutine之前调用wg.Add(1)。如果在go语句之后调用，可能出现主goroutine在子goroutine启动并调用Done之前就执行了Wait，导致Wait过早返回或计数不准确。
• Done的调用时机： wg.Done()应在goroutine完成其所有工作后调用。使用defer wg.Done()是一个非常好的习惯，它保证了即使goroutine因运行时错误（panic）而退出，Done也能被执行，避免主goroutine无限期等待。
• 传递WaitGroup： WaitGroup必须通过指针传递给需要使用它的goroutine（如func worker(id int, wg *sync.WaitGroup)）。这是因为WaitGroup的内部状态（计数器）需要被修改，而Go语言函数参数默认是值传递，如果传递副本，子goroutine修改的是副本的计数器，不会影响到主goroutine的WaitGroup。
• 避免负计数： 确保Done()的调用次数不超过Add()的调用次数。如果计数器变为负数，程序会发生panic。
• 重用WaitGroup： 一个WaitGroup实例在Wait()返回后可以被重用，但必须确保前一次的计数器已经完全归零。通常，一个WaitGroup实例用于协调一组特定的并发任务，完成后再用于下一组。

总结

sync.WaitGroup是Go语言中一个简单而强大的并发同步原语。它通过一个计数器机制，优雅地解决了主goroutine等待一组子goroutine完成任务的需求。掌握Add、Done和Wait三个方法的正确使用，以及遵循上述最佳实践，能够帮助开发者构建出更健壮、更可靠的Go并发应用程序。在处理大量并发任务时，WaitGroup是协调它们执行流程、确保数据一致性和程序正确退出的关键工具之一。