goroutine 启动前初始化sync.WaitGroup

Question

我有以下代码作为测试的一部分：

    expected := 10
    var wg sync.WaitGroup
    for i := 0; i < expected; i++ {
        go func(wg *sync.WaitGroup) {
            wg.Add(1)
            defer wg.Done()
            // do something
        }(&wg)
    }
    wg.Wait()

令我惊讶的是，我panic: Fail in goroutine after TestReadWrite has completed在运行“go test”时得到了。当使用“go test -race”运行时，我没有感到恐慌，但测试后来失败了。在这两种情况下，尽管有 wg.Wait()，但 goroutine 并未完成执行。

我做了以下更改，现在测试按预期工作：

    expected := 10
    var wg sync.WaitGroup
    wg.Add(expected)
    for i := 0; i < expected; i++ {
        go func(wg *sync.WaitGroup) {
            defer wg.Done()
            // do something
        }(&wg)
    }
    wg.Wait()

我的疑问是：

1. 到目前为止我看到的很多代码都是wg.Add(1)在 goroutine 内部完成的。为什么在这种特定情况下它会表现出意外？这里发生的情况似乎是，一些 goroutine 似乎在其他 goroutine 开始运行之前就完成了运行，并通过了 wg.Wait()。在 goroutine 中使用 wg.Add(1) 是否危险/需要避免？如果这通常不是问题，那么到底是什么导致了这里的问题呢？
2. 添加wg.Add(expected)解决此问题的正确方法吗？

Answer 1

根据文档-

WaitGroup 等待 goroutine 集合完成。主 goroutine 调用 Add 设置等待的 goroutine 数量。然后每个 goroutine 运行并在完成时调用 Done。同时，Wait 可以用来阻塞，直到所有 goroutine 都完成。

因此Add()必须由正在启动其他 Goroutine 的 Goroutine 调用，在您的情况下就是该mainGoroutine。

在第一个代码片段中，您在Add()其他 Goroutine 内部调用，而不是在导致问题的主Goroutine 内部调用 -

expected := 10
var wg sync.WaitGroup
for i := 0; i < expected; i++ {
   go func(wg *sync.WaitGroup) {
       wg.Add(1) // Do not call Add() here
       defer wg.Done()
       // do something
   }(&wg)
}
wg.Wait()

第二个片段正在工作，因为您正在调用Add()goroutine main-

expected := 10
var wg sync.WaitGroup
wg.Add(expected) // Okay
for i := 0; i < expected; i++ {
    go func(wg *sync.WaitGroup) {
       defer wg.Done()
       // do something
     }(&wg)
}
wg.Wait()

添加 wg.Add(expected) 是解决此问题的正确方法吗？

您还可以wg.Add(1)在 for 循环中调用 -

expected := 10
var wg sync.WaitGroup
for i := 0; i < expected; i++ {
    wg.Add(1) // Okay
    go func(wg *sync.WaitGroup) {
       defer wg.Done()
       // do something
     }(&wg)
}
wg.Wait()