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()
}
})
}
}()
}
1、藉助於waitgroup實現對goroutine阻塞；
2、通過sync.Once記錄下，第一個出錯的goroutine的錯誤資訊；
3、如果包裝了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
}
1、藉助於waitgroup實現對goroutine阻塞；
2、如果包裝了context的CancelFunc，在出錯的時候進行退出操作；
3、丟擲第一個出錯的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進行超時，取消或者一些異常的情況