你是否因使用姿势不当，而在 WaitGroup 栽了跟头？

机器铃砍菜刀 2023-03-28 原文

在 Go 中，sync 包下的 WaitGroup 能有助于我们控制协程之间的同步。当需要等待一组协程都执行完各自任务后，才能继续后续逻辑。这种场景，就非常适合使用它。但是，在使用 WaitGroup 的过程中，你可能会犯错误，下文我们将通过示例逐步探讨。

任务示例

初始任务

假设我们有以下任务 woker，它执行的任务是将参数 msg 打印出来。

func worker(msg string) {
 fmt.Printf("worker do %s\n", msg)
}

func main() {
 worker("task 1")
 fmt.Println("main exit")
}

执行结果如下

worker do task 1
main exit

并发执行

依次执行可以完成所有任务，但由于任务间没有依赖性，并发执行是更好的选择。

func worker(msg string) {
 fmt.Printf("worker do %s\n", msg)
}

func main() {
 go worker("task 1")
 go worker("task 2")
 go worker("task 3")
 fmt.Println("main exit")
}

但这样，我们大概率得到这样的结果

main exit

使用 WaitGroup

WaitGroup 提供三个 API。

Add(delta int) 函数提供了 WaitGroup 的任务计数，delta 的值可以为正也可以为负，通常在添加任务时使用。
Done() 函数其实就是 Add(-1)，在任务完成时调用。
Wait() 函数用于阻塞等待 WaitGroup 的任务们均完成，即阻塞等待至任务数为 0。

我们将代码改写如下

var wg sync.WaitGroup

func worker(msg string) {
 wg.Add(1)
 defer wg.Done()
 fmt.Printf("worker do %s\n", msg)
}

func main() {
 go worker("task 1")
 go worker("task 2")
 go worker("task 3")
  fmt.Println("waiting")
 wg.Wait()
 fmt.Println("main exit")
}

执行结果可能

waiting
worker do task 1
worker do task 3
worker do task 2
main exit

同样也可能

waiting
worker do task 2
worker do task 1
main exit

还有可能

waiting
main exit

虽然main exit总会在最后打印输出，但并发任务未均如愿得到执行。

全局变量改为传参

也许是我们不应该将 wg 设为全局变量？那改为函数传参试试。

func worker(msg string, wg sync.WaitGroup) {
 wg.Add(1)
 defer wg.Done()
 fmt.Printf("worker do %s\n", msg)
}

func main() {
 var wg sync.WaitGroup
 go worker("task 1", wg)
 go worker("task 2", wg)
 go worker("task 3", wg)
 fmt.Println("waiting")
 wg.Wait()
 fmt.Println("main exit")
}

但执行结果显然更不对了

waiting
main exit

值传递改为指针传递

如果去查看 WaitGroup 的这三个 API 函数，你会发现它们的方法接收者都是指针。

我们使用值传递 WaitGroup，那就意味着在函数中使用的 wg 是一个复制对象。而 WaitGroup 的定义描述中有提及：使用过程中它不能被复制（详细原因可以查看菜刀历史文章no copy 机制）。

因此，我们需要将 WaitGroup 的参数类型改为指针。

func worker(msg string, wg *sync.WaitGroup) {
 wg.Add(1)
 defer wg.Done()
 fmt.Printf("worker do %s\n", msg)
}

func main() {
 var wg sync.WaitGroup
 go worker("task 1", &wg)
 go worker("task 2", &wg)
 go worker("task 3", &wg)
 fmt.Println("waiting")
 wg.Wait()
 fmt.Println("main exit")
}

那这样是不是就可以了呢？

waiting
worker do task 3
worker do task 2
worker do task 1
main exit

看着好像符合预期了，但是如果多次执行，你发现可能会得到这样的结果。

worker do task 2
waiting
worker do task 1
worker do task 3
main exit

或者这样

waiting
main exit

竟然还有问题？！

执行顺序

其实问题出在了执行顺序。

注意，wg.Add(1)我们是在 worker 函数中执行，而不是在调用方（main函数）。通过 Go 关键字让一个 gotoutine 执行起来存在一小段的滞后时间。而这就会存在问题：当程序执行到了wg.Wait()时，前面的 3 个goroutine 并不一定都启动起来了，即它们不一定来得及调用wg.Add(1)。（这个 goroutine 滞后的问题其实也是上文并发执行未能得到预期结果的原因所在。）

例如最后一个结果，每个 worker 都还来不及执行wg.Add(1)，main 函数就已经执行到wg.Wait()，此时它发现任务计数是0，所以就直接非阻塞执行后续 main 函数逻辑了。

对于这个问题，我们的解决方案是：

在 main 函数调用worker前就应该执行wg.Add(1)来给任务准确计数；
避免潜在复制风险，不再传递 WaitGroup 参数；
将wg.Done()从worker中移出，与wg.Add()调用形成对应。

func worker(msg string) {
 fmt.Printf("worker do %s\n", msg)
}

func main() {
 var wg sync.WaitGroup

 wg.Add(1)
 go func() {
  defer wg.Done()
  worker("task 1")
 }()

 wg.Add(1)
 go func() {
  defer wg.Done()
  worker("task 2")
 }()

 wg.Add(1)
 go func() {
  defer wg.Done()
  worker("task 3")
 }()

 fmt.Println("waiting")
 wg.Wait()
 fmt.Println("main exit")
}

这样，无论执行多少次，结果都能符合预期要求。

waiting
worker do task 3
worker do task 2
worker do task 1
main exit

事实上，上述写法不够简洁。当大量相同子任务通过 goroutine 执行时，我们应该采用 for 语句来编写代码。

func worker(msg string) {
 fmt.Printf("worker do %s\n", msg)
}

func main() {
 var wg sync.WaitGroup

 for i := 0; i < 3; i++ {
  wg.Add(1)
  go func(i int) {
   defer wg.Done()
   worker(fmt.Sprintf("task %d", i+1))
  }(i)
 }
 fmt.Println("waiting")
 wg.Wait()
 fmt.Println("main exit")
}

总结

我们可以将 WaitGroup 的核心使用姿势总结为如下模版

wg.Add(1)
 go func() {
  defer wg.Done()
  YourFunction()
 }()

在进入 goroutine 之前执行wg.Add(1)，goroutine 中的第一行代码为defer wg.Done()。

这样，我们能让调用方（例子中的main函数）有效地控制任务数，同时既避免了传递 WaitGroup 的风险，又能让子任务YourFunction()只关心自身逻辑。

从本文的例子可以看出，在并发编程时，一定要采用正确的使用姿势，否则很容易产生让人困惑的问题。

跟头不当 span style color 开发前端 $WaitGroup 任务数逻辑

有关你是否因使用姿势不当，而在 WaitGroup 栽了跟头？的更多相关文章

ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2
我正在学习如何使用Nokogiri，根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div
ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2
我有一个Ruby程序，它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重，我想提高压缩级别，因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗？是否有另一个允许指定压缩级别的Ruby库？最佳答案这是我通过查看rubyzip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d
ruby - 为什么我可以在 Ruby 中使用 Object#send 访问私有(private)/ protected 方法？ - 2
类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc
ruby-on-rails - 使用 Ruby on Rails 进行自动化测试 - 最佳实践 - 2
很好奇，就使用rubyonrails自动化单元测试而言，你们正在做什么？您是否创建了一个脚本来在cron中运行rake作业并将结果邮寄给您？git中的预提交Hook？只是手动调用？我完全理解测试，但想知道在错误发生之前捕获错误的最佳实践是什么。让我们理所当然地认为测试本身是完美无缺的，并且可以正常工作。下一步是什么以确保他们在正确的时间将可能有害的结果传达给您？最佳答案不确定您到底想听什么，但是有几个级别的自动代码库控制:在处理某项功能时，您可以使用类似autotest的内容获得关于哪些有效，哪些无效的即时反馈。要确保您的提
ruby - 在 Ruby 中使用匿名模块 - 2
假设我做了一个模块如下:m=Module.newdoclassCendend三个问题:除了对m的引用之外，还有什么方法可以访问C和m中的其他内容？我可以在创建匿名模块后为其命名吗(就像我输入“module...”一样)？如何在使用完匿名模块后将其删除，使其定义的常量不再存在？最佳答案三个答案:是的，使用ObjectSpace.此代码使c引用你的类(class)C不引用m:c=nilObjectSpace.each_object{|obj|c=objif(Class===objandobj.name=~/::C$/)}当然这取决于
ruby - 使用 ruby 和 savon 的 SOAP 服务 - 2
我正在尝试使用ruby和Savon来使用网络服务。测试服务为http://www.webservicex.net/WS/WSDetails.aspx?WSID=9&CATID=2require'rubygems'require'savon'client=Savon::Client.new"http://www.webservicex.net/stockquote.asmx?WSDL"client.get_quotedo|soap|soap.body={:symbol=>"AAPL"}end返回SOAP异常。检查soap信封，在我看来soap请求没有正确的命名空间。任何人都可以建议我
python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声？ - 2
关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题？更新问题，以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点？我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等)，但我确实想创建一个输出文件。
ruby-on-rails - 'compass watch' 是如何工作的/它是如何与 rails 一起使用的 - 2
我在我的项目目录中完成了compasscreate.和compassinitrails。几个问题:我已将我的.sass文件放在public/stylesheets中。这是放置它们的正确位置吗？当我运行compasswatch时，它不会自动编译这些.sass文件。我必须手动指定文件:compasswatchpublic/stylesheets/myfile.sass等。如何让它自动运行？文件ie.css、print.css和screen.css已放在stylesheets/compiled。如何在编译后不让它们重新出现的情况下删除它们？我自己编译的.sass文件编译成compiled/t
ruby - 使用 ruby 将 HTML 转换为纯文本并维护结构/格式 - 2
我想将html转换为纯文本。不过，我不想只删除标签，我想智能地保留尽可能多的格式。为插入换行符标签，检测段落并格式化它们等。输入非常简单，通常是格式良好的html(不是整个文档，只是一堆内容，通常没有anchor或图像)。我可以将几个正则表达式放在一起，让我达到80%，但我认为可能有一些现有的解决方案更智能。最佳答案首先，不要尝试为此使用正则表达式。很有可能你会想出一个脆弱/脆弱的解决方案，它会随着HTML的变化而崩溃，或者很难管理和维护。您可以使用Nokogiri快速解析HTML并提取文本:require'nokogiri'h
ruby - 在 64 位 Snow Leopard 上使用 rvm、postgres 9.0、ruby 1.9.2-p136 安装 pg gem 时出现问题 - 2
我想为Heroku构建一个Rails3应用程序。他们使用Postgres作为他们的数据库，所以我通过MacPorts安装了postgres9.0。现在我需要一个postgresgem并且共识是出于性能原因你想要pggem。但是我对我得到的错误感到非常困惑当我尝试在rvm下通过geminstall安装pg时。我已经非常明确地指定了所有postgres目录的位置可以找到但仍然无法完成安装:$envARCHFLAGS='-archx86_64'geminstallpg--\--with-pg-config=/opt/local/var/db/postgresql90/defaultdb/po