【Golang】并发编程包之 errgroup

原文链接：并发编程包之 errgroup

前言

哈喽，大家好，我是asong，今天给大家介绍一个并发编程包errgroup，其实这个包就是对sync.waitGroup的封装。我们在之前的文章—— 源码剖析sync.WaitGroup(文末思考题你能解释一下吗?)，从源码层面分析了sync.WaitGroup的实现，使用waitGroup可以实现一个goroutine等待一组goroutine干活结束，更好的实现了任务同步，但是waitGroup却无法返回错误，当一组Goroutine中的某个goroutine出错时，我们是无法感知到的，所以errGroup对waitGroup进行了一层封装，封装代码仅仅不到50行，下面我们就来看一看他是如何封装的？

errGroup如何使用

老规矩，我们先看一下errGroup是如何使用的，前面吹了这么久，先来验验货；

以下来自官方文档的例子：

go复制代码var (
	Web   = fakeSearch("web")
	Image = fakeSearch("image")
	Video = fakeSearch("video")
)

type Result string
type Search func(ctx context.Context, query string) (Result, error)

func fakeSearch(kind string) Search {
	return func(_ context.Context, query string) (Result, error) {
		return Result(fmt.Sprintf("%s result for %q", kind, query)), nil
	}
}

func main() {
	Google := func(ctx context.Context, query string) ([]Result, error) {
		g, ctx := errgroup.WithContext(ctx)

		searches := []Search{Web, Image, Video}
		results := make([]Result, len(searches))
		for i, search := range searches {
			i, search := i, search // https://golang.org/doc/faq#closures_and_goroutines
			g.Go(func() error {
				result, err := search(ctx, query)
				if err == nil {
					results[i] = result
				}
				return err
			})
		}
		if err := g.Wait(); err != nil {
			return nil, err
		}
		return results, nil
	}

	results, err := Google(context.Background(), "golang")
	if err != nil {
		fmt.Fprintln(os.Stderr, err)
		return
	}
	for _, result := range results {
		fmt.Println(result)
	}

}

上面这个例子来自官方文档，代码量有点多，但是核心主要是在Google这个闭包中，首先我们使用errgroup.WithContext创建一个errGroup对象和ctx对象，然后我们直接调用errGroup对象的Go方法就可以启动一个协程了，Go方法中已经封装了waitGroup的控制操作，不需要我们手动添加了，最后我们调用Wait方法，其实就是调用了waitGroup方法。这个包不仅减少了我们的代码量，而且还增加了错误处理，对于一些业务可以更好的进行并发处理。

赏析errGroup

数据结构

我们先看一下Group的数据结构：

go复制代码type Group struct {
	cancel func() // 这个存的是context的cancel方法

	wg sync.WaitGroup // 封装sync.WaitGroup

	errOnce sync.Once // 保证只接受一次错误
	err     error // 保存第一个返回的错误
}

方法解析

go复制代码func WithContext(ctx context.Context) (*Group, context.Context)
func (g *Group) Go(f func() error)
func (g *Group) Wait() error

errGroup总共只有三个方法：

• WithContext方法

go复制代码func WithContext(ctx context.Context) (*Group, context.Context) {
	ctx, cancel := context.WithCancel(ctx)
	return &Group{cancel: cancel}, ctx
}

这个方法只有两步：

• 使用context的WithCancel()方法创建一个可取消的Context
• 创建cancel()方法赋值给Group对象
• Go方法

go复制代码func (g *Group) Go(f func() error) {
	g.wg.Add(1)

	go func() {
		defer g.wg.Done()

		if err := f(); err != nil {
			g.errOnce.Do(func() {
				g.err = err
				if g.cancel != nil {
					g.cancel()
				}
			})
		}
	}()
}

Go方法中运行步骤如下：

• 执行Add()方法增加一个计数器
• 开启一个协程，运行我们传入的函数f，使用waitGroup的Done()方法控制是否结束
• 如果有一个函数f运行出错了，我们把它保存起来，如果有cancel()方法，则执行cancel()取消其他goroutine

这里大家应该会好奇为什么使用errOnce，也就是sync.Once，这里的目的就是保证获取到第一个出错的信息，避免被后面的Goroutine的错误覆盖。

• wait方法

go复制代码func (g *Group) Wait() error {
	g.wg.Wait()
	if g.cancel != nil {
		g.cancel()
	}
	return g.err
}

总结一下wait方法的执行逻辑：

• 调用waitGroup的Wait()等待一组Goroutine的运行结束
• 这里为了保证代码的健壮性，如果前面赋值了cancel，要执行cancel()方法
• 返回错误信息，如果有goroutine出现了错误才会有值

小结

到这里我们就分析完了errGroup包，总共就1个结构体和3个方法，理解起来还是比较简单的，针对上面的知识点我们做一个小结：

• 我们可以使用withContext方法创建一个可取消的Group，也可以直接使用一个零值的Group或new一个Group，不过直接使用零值的Group和new出来的Group出现错误之后就不能取消其他Goroutine了。
• 如果多个Goroutine出现错误，我们只会获取到第一个出错的Goroutine的错误信息，晚于第一个出错的Goroutine的错误信息将不会被感知到。
• errGroup中没有做panic处理，我们在Go方法中传入func() error方法时要保证程序的健壮性

踩坑日记

使用errGroup也并不是一番风顺的，我之前在项目中使用errGroup就出现了一个BUG，把它分享出来，避免踩坑。

这个需求是这样的(并不是真实业务场景，由asong虚构的)：开启多个Goroutine去缓存中设置数据，同时开启一个Goroutine去异步写日志，很快我的代码就写出来了：

go复制代码func main()  {
	g, ctx := errgroup.WithContext(context.Background())

	// 单独开一个协程去做其他的事情，不参与waitGroup
	go WriteChangeLog(ctx)

	for i:=0 ; i< 3; i++{
		g.Go(func() error {
			return errors.New("访问redis失败\n")
		})
	}
	if err := g.Wait();err != nil{
		fmt.Printf("appear error and err is %s",err.Error())
	}
	time.Sleep(1 * time.Second)
}

func WriteChangeLog(ctx context.Context) error {
	select {
	case <- ctx.Done():
		return nil
	case <- time.After(time.Millisecond * 50):
		fmt.Println("write changelog")
	}
	return nil
}
// 运行结果
appear error and err is 访问redis失败

代码没啥问题吧，但是日志一直没有写入，排查了好久，终于找到问题原因。原因就是这个ctx。

因为这个ctx是WithContext方法返回的一个带取消的ctx，我们把这个ctx当作父context传入WriteChangeLog方法中了，如果errGroup取消了，也会导致上下文的context都取消了，所以WriteChangelog方法就一直执行不到。

这个点是我们在日常开发中想不到的，所以需要注意一下～。

总结

因为最近看很多朋友都不知道这个库，所以今天就把他分享出来了，封装代码仅仅不到50行，真的是很厉害，如果让你来封装，你能封装的更好吗？

欢迎关注公众号：【Golang梦工厂】

推荐往期文章：

• 学习channel设计：从入门到放弃
• 编程模式之Go如何实现装饰器
• Go语言中new和make你使用哪个来分配内存？
• 源码剖析panic与recover，看不懂你打我好了！
• 空结构体引发的大型打脸现场
• 面试官：你能聊聊string和[]byte的转换吗？
• 面试官：两个nil比较结果是什么？
• 面试官：你能用Go写段代码判断当前系统的存储方式吗?
• 赏析Singleflight设计

本文转载自: 掘金

开发者博客 – 和开发相关的 这里全都有