go中errgroup源碼解讀

• errgroup
  • 前言
  • 如何使用
  • 實現原理
  • WithContext
  • Go
  • Wait
  • 錯誤的使用
  • 總結

errgroup

前言

來看下errgroup的實現

如何使用

func main() {
	var eg errgroup.Group

	eg.Go(func() error {
		return errors.New("test1")
	})

	eg.Go(func() error {
		return errors.New("test2")
	})

	if err := eg.Wait(); err != nil {
		fmt.Println(err)
	}
}

類比於waitgroup,errgroup增長了一個對goroutine錯誤收集的做用。

不過須要注意的是：

errgroup返回的第一個出錯的goroutine拋出的err。

errgroup中還能夠加入context

func main() {
	eg, ctx := errgroup.WithContext(context.Background())

	eg.Go(func() error {
		// test1函數還能夠在啓動不少goroutine
		// 子節點都傳入ctx，當test1報錯，會把test1的子節點一一cancel
		return test1(ctx)
	})

	eg.Go(func() error {
		return test1(ctx)
	})

	if err := eg.Wait(); err != nil {
		fmt.Println(err)
	}
}

func test1(ctx context.Context) error {
	return errors.New("test2")
}

實現原理

代碼很簡單

type Group struct {
	// 一個取消的函數，主要來包裝context.WithCancel的CancelFunc
	cancel func()

	// 仍是藉助於WaitGroup實現的
	wg sync.WaitGroup

	// 使用sync.Once實現只輸出第一個err
	errOnce sync.Once

	// 記錄下錯誤的信息
	err     error
}

仍是在WaitGroup的基礎上實現的

WithContext

// 返回一個被context.WithCancel從新包裝的ctx

func WithContext(ctx context.Context) (*Group, context.Context) {
	ctx, cancel := context.WithCancel(ctx)
	return &Group{cancel: cancel}, ctx
}

裏面使用了context,經過context.WithCancel對傳入的context進行了包裝

當WithCancel函數返回的CancelFunc被調用或者是父節點的done channel被關閉（父節點的 CancelFunc 被調用），此 context（子節點）的 done channel 也會被關閉。

errgroup把返回的CancelFunc包進了本身的cancel中，來實現對使用errgroup的ctx啓動的goroutine的取消操做。

Go

// 啓動取消阻塞的goroutine
// 記錄第一個出錯的goroutine的err信息
func (g *Group) Go(f func() error) {
	// 藉助於waitgroup實現
	g.wg.Add(1)

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

		// 執行出錯
		if err := f(); err != nil {
			// 經過sync.Once記錄下第一個出錯的err信息
			g.errOnce.Do(func() {
				g.err = err
				// 若是包裝了cancel，也就是context的CancelFunc，執行退出操做
				if g.cancel != nil {
					g.cancel()
				}
			})
		}
	}()
}

一、藉助於waitgroup實現對goroutine阻塞；

二、經過sync.Once記錄下，第一個出錯的goroutine的錯誤信息；

三、若是包裝了context的CancelFunc，在出錯的時候進行退出操做。

Wait

// 阻塞全部的經過Go加入的goroutine，而後等待他們一個個執行完成
// 而後返回第一個出錯的goroutine的錯誤信息
func (g *Group) Wait() error {
	// 藉助於waitgroup實現
	g.wg.Wait()
	// 若是包裝了cancel，也就是context的CancelFunc，執行退出操做
	if g.cancel != nil {
		g.cancel()
	}
	return g.err
}

一、藉助於waitgroup實現對goroutine阻塞；

二、若是包裝了context的CancelFunc，在出錯的時候進行退出操做；

三、拋出第一個出錯的goroutine的錯誤信息。

錯誤的使用

不過工做中發現一個errgroup錯誤使用的例子

func main() {
	eg := errgroup.Group{}
	var err error
	eg.Go(func() error {
		// 處理業務
		err = test1()
		return err
	})

	eg.Go(func() error {
		// 處理業務
		err = test1()
		return err
	})

	if err = eg.Wait(); err != nil {
		fmt.Println(err)
	}
}

func test1() error {
	return errors.New("test2")
}

很明顯err被資源競爭了

$ go run -race main.go 
==================
WARNING: DATA RACE
Write at 0x00c0000801f0 by goroutine 8:
  main.main.func2()
      /Users/yj/Go/src/Go-POINT/sync/errgroup/main.go:23 +0x97
...

總結

errgroup相比比較簡單，不過須要先弄明白waitgroup,context以及sync.Once,主要是藉助這幾個組件來實現的。

errgroup能夠帶攜帶context,若是包裝了context，會使用context.WithCancel進行超時，取消或者一些異常的狀況