首页 > 后端开发 > Golang > 正文

Go并发编程:深入理解sync.WaitGroup

花韻仙語
发布: 2025-08-18 21:40:41
原创
560人浏览过

go并发编程:深入理解sync.waitgroup

sync.WaitGroup是Go语言中用于并发编程的重要同步原语,它允许一个主Go协程等待一组子Go协程完成其执行。通过维护一个内部计数器,WaitGroup能够确保在所有并发任务完成后,主程序才能继续执行,从而实现任务的有效同步和协调。本文将详细介绍WaitGroup的工作原理、使用方法,并通过示例代码演示其在实际并发场景中的应用,同时区分其与互斥锁的用途。

sync.WaitGroup概述

在Go语言中,当我们需要启动多个Go协程并发执行任务,并且主Go协程需要等待所有这些任务完成后才能继续后续操作时,sync.WaitGroup提供了一种简洁高效的解决方案。它内部维护一个计数器:

  • Add(delta int):将计数器增加delta。通常在启动新的Go协程之前调用,以告知WaitGroup有多少个任务需要等待。
  • Done():将计数器减一。通常在Go协程完成其任务时调用。
  • Wait():阻塞调用者,直到计数器归零。这意味着所有通过Add增加的任务都已通过Done完成。

sync.WaitGroup的工作原理与使用示例

为了更好地理解WaitGroup的工作方式,我们来看一个经典的例子:启动多个工作协程执行模拟任务,并等待它们全部完成。

package main

import (
    "fmt"
    "sync"
    "time"
)
// worker 函数模拟一个耗时任务,并在完成后通知 WaitGroup
func worker(id int, wg *sync.WaitGroup) {
    // 确保在 worker 协程退出前调用 wg.Done(),无论是正常完成还是发生 panic
    defer wg.Done() 

    fmt.Printf("Worker %d: 任务开始...\n", id)
    time.Sleep(time.Duration(id) * time.Second) // 模拟耗时操作
    fmt.Printf("Worker %d: 任务完成。\n", id)
}

func main() {
    var wg sync.WaitGroup // 声明一个 WaitGroup 实例
    numWorkers := 3       // 我们将启动3个工作协程

    fmt.Println("主协程: 启动工作协程...")

    // 循环启动工作协程
    for i := 1; i <= numWorkers; i++ {
        wg.Add(1) // 每次启动一个新协程,计数器加1
        go worker(i, &wg) // 启动协程,并传递 WaitGroup 的指针
    }

    fmt.Println("主协程: 等待所有工作协程完成...")
    wg.Wait() // 阻塞主协程,直到 WaitGroup 计数器归零

    fmt.Println("主协程: 所有工作协程已完成。程序退出。")
}
登录后复制

代码解析:

  1. 在main函数中,我们首先声明了一个sync.WaitGroup变量wg。
  2. 在循环中,每次启动一个worker协程之前,我们都调用wg.Add(1),这会将WaitGroup的内部计数器增加1。这表示我们期望有一个新的Go协程将要完成任务。
  3. worker函数接收一个id和一个*sync.WaitGroup指针。在worker函数内部,我们使用defer wg.Done()。defer语句确保了无论worker函数如何结束(正常返回或发生panic),wg.Done()都会被调用,从而将WaitGroup的计数器减1。
  4. 在main函数的最后,wg.Wait()被调用。这个方法会阻塞main协程的执行,直到WaitGroup的内部计数器变为0。只有当所有通过Add增加的Go协程都调用了Done()后,Wait()才会解除阻塞,main协程才能继续执行后续的代码。

运行上述代码,您会看到工作协程并发执行,并且主协程会等待所有工作协程完成后才打印最终的退出信息。

关键概念区分:WaitGroup与Mutex

值得注意的是,sync.WaitGroup的主要目的是等待一组Go协程的完成,它关注的是同步任务的生命周期。它不提供任何机制来保护共享资源的并发访问

豆包AI编程
豆包AI编程

豆包推出的AI编程助手

豆包AI编程 483
查看详情 豆包AI编程

与此相对,sync.Mutex(互斥锁)是用于保护共享资源,确保在任何给定时刻只有一个Go协程可以访问该资源,从而避免数据竞争。

在某些场景下,两者可能会被混淆。例如,如果一个问题是关于如何防止多个Go协程同时修改一个变量,那么应该使用sync.Mutex(或sync.RWMutex、sync.Atomic等),而不是sync.WaitGroup。WaitGroup无法解决数据竞争问题,它仅仅是用来协调Go协程的启动与结束。

使用注意事项

  1. Add的调用时机: 务必在启动新的Go协程之前调用wg.Add(1)。如果在Go协程启动之后再调用Add,可能会导致Wait()在计数器尚未正确增加之前就被调用,从而提前解除阻塞。
  2. Done的调用时机与defer: 推荐在每个工作Go协程的入口处使用defer wg.Done()。这样可以保证无论Go协程是正常完成还是因为运行时错误(panic)而退出,Done()都会被调用,避免主协程永远等待。
  3. 计数器值: WaitGroup的计数器不能为负值。如果Done()的调用次数超过了Add()的次数,程序会发生panic。
  4. 复用WaitGroup: 一个WaitGroup实例可以在完成一次等待循环后被复用,但必须确保在下一次使用前,其计数器已归零。通常情况下,为了代码清晰和避免潜在错误,每次需要等待一组新的Go协程时,声明一个新的WaitGroup实例会更安全。

总结

sync.WaitGroup是Go语言中实现Go协程同步的强大工具,特别适用于“扇出-扇入”(fan-out/fan-in)模式,即启动多个并发任务,然后等待所有任务完成的场景。通过熟练掌握Add、Done和Wait三个方法,开发者可以有效地管理并发Go协程的生命周期,确保程序的正确执行流程。理解其与sync.Mutex等其他同步原语的区别至关重要,以在不同的并发问题中选择最合适的工具。

以上就是Go并发编程:深入理解sync.WaitGroup的详细内容,更多请关注php中文网其它相关文章!

编程速学教程(入门课程)
编程速学教程(入门课程)

编程怎么学习?编程怎么入门?编程在哪学?编程怎么学才快?不用担心,这里为大家提供了编程速学教程(入门课程),有需要的小伙伴保存下载就能学习啦!

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号