解决Golang 中使用WaitGroup的那点坑

更新时间：2021年04月27日 10:16:38 作者：he_silong

这篇文章主要介绍了解决Golang 中使用WaitGroup的那点坑，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧

sync.WaitGroup对于Golang开发者来说并不陌生，其经常作为多协程之间同步的一种机制。用好它势必会让你事半功倍，但是一旦错用将引发问题。

关于WaitGroup的使用网上有很多例子，在此就不做介绍了，我想说的是我在项目中使用WaitGroup遇到的坑。

在项目中，因为服务器有同步需求，所以直接使用了WaitGroup，但是未考虑使用场景，结果在项目上线之后，高峰期的时候客户端经常出现卡顿，经过多方查找，才发现如果使用WaitGroup的时候，未启动单独的goroutine，那么极有可能造成主线程的阻塞

所以我做了下面的测试(测试中，我把WaitGroup置于协程内)：

import (
 "fmt"
 "sync"
 "time"
)
 
func main() {
    fmt.Println("main-1")
 testW()
 fmt.Println("main-2")
 time.Sleep(time.Duration(15) * time.Second) 
}
 
func testW() {
 fmt.Println("testW-1")
 go func() {
  var wg sync.WaitGroup
  fmt.Println("testW-2")
  testW1(&wg)
  fmt.Println("testW-5")
  wg.Wait()
  fmt.Println("testW-6")
 }()
}
 
func testW1(wg *sync.WaitGroup) {
 wg.Add(1)
 fmt.Println("testW-3")
 time.AfterFunc(time.Second*5, func() {
  wg.Done()
 })
 fmt.Println("testW-4")
 
}

输出为：

main-1

testchan-1

main-2

testchan-2

testchan-3

testchan-4

testchan-5

// 过5秒

testchan-6

总结：

将WaitGroup用于goroutine内，不会导致主线程的阻塞，同样可以实现同步的效果。

补充：WaitGroup的简单用法(等待组)

你品一下人家这名字，等待组。等待什么，等待goroutine完成啊。有些时候，我们启动多个goroutine去执行任务，我举个例子

listip := []string{"10.0.9.11","10.0.9.22","10.0.9.33"}
for _, ip := range(listip) {
    //假设我们执行一个ping ip 的逻辑
    go PingIPWork(ip)
}

我这里执行了一个多ip去ping的逻辑，一般这种时候，你要是执行一波，人家肯定毛都不会返回给你，为什么？因为人家主线程直接就退出了，还是那句话，你又没告诉人家主线程要等这ip全部都ping 完，所以你必须要加个等待，等着Goroutine完成，这里我再举一个网上的例子

package main
import (
    "fmt"
)
func main() {
    go func() {
        fmt.Println("Goroutine 1")
    }()
    go func() {
        fmt.Println("Goroutine 2")
    }()
    //来个睡眠，等Goroutine结束
    time.Sleep(time.Second * 1)
}

看到了么，加了一个sleep，用sleep去等着Goroutine跑完，上面我举的那个例子也可以这么来

listip := []string{"10.0.9.11","10.0.9.22","10.0.9.33"}
for _, ip := range(listip) {
    //假设我们执行一个ping ip 的逻辑
    go PingIPWork(ip)
}
time.Sleep(time.Second * 1)

加个sleep可以等待完成，但是万一啊，Goroutine有的跑的快，有的慢，你那sleep就一秒，要是有的Goroutine没跑完不就白瞎了吗，所以咱们需要一个机制，这个机制可以帮助咱们去管理Goroutine，让我们知道Goroutine这东西什么时候停，什么时候完成。

所以，WaitGroup这个东西，就可以帮助我们解决这个问题，还是老样子，我举一个简单的例子来说明我的想法。

package main
import (
    "fmt"
 "sync"
)
func PingIPWork(ip string) {
 fmt.Println(ip)
}
func main() {
    //定义一个等待阿祖
 var wg sync.WaitGroup
 wg.Add(3) // 因为有3个Ip，咱们定义三个动作，所以来三个计数
 listip := []string{"10.0.9.11","10.0.9.22","10.0.9.33"}
 for _, ip := range(listip) {
  //假设我们执行一个ping ip 的逻辑
  go func(ip string) {
            //执行一个work
            PingIPWork(ip)
            //操作完成之后，done一个计数，也就是3-1
   wg.Done()
  }(ip)
 }
    //等待
 wg.Wait() // 等待，直到计数为0
}

这里我举了一个简单的例子，其实wg的用法较为简单，在这个例子里面我们用到了

wg.wait
等待Goroutine结束之后退出主进程
wg.Add
添加Goroutine，其实你可以把它想成，可添加的最大Goroutine数
wg.Done
想象成销毁参数，当Goroutine结束之后调用，意思就是，你没了，我减1

WaitGroup的其他注意事项

将Wg作为参数进行传递的时候，需要使用指针

有些时候，咱们不想写的这么麻烦，就寻思怎么才能简单一点，或者可变性稍微强一点，有些时候我们要把wg最为参数，在函数内部调用，我们该怎么写呢？

package main
import (
 "fmt"
 "sync"
)
func PingIPWork(ip string, wg *sync.WaitGroup) {
 fmt.Println(ip)
 wg.Done()
}
func main() {
 var wg sync.WaitGroup
 wg.Add(3) // 因为有两个动作，所以增加2个计数
 listip := []string{"10.0.9.11","10.0.9.22","10.0.9.33"}
 for _, ip := range(listip) {
  //假设我们执行一个ping ip 的逻辑
  go PingIPWork(ip, &wg)
  }
 wg.Wait() // 等待，直到计数为0
}

看到了么，如果你把Wg作为参数进行传递，你得要用指针的形式传值，否则就会死锁！！！！！！！！

Wg.Add的数值不能为负

wg.Add()的数值必须为正数，如果为负数，将会抛出异常。

panic: sync: negative WaitGroup counter
goroutine 1 [running]:
sync.(*WaitGroup).Add(0xc042008230, 0xffffffffffffff9c)
    D:/Go/src/sync/waitgroup.go:75 +0x1d0
main.main()
    D:/code/go/src/test-src/2-Package/sync/waitgroup/main.go:10 +0x54

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。如有错误或未考虑完全的地方，望不吝赐教。

您可能感兴趣的文章:

Go 语言下基于Redis分布式锁的实现方式
本篇文章将详细介绍如何正确地实现Redis分布式锁，下面通过一个项目基于 Redis 的分布式锁能够提供哪些分布锁特性，本文给大家介绍的非常详细，需要的朋友参考下吧
2021-06-06
Golang执行go get私有库提示"410 Gone" 的问题及解决办法
这篇文章主要介绍了Golang执行go get私有库提示”410 Gone“ 解决办法,本文给大家介绍的非常详细，具有一定的参考借鉴价值，需要的朋友可以参考下
2020-02-02
golang实现各种情况的get请求操作
这篇文章主要介绍了golang实现各种情况的get请求操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2020-12-12
Go使用select切换协程入门详解
这篇文章主要为大家介绍了Go使用select切换协程入门详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-08-08
go语言实现简单的并发网页爬虫示例
在这个章节中,我们将会结合之前的知识点,实现一个简易的并发网页爬虫,我们的爬虫会先爬取一个起始页面,提取出所有的链接,然后并发地爬取这些链接,有需要的朋友可以借鉴参考下,希望能够有所帮助
2023-08-08
Golang strings包常用字符串操作函数
Golang 中的字符串统一使用 UTF-8 （属于Unicode编码的一种实现方式）进行编码，本篇文章将结合具体实例对常用的字符串操作函数进行介绍，感兴趣的可以了解一下
2021-12-12
Golang教程之不可重入函数的实现方法
这篇文章主要给大家介绍了关于Golang教程之不可重入函数的实现方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2018-09-09
Go语言中切片使用的注意事项小结
切片是引用类型，相信对大家来说都不陌生，下面这篇文章主要给大家总结介绍了关于Go语言中切片使用的一些注意事项，文中通过示例代码介绍的非常详细，需要的朋友可以参考借鉴，下面随着小编来一起学习学习吧。
2018-01-01
深入解析Go语言编程中slice切片结构
这篇文章主要介绍了Go语言编程中slice切片结构,其中Append方法的用法介绍较为详细,需要的朋友可以参考下
2015-10-10
Golang的第一个程序-Hello World
这篇文章主要介绍了第一个Go程序-Hello World，在编写第一个go程序之前，我们要将系统的环境变量配好，下面来看具体的编一过程吧，需要的小伙伴可以参考一下
2022-01-01