如何在Golang中使用sync.WaitGroup等待协程完成

来源:AI智能体作者:韦伯头衔:草根站长
导读:本期聚焦于小伙伴创作的《如何在Golang中使用sync.WaitGroup等待协程完成》,敬请观看详情,探索知识的价值。以下视频、文章将为您系统阐述其核心内容与价值。如果您觉得《如何在Golang中使用sync.WaitGroup等待协程完成》有用,将其分享出去将是对创作者最好的鼓励。

在Golang的并发编程中,我们经常会通过goroutine启动多个协程并行处理任务,比如同时请求多个接口、并行处理多份数据等。但协程是异步执行的,主程序不会自动等待所有协程完成,这时候就需要用到sync包下的WaitGroup工具来实现协程等待。

如何在Golang中使用sync.WaitGroup等待协程完成

sync.WaitGroup是什么

sync.WaitGroup是Golang标准库sync包中提供的一个结构体,用于等待一组协程的结束。它的核心逻辑是通过计数器来记录还未完成的协程数量,当计数器归零时,等待的阻塞就会解除。它主要包含三个核心方法:

  • Add(int):向计数器添加指定的数值,通常在启动协程前调用,用来标记要等待的协程数量
  • Done():将计数器减1,通常在协程执行结束时调用,等价于Add(-1)
  • Wait():阻塞当前协程,直到计数器归零,也就是所有需要等待的协程都执行完成

基本使用示例

下面是一个最基础的sync.WaitGroup使用例子,启动3个协程分别处理任务,主程序等待所有协程完成后才输出结束信息:

package main

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

func main() {
	// 声明WaitGroup实例
	var wg sync.WaitGroup
	// 设置要等待的协程数量为3
	wg.Add(3)

	// 启动第一个协程
	go func() {
		// 协程结束时调用Done,计数器减1
		defer wg.Done()
		time.Sleep(1 * time.Second)
		fmt.Println("协程1任务完成")
	}()

	// 启动第二个协程
	go func() {
		defer wg.Done()
		time.Sleep(2 * time.Second)
		fmt.Println("协程2任务完成")
	}()

	// 启动第三个协程
	go func() {
		defer wg.Done()
		time.Sleep(1 * time.Second)
		fmt.Println("协程3任务完成")
	}()

	// 阻塞主程序,等待所有协程完成
	fmt.Println("开始等待协程完成")
	wg.Wait()
	fmt.Println("所有协程已完成,主程序继续执行")
}

运行这段代码会先输出开始等待协程完成,然后等待1到2秒后,三个协程的输出会依次出现,最后输出所有协程已完成,主程序继续执行,说明Wait方法正确阻塞了主程序直到所有协程结束。

常见错误和注意事项

1. Add调用时机错误

一定要在启动协程之前调用Add方法,如果先启动协程再调用Add,可能会出现协程已经执行完Done,但Add还没增加计数器的情况,导致Wait提前返回。比如下面的错误写法:

// 错误示例
go func() {
	defer wg.Done()
	// 协程逻辑
}()
wg.Add(1) // 启动协程后才Add,可能出现问题

2. 计数器数值不匹配

Add传入的数值需要和实际启动的协程数量一致,同时每个协程都要确保调用Done。如果Add的数量多于实际协程数,Wait会永远阻塞;如果少于实际协程数,可能会导致部分协程还没完成主程序就继续执行。

3. WaitGroup传递问题

如果需要在多个函数间传递WaitGroup,一定要传递指针,因为WaitGroup是结构体,值传递会拷贝一份新的实例,导致计数器不共享,等待逻辑失效。正确写法如下:

func task(wg *sync.WaitGroup) {
	defer wg.Done()
	// 任务逻辑
}

func main() {
	var wg sync.WaitGroup
	wg.Add(1)
	// 传递WaitGroup的指针
	go task(&wg)
	wg.Wait()
}

4. 避免复用WaitGroup

WaitGroup在计数器归零后可以复用,但一定要确保所有之前的Wait都已经返回,再重新调用Add。如果复用不当很容易出现计数混乱,建议每次需要等待一组协程时,都重新声明一个新的WaitGroup实例。

实际场景应用示例

比如我们需要同时请求三个不同的接口获取数据,等所有数据都拿到后再做汇总处理,就可以用sync.WaitGroup实现:

package main

import (
	"fmt"
	"sync"
)

// 模拟接口请求
func requestAPI(apiName string, wg *sync.WaitGroup, result *map[string]string) {
	defer wg.Done()
	// 模拟请求耗时
	// 实际场景中这里会是http请求逻辑
	(*result)[apiName] = fmt.Sprintf("来自%s的返回数据", apiName)
}

func main() {
	var wg sync.WaitGroup
	// 存储结果的map
	result := make(map[string]string)
	// 要请求的接口列表
	apis := []string{"用户接口", "订单接口", "商品接口"}

	wg.Add(len(apis))
	for _, api := range apis {
		// 注意这里要传api的拷贝,避免协程闭包捕获循环变量的问题
		apiName := api
		go requestAPI(apiName, &wg, &result)
	}

	wg.Wait()
	// 所有接口请求完成后汇总数据
	fmt.Println("所有接口请求完成,汇总结果:")
	for k, v := range result {
		fmt.Printf("%s: %sn", k, v)
	}
}

这个例子中我们启动三个协程分别请求三个接口,主程序等待所有请求完成后,再遍历结果map输出所有接口的返回数据,实现了并行请求并等待全部完成的需求。

Golangsync.WaitGroup协程并发编程goroutine修改时间:2026-06-09 02:27:24

免责声明:​ 已尽一切努力确保本网站所含信息的准确性。网站内容多为原创整理与精心编撰,观点力求客观中立。本站旨在免费分享,内容仅供个人学习、研究或参考使用。若引用了第三方作品,版权归原作者所有。如内容涉及您的权益,请联系我们处理。
内容垂直聚焦
专注技术核心技术栏目,确保每篇文章深度聚焦于实用技能。从代码技巧到架构设计,为用户提供无干扰的纯技术知识沉淀,精准满足专业提升需求。
知识结构清晰
覆盖从开发到部署的全链路。AI、前端、编程、数据库、服务器、建站、系统层层递进,构建清晰学习路径,帮助用户系统化掌握开发与运维所需的核心技术。
深度技术解析
拒绝泛泛而谈,深入技术细节与实践难点。无论是数据库优化还是服务器配置,均结合真实场景与代码示例进行剖析,致力于提供可直接应用于工作的解决方案。
专业领域覆盖
精准对应开发生命周期。从前端界面到后端编程,从数据库操作到服务器运维,形成完整闭环,一站式满足全栈工程师和运维人员的技术需求。
即学即用高效
内容强调实操性,步骤清晰、代码完整。用户可根据教程直接复现和应用于自身项目,显著缩短从学习到实践的距离,快速解决开发中的具体问题。
持续更新保障
专注既定技术方向进行长期、稳定的内容输出。确保各栏目技术文章持续更新迭代,紧跟主流技术发展趋势,为用户提供经久不衰的学习价值。