为什么在 go test 中使用 WaitGroup.Wait() 时会挂起？

Question

这是我的意思的一个简单示例

package main

import (
    "sync"
    "testing"
    "time"
)

func TestWaitGroup(t *testing.T) {
    var wg sync.WaitGroup
    quitSig := make(chan struct{})
    go func(wg sync.WaitGroup, quitChan, chan struct{}) {
        defer func() {
            t.Log("Done...")
            wg.Done()
            t.Log("Done!")
        }()
        t.Log("waiting for quit channel signal...")
        <-quitChan
        t.Log("signal received")
    }(wg, quitSig)
    time.Sleep(5*time.Second)
    t.Log("Done sleeping")
    close(quitSig)
    t.Log("closed quit signal channel")
    wg.Wait()
    t.Log("goroutine shutdown")
}

当我运行它时，我得到以下内容

=== RUN   TestWaitGroup
    main.go:18: waiting for quit channel signal...
    main.go:23: Done sleeping
    main.go:25: closed quit signal channel
    main.go:20: signal received
    main.go:14: Done...
    main.go:16: Done!
    

它只是挂起直到超时。如果您只是defer wg.Done()，则会观察到相同的行为。我正在运行 go1.18。这是一个错误还是我在这种情况下没有正确使用 WaitGroups ？

Answer 1

两个问题：

• 不要复制sync.WaitGroup：来自文档：

  • 首次使用后不得复制 WaitGroup。

• 在启动工作之前，您需要一个 wg.Add(1) - 与 wg.Done 配对()

---

wg.Add(1) // <- add this

go func (wg *sync.WaitGroup ...) { // <- pointer
}(&wg, quitSig) // <- pointer to avoid WaitGroup copy

https://go.dev/play/p/UmeI3TdGvhg

Answer 2

您正在传递候补组的副本，因此Goroutine不会影响外部范围中声明的候补群。修复它：

    go func(wg *sync.WaitGroup, quitChan, chan struct{}) {
     ...
    }(&wg, quitSig)