Go WaitGroup 等待一组 goroutine 完成

ゞ浴缸里的玫瑰 2024-04-28 08:04 90阅读 0赞

#### 目录 ####

*  阐述
 *   *  WaitGroup 的简单示例
     *  waitGroup 解决什么？

## 阐述 ##

`WaitGroup` 是 Go 语言标准库中的一种并发原语，用于等待一组 goroutine 完成执行。它提供了一种简单的方式来同步多个 goroutine 的执行，并确保在主程序退出之前等待所有 goroutine 完成。

`WaitGroup` 的作用类似于一个计数器，可以在主程序中设置等待的 goroutine 数量，然后在每个 goroutine 的末尾调用 `Done` 方法来标记该 goroutine 的执行已完成。主程序可以调用 `Wait` 方法来阻塞，直到所有的 goroutine 都执行完成。

具体而言，`WaitGroup` 提供了以下三个方法：

1.  `Add(delta int)`：增加等待的 goroutine 数量。`delta` 参数表示要增加的数量，可以是正数或负数。如果 `delta` 是正数，表示要等待的 goroutine 数量增加；如果 `delta` 是负数，表示要等待的 goroutine 数量减少。
2.  `Done()`：标记一个 goroutine 的执行已完成。相当于将等待的 goroutine 数量减少 1。
3.  `Wait()`：阻塞主程序，直到所有的 goroutine 都执行完成。当等待的 goroutine 数量变为零时，`Wait` 方法会返回。

使用 `WaitGroup` 可以确保主程序在所有的 goroutine 完成之前不会退出，并且可以方便地等待并发任务的完成。

### WaitGroup 的简单示例 ###

package main
    
    import (
    	"fmt"
    	"sync"
    )
    
    func worker(id int, wg *sync.WaitGroup) {
        
    	defer wg.Done() // 标记 goroutine 的执行完成
    
    	fmt.Printf("Worker %d starting\n", id)
    	// 执行一些工作...
    	fmt.Printf("Worker %d done\n", id)
    }
    
    func main() {
        
    	var wg sync.WaitGroup
    	numWorkers := 5
    
    	wg.Add(numWorkers) // 设置需要等待的 goroutine 数量
    
    	for i := 0; i < numWorkers; i++ {
        
    		go worker(i, &wg)
    	}
    
    	wg.Wait() // 阻塞，直到所有的 goroutine 完成
    
    	fmt.Println("All workers done")
    }

Worker 3 starting
    Worker 3 done
    Worker 0 starting
    Worker 0 done
    Worker 4 starting
    Worker 2 starting
    Worker 2 done
    Worker 4 done
    Worker 1 starting
    Worker 1 done
    All workers done

### waitGroup 解决什么？ ###

`WaitGroup` 在并发编程中用于解决以下问题：

1.  等待多个 goroutine 完成：当需要启动多个 goroutine 来执行并发任务时，主程序通常需要等待所有 goroutine 完成后再继续执行。`WaitGroup` 提供了一种简单的机制来等待一组 goroutine 的完成，确保它们都执行完毕后再进行下一步操作。
2.  防止主程序过早退出：在一个并发程序中，主程序可能会在所有 goroutine 执行完成前退出，导致未完成的任务被提前终止。通过使用 `WaitGroup`，主程序可以阻塞等待所有的 goroutine 完成，确保在退出之前所有任务都已经执行完毕。
3.  协调并发任务的完成：在某些情况下，多个 goroutine 可能需要协调彼此的执行顺序或依赖关系。`WaitGroup` 可以用作一种简单的同步机制，让 goroutine 等待其他依赖的 goroutine 完成后再执行。通过适当地增加和减少 `WaitGroup` 的计数，可以实现任务间的协调和同步。

总之，`WaitGroup` 提供了一种机制来等待一组 goroutine 完成，并确保主程序在所有 goroutine 完成之前不会退出。这样可以有效地管理并发任务的执行和协调，避免竞态条件和不确定性的出现。