go的并发sync.WaitGroup和errgroup

本文介绍了Go语言中用于并发控制的sync.WaitGroup和errgroup。sync.WaitGroup提供了一个计数器来等待一组操作完成,但无法处理错误。而errgroup在WaitGroup基础上增加了错误传递和取消功能,支持在出现错误或超时时停止所有goroutine。通过示例代码展示了它们的使用方法。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

sync.WaitGroup

WaitGroup顾名思义,就是用来等待一组操作完成的。WaitGroup内部实现了一个计数器,用来记录未完成的操作个数,它提供了三个方法,Add()用来添加计数。Done()用来在操作结束时调用,使计数减一。Wait()用来等待所有的操作结束,即计数变为0,该函数会在计数不为0时等待,在计数为0时立即返回。
下面是一个简单的例子:

package main

import (
    "fmt"
    "sync"
)

func main() {

    var wg sync.WaitGroup

    wg.Add(2) // 因为有两个动作,所以增加2个计数
    go func() {
        fmt.Println("Goroutine 1")
        wg.Done() // 操作完成,减少一个计数
    }()

    go func() {
        fmt.Println("Goroutine 2")
        wg.Done() // 操作完成,减少一个计数
    }()

    wg.Wait() // 等待,直到计数为0
}

sync.WaitGroup 缺点是若goroutines中发生错误,不能返回,所以你并不能知道出错的原因。

errgroup

可参考官网:https://godoc.org/golang.org/x/sync/errgroup
errgroup包在sync.WaitGroup功能的基础上,增加了错误传递,以及在发生不可恢复的错误时取消整个goroutine集合,或者等待超时。
包含的三个函数:

func WithContext(ctx context.Context) (*Group, context.Context)
func (g *Group) Go(f func() error)
func (g *Group) Wait() error

对上面的例子进行改写如下:

package main

import (
    "fmt"
    "golang.org/x/sync/errgroup"
)

func main() {

    var g errgroup.Group

	g.Go(func() error{
		fmt.Println("Goroutine 1")
		.......
		return err  //返回错误
	})
   g.Go(func() error{
		fmt.Println("Goroutine 2")
		......
		return err  //返回错误
	})
    
	if err := group.Wait(); err != nil {
		fmt.Println("Get errors: ", err)
	}else {
		fmt.Println("successful")
	}

}

下面这个例子用到WithContext函数,这主要是便于在各个goruntine之间传递数据。

package main

import (
	"fmt"
	"time"

	"golang.org/x/sync/errgroup"
	"golang.org/x/net/context"
)

func checkGoroutineErr(errCtx context.Context) error {
	select {
	case <-errCtx.Done():
		return errCtx.Err()
	default:
		return nil
	}
}

func main() {
	ctx , cancel := context.WithCancel(context.Background())
	group, errCtx := errgroup.WithContext(ctx)

	for i := 0; i < 3; i++ {
		index := i
		group.Go(func() error {
			fmt.Println("index=", index)
			if index == 0 {
				fmt.Println("index == 0, end!")
			}else if index == 1 {
				fmt.Println("index == 1, start...")
				cancel()
				fmt.Println("inde == 1, has error!")
			}else if index == 2 {
				fmt.Println("index == 2, start...")
				time.Sleep(time.Second * 3)
				if err := checkGoroutineErr(errCtx); err != nil {
					return err
				}
				fmt.Println("index == 2, has done!")
			}
			return nil
		})
	}

	err := group.Wait()
	if err != nil {
		fmt.Println("Get error: ", err)
	}else {
		fmt.Println("All Done!")
	}
}

### 关于 `sync.WaitGroup` `sync.WaitGroup{}` 的区别 #### 定义上的差异 `sync.WaitGroup` 是一个结构体类型,定义了一个用于等待一组 Goroutine 完成的同步机制[^2]。而 `sync.WaitGroup{}` 则是一个具体的实例化对象,表示创建了一个新的零值状态下的 `WaitGroup` 对象。 具体来说,`sync.WaitGroup` 只是一种类型的声明,只有当其被实例化为变量时才能真正发挥作用。例如: ```go var wg sync.WaitGroup // 声明并初始化一个 WaitGroup 类型的变量 ``` 或者直接使用匿名方式实例化: ```go wg := sync.WaitGroup{} // 创建一个新的 WaitGroup 实例 ``` 这两种写法都完成了对 `WaitGroup` 的初始化,但前者更常见于需要显式命名变量的情况下[^4]。 --- #### 使用场景分析 ##### 场景一:多个 Goroutine 并发执行后的统一等待 假设有一个程序启动了若干个 Goroutine 来处理不同的任务,并希望主线程能够等到这些子线程全部完成后才继续运行,则可以利用 `sync.WaitGroup` 提供的功能来实现这一需求[^1]。 下面给出一段简单的代码示例说明如何应用 `sync.WaitGroup`: ```go package main import ( "fmt" "sync" ) func worker(id int, wg *sync.WaitGroup) { defer wg.Done() // 每个工作单元结束前调用 Done 函数通知已完成 fmt.Printf("Worker %d starting\n", id) // Simulate some work being done. for i := 0; i < 3; i++ { fmt.Printf("Worker %d doing task %d\n", id, i+1) } fmt.Printf("Worker %d finished\n", id) } func main() { var wg sync.WaitGroup // 初始化 WaitGroup 结构体变量 numWorkers := 5 // 设定工作数量 wg.Add(numWorkers) // 设置要等待的任务数目 for i := 1; i <= numWorkers; i++ { go worker(i, &wg) // 启动每个 goroutine 工作者函数 } wg.Wait() // 主协程阻塞直到所有工作者完成 fmt.Println("All workers have completed their tasks.") } ``` 上述例子展示了通过传递指针形式管理不同 Goroutines 生命周期的过程。 ##### 场景二:局部作用域内的短期协作 如果只是在一个较小的作用范围内需要用到临时性的协调逻辑,那么可以直接采用如下简洁的方式构建销毁 `WaitGroup` 实例: ```go func performTasksInParallel(taskCount int) { wg := sync.WaitGroup{} wg.Add(taskCount) for i := 0; i < taskCount; i++ { go func(index int){ defer wg.Done() processTask(index) }(i) } wg.Wait() } func processTask(index int) { fmt.Printf("Processing Task #%v...\n", index) } ``` 这里无需额外声明全局范围的变量名,仅需简单地定义即可满足即时的需求[^3]。 --- ### 总结 无论是选择单独定义还是立即创建的形式,核心在于理解何时何地去运用这种强大的工具以简化复杂的并发流程控制问题。两者并无本质优劣之分,更多取决于实际编码习惯个人偏好等因素影响下做出的选择。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值