详解Golang中的同步工具sync.WaitGroup

发表时间: 2023-05-16 20:31

sync.WaitGroup

sync.WaitGroup作用是等待一组goroutine执行完成,当使用多个goroutine处理任务的时候,如果要等待所有的goroutine都执行完成后再执行下一步操作,就可以使用sync.WaitGroup来实现。

sync.WaitGroup有三个方法:

  1. Add(delta int):增加或减少等待goroutine的数量,delta可以为负数;
  2. Done():标记goroutine已执行完成,等价于Add(-1);
  3. Wait():等待所有的goroutine执行完成。

使用方法和示例

假如有n个任务需要处理,可以先创建一个WaitGroup,用于等待所有的任务完成:

var wg sync.WaitGroup

在处理每一个任务之前,调用一次Add方法:

wg.Add(1)

在每一个任务处理完成之后,调用一次Done方法:

wg.Done()

最后,在等待所有的任务完成之前,需要调用一次Wait方法:

wg.Wait()

具体示例代码如下:

package mainimport (	"log"	"sync"	"time")func main() {	// 创建一个等待组	var wg sync.WaitGroup	for i := 1; i <= 5; i++ {		// 每一个任务开始前, 增加1		wg.Add(1)		go func(index int) {			// 处理业务逻辑			//...			time.Sleep(1 * time.Second)			log.Printf("第 %d 个goroutine执行完了", index)			wg.Done()		}(i)	}	// 等待所有的任务完成	wg.Wait()	log.Println("所有goroutine都执行完了")}

使用过程中需要注意的点

  1. Done和Add方法的顺序非常重要,Done方法必须在goroutine最后执行,否则可能会导致计数器无法正确的达到0;
  2. 如果使用Add或Done方法将wg维护的计数更改成了负数会导致panic;
  3. Wait方法会一直阻塞,直到所有的goroutine都执行完成为止(wg维护的计数达到0),因此在使用时需要小心;
  4. sync.WaitGroup是开箱即用的,并且是并发安全的。