Go语言sync.WaitGroup使用详解

引言：理解并发中的同步需求

在Go语言中，协程（goroutine）是轻量级的并发执行单元，使得编写并发程序变得简单高效。然而，当主协程启动多个子协程来执行任务时，一个常见的需求是：主协程需要在所有子协程完成其任务后才能继续执行后续操作。例如，启动多个工作协程处理数据，主协程需要等待所有数据处理完毕后才能汇总结果或退出。sync.WaitGroup正是为解决这类“等待所有并发任务完成”的场景而设计的同步原语。

需要注意的是，sync.WaitGroup的主要目的是等待一组协程的完成，它与sync.Mutex（互斥锁）的功能不同。sync.Mutex用于保护共享资源，确保同一时间只有一个协程可以访问该资源，以避免数据竞态。而sync.WaitGroup关注的是协程的生命周期管理和任务完成的同步。

sync.WaitGroup核心机制

WaitGroup内部维护一个计数器，其操作主要通过以下三个方法实现：

1. Add(delta int):

   • 作用：增加WaitGroup的内部计数器。
   • 时机：通常在启动新的协程之前调用，或者在协程内部动态增加任务时调用。delta参数通常为正数，表示要等待的协程或任务的数量。每次调用Add(1)表示增加一个待完成的任务。
   • 重要性：确保在Wait()被调用之前，所有需要等待的任务都已经被“登记”到WaitGroup中。

2. Done():

   • 作用：减少WaitGroup的内部计数器。
   • 时机：每个协程完成其任务后，都应该调用此方法。
   • 最佳实践：为了确保即使协程发生panic也能正确减少计数，通常会使用defer wg.Done()语句。

3. Wait():

   • 作用：阻塞当前协程，直到WaitGroup的内部计数器归零。
   • 时机：通常在主协程中调用，以等待所有子协程完成。一旦计数器变为零，Wait()方法就会解除阻塞，主协程将继续执行。

使用示例：等待多个任务完成

下面通过一个简单的例子来演示sync.WaitGroup的用法。我们将模拟启动多个并发工作者（goroutine），主程序需要等待所有工作者完成其任务后才能继续执行。

package main

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

// worker 函数模拟一个并发任务
func worker(id int, wg *sync.WaitGroup) {
    // defer wg.Done() 确保在worker函数退出前，无论正常结束还是发生panic，
    // 都会调用wg.Done()来减少WaitGroup的计数器。
    defer wg.Done() 

    fmt.Printf("Worker %d: 任务开始...\n", id)
    time.Sleep(time.Duration(id) * time.Second) // 模拟工作耗时
    fmt.Printf("Worker %d: 任务完成。\n", id)
}

func main() {
    var wg sync.WaitGroup // 声明一个WaitGroup变量

    numWorkers := 3 // 我们要启动的worker数量

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

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

    fmt.Println("主协程: 等待所有工作者完成...")
    wg.Wait() // 阻塞主协程，直到WaitGroup的计数器归零（即所有worker都调用了Done()）

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

代码解释：

• 在main函数中，我们首先声明了一个sync.WaitGroup类型的变量wg。WaitGroup的零值是可用的，无需显式初始化。
• 通过一个循环，我们启动了numWorkers个worker协程。在每次go worker(...)之前，我们调用了wg.Add(1)，这表示我们期望有一个新的协程加入到等待队列中，WaitGroup的计数器会因此增加。
• worker函数接收一个id和一个*sync.WaitGroup指针。在函数体的开头，我们使用defer wg.Done()。这意味着当worker函数执行完毕（无论是正常返回还是因为panic），wg.Done()都会被调用，从而将WaitGroup的计数器减1。
• 在main函数中启动所有worker协程后，我们调用了wg.Wait()。这个调用会阻塞main协程，直到WaitGroup的内部计数器变为零。当所有worker协程都调用了wg.Done()后，计数器变为零，wg.Wait()解除阻塞，main协程继续执行，打印出“所有工作者已完成”的消息。

注意事项与最佳实践

1. Add的调用时机:

   • Add必须在Wait之前被调用，或者在Wait被调用时，WaitGroup的计数器还没有归零。
   • 如果在Wait之后或计数器已归零后再调用Add，可能会导致Wait无法再次阻塞，或引发panic（如果计数器已为0且再次调用Add）。例如，在一个WaitGroup已经完成所有等待并被Wait解除阻塞后，再次对其调用Add可能会导致竞态条件或逻辑错误。

2. Done的匹配:

   • 确保每个Add操作都有一个对应的Done操作。如果Done的调用次数少于Add，Wait将永远阻塞；如果Done的调用次数多于Add，会导致计数器变为负数，从而引发panic。
   • 使用defer wg.Done()是防止遗漏Done调用的最佳实践，尤其是在函数可能提前返回或发生错误时。

3. WaitGroup的传递:

   • sync.WaitGroup是值类型，但通常作为指针（*sync.WaitGroup）传递给协程。这是因为WaitGroup的内部状态是共享的，如果按值传递，每个协程会得到一个独立的WaitGroup副本，它们之间的计数器将无法同步。

4. 零值可用:

   • sync.WaitGroup的零值是可用的，无需显式初始化（例如wg := sync.WaitGroup{}或var wg sync.WaitGroup）。

总结

sync.WaitGroup是Go语言中管理并发协程生命周期的强大工具。它提供了一种简单而有效的方式，使得主程序能够可靠地等待所有子协程完成其任务。通过合理运用Add、Done和Wait这三个核心方法，开发者可以确保并发任务的有序完成，避免竞态条件或程序提前退出等问题，从而构建出更加健壮、高效的Go并发应用程序。掌握WaitGroup是编写高质量Go并发程序的基础。