Go語言擴展原語之ErrGroup的用法詳解

更新時間：2023年07月18日 11:49:11 作者：碼一行

除標(biāo)準(zhǔn)庫中提供的同步原語外，Go語言還在子倉庫sync中提供了4種擴展原語，本文主要為大家介紹的是其中的golang/sync/errgroup.Group，感興趣的小伙伴可以了解一下

概述

除標(biāo)準(zhǔn)庫中提供的同步原語外，Go語言還在子倉庫sync中提供了4種擴展原語：

golang/sync/errgroup.Group
golang/sync/semaphore.Weighted
golang/sync/singleflight.Group
golang/sync/syncmap.Map

其中 golang/sync/syncmap.Map 在 Go1.9 中移植到了標(biāo)準(zhǔn)庫中。

接下來介紹Go語言在擴展包中提供的3種同步原語 —— golang/sync/errgroup.Group

ErrGroup

golang/sync/errgroup.Group 為我們在一組 Goroutine 中提供了同步、錯誤傳播以及上下文取消功能，我們可以使用這種方式并行獲取網(wǎng)頁數(shù)據(jù)：

var g errgroup.Group
var urls = []string{
    "http://www.golang.org",
    "http://www.google.com"
}
for i := range urls {
    url := urls[i]
    g.Go(func() error {
        resp, err := http.Get(url)
        if err == nil {
            resp.Body.Close()
        }
        return err
    })
}
if err := g.Wait(); err == nil {
    fmt.Println("Successfully fetched all URLs.")
}

golang/sync/errgroup.Group.Go 方法能夠創(chuàng)建一個 Goroutine 并在其中執(zhí)行傳入的函數(shù)，而 golang/sync/errgroup.Group.Wait 會等待所有 Goroutine 返回，該方法的不同返回結(jié)果有不同的含義：

如果返回錯誤 —— 這一組 Goroutine 最少返回一個錯誤
如果返回空值 —— 所有 Goroutine 都成功執(zhí)行

結(jié)構(gòu)體

golang/sync/errgroup.Group 結(jié)構(gòu)體有 3 個比較重要的部分組成

cancel —— 創(chuàng)建 context.Context 時返回的取消函數(shù)，用于在多個 Goroutine 之間同步取消信號
wg —— 用于等待一組 Goroutine 完成子任務(wù)的同步原語
errOnce —— 用于保證只接收一個子任務(wù)返回的錯誤

type Group struct {
    cancel func()
    wg sync.WaitGroup
    errOnce sync.Once
    err     error
}

這些字段共同組成了 golang/sync/errgroup.Group 結(jié)構(gòu)體并為我提供同步、錯誤傳播以及上下文取消等功能。

接口

我們能通過 golang/sync/errgroup.WithContext 構(gòu)造器創(chuàng)新的 golang/sync/errgroup.Group 結(jié)構(gòu)體：

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

運行新的并行子任務(wù)需要使用 golang/sync/errgroup.Group.Go 方法，這個方法的執(zhí)行過程如下：

調(diào)用 sync.WaitGroup.Add 增加待處理的任務(wù)
創(chuàng)建新的 Goroutine 并運行子任務(wù)
返回錯誤時及時調(diào)用 cancel 并對 err 賦值，只有最早返回的錯誤才會被上游感知到，后續(xù)錯誤都會被舍棄。

func (g *Group) Go(){
    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()
                }
            })
        }
    }()
}
func (g *Group) Wait() error {
    g.wg.Wait()
    if g.cancel != nil {
        g.cancel()
    }
    return g.err
}

另一個用于等待的 golang/sync/errgroup.Group.Wait 方法只是調(diào)用了 sync.WaitGroup.Wait，在子任務(wù)全部完成時取消 context.Context 并返回可能出現(xiàn)的錯誤。