1. 簡介

本文將介紹 Go 語言中的 WaitGroup 并發(fā)原語，包括 WaitGroup 的基本使用方法、實現原理、使用注意事項以及常見的使用方式。能夠更好地理解和應用 WaitGroup 來協(xié)調多個 Goroutine 的執(zhí)行，提高 Go 并發(fā)編程的效率和穩(wěn)定性。

2. 基本使用

2.1 定義

WaitGroup是Go語言標準庫中的一個結構體，它提供了一種簡單的機制，用于同步多個協(xié)程的執(zhí)行。適用于需要并發(fā)執(zhí)行多個任務并等待它們全部完成后才能繼續(xù)執(zhí)行后續(xù)操作的場景。

2.2 使用方式

首先主協(xié)程創(chuàng)建WaitGroup實例，然后在每個協(xié)程的開始處，調用Add(1)方法，表示需要等待一個任務執(zhí)行完成，然后協(xié)程在任務執(zhí)行完成之后，調用Done方法，表示任務已經執(zhí)行完成了。

主協(xié)程中，需要調用Wait()方法，等待所有協(xié)程完成任務，示例如下:

func main(){
    //首先主協(xié)程創(chuàng)建WaitGroup實例
    var wg sync.WaitGroup
    // 開始時調用Add方法表示有個任務開始執(zhí)行
    wg.Add(1)
    go func() {
        // 開始執(zhí)行...
        //完成之后,調用Done方法
        wg.Done()
    }()
    // 調用Wait()方法，等待所有協(xié)程完成任務
    wg.Wait()
    // 執(zhí)行后續(xù)邏輯
}

2.3 使用例子

package main
import (
    "fmt"
    "sync"
)
func main() {
    var wg sync.WaitGroup
    for i := 0; i < 5; i++ {
       wg.Add(1)
       go func(i int) {
          defer wg.Done()
          fmt.Printf("任務%d開始執(zhí)行\(zhòng)n", i)
          // 模擬協(xié)程任務執(zhí)行一段時間
          time.Sleep(time.Duration(rand.Int() % 100))
          // 線程任務執(zhí)行完成
          fmt.Printf("任務%d執(zhí)行完畢\n", i)
       }(i)
    }
    fmt.Println("主協(xié)程開始等待所有任務執(zhí)行完成...")
    wg.Wait()
    fmt.Println("所有協(xié)程已經執(zhí)行完畢...")
}

在這個例子中，我們使用了sync.WaitGroup來等待5個協(xié)程執(zhí)行完畢。在循環(huán)中，每創(chuàng)建一個任務，我們調用一次wg.Add(1)方法，然后啟動一個協(xié)程去執(zhí)行任務，當協(xié)程完成任務后，調用wg.Done方法，告知主協(xié)程任務已經執(zhí)行完畢。然后主協(xié)程會在5個協(xié)程任務全部執(zhí)行完畢之后，才會繼續(xù)向下執(zhí)行。

3.實現原理

3.1 設計初衷

WaitGroup的設計初衷就是為了等待一組操作完成后再執(zhí)行下一步操作，通常會在一組協(xié)程中使用。

3.2 基本原理

sync.WaitGroup 結構體中的 state1 和 state2 字段是用于實現 WaitGroup 功能的重要變量。

type WaitGroup struct {
   noCopy noCopy
   state1 uint64
   state2 uint32
}

由于 WaitGroup 需要等待一組操作完成之后再執(zhí)行，因此需要等待所有操作完成之后才能繼續(xù)執(zhí)行。為了實現這個功能，WaitGroup 使用了一個計數器 counter 來記錄還有多少個操作沒有完成，如果 counter 的值為 0，則表示所有操作已經完成。

同時，WaitGroup 在所有任務都完成之后，需要喚醒所有處于等待的協(xié)程，此時需要知道有多少個協(xié)程處于等待狀態(tài)。為了實現這個功能，WaitGroup 使用了一個等待計數器 waiter 來記錄當前有多少個協(xié)程正在等待操作完成。

這里WaitGroup對于計數器和等待計數器的實現，是通過一個64位無符號整數來實現的，也就是WaitGroup結構體中的state1，其中高32位保存了任務計數器counter的值，低32位保存了等待計數器waiter的值。當我們創(chuàng)建一個 WaitGroup 實例時，該實例的任務計數器和等待計數器都被初始化為 0。

而且，等待協(xié)程需要等待所有任務完成之后才能繼續(xù)執(zhí)行，所以等待協(xié)程在任務未完成時會被阻塞，當任務全部完成后，自動被喚醒。WaitGroup使用 state2 用于實現信號量機制。通過調用 runtime_Semacquire() 和 runtime_Semrelease() 函數，可以在不阻塞線程的情況下進行等待和通知操作。

3.3 代碼實現

3.3.1 Add方法

調用 Add() 方法增加/減小counter的值，delta的值可以是正數，也可以是負數，下面是Add方法的源碼實現:

func (wg *WaitGroup) Add(delta int) {
   // delta 的值可以為負數,Done方法便是通過Add(-1)來實現的
   // statep: 為state1的地址  semap: 為state2的地址
   statep, semap := wg.state()
   // 高32位的值 加上 delta,增加任務計數器的值
   state := atomic.AddUint64(statep, uint64(delta)<<32)
   // v: 取高32位數據,獲取到待完成任務數
   v := int32(state >> 32)
   // 取低32位數據,獲取到等待線程的值
   w := uint32(state)
   // v > 0: 說明還有待完成的任務數,此時不應該喚醒等待協(xié)程
   // w = 0: 說明沒有協(xié)程在等待,此時可以直接退出
   if v > 0 || w == 0 {
      return
   }     
   // 此時v = 0,所有任務都完成了,喚醒等待協(xié)程
   *statep = 0
   for ; w != 0; w-- {
      runtime_Semrelease(semap, false, 0)
   }
}

3.3.2 Done方法實現

調用 Done() 方法表示完成了一個任務，通過調用Add方法，delta值為-1，減少任務計數器counter的值，當其歸為0時，便自動喚醒所有處于等待的協(xié)程。

// Done decrements the WaitGroup counter by one.
func (wg *WaitGroup) Done() {
   wg.Add(-1)
}

3.3.3 Wait方法實現

調用Wait方法，等待任務執(zhí)行完成，增加等待計數器Waiter的值:

func (wg *WaitGroup) Wait() {
   // statep: 為state1的地址  semap: 為state2的地址
   statep, semap := wg.state()
   for {
      // 加載state1的值
      state := atomic.LoadUint64(statep)
      // v: 取高32位數據,獲取到待完成任務數
      v := int32(state >> 32)
      // 沒有任務待執(zhí)行,全部都完成了
      if v == 0 {
         return
      }
      // 增加waiter計數器的值
      if atomic.CompareAndSwapUint64(statep, state, state+1) {
          // 等待被喚醒
         runtime_Semacquire(semap)
         return
      }
   }
}

3.4 實現補充

Add方法，Done方法以及Wait方法實現中，有一些異常場景的驗證邏輯被我刪除掉了。當出現異常場景時，說明用戶使用方式和WaitGroup的設計初衷相違背了，此時WaitGroup就會直接panic。

下面通過說明使用的注意事項，來間接介紹WaitGroup的異常驗證邏輯。

4.使用注意事項

4.1 Add方法和Done方法需要成對出現

下面是一個Add方法和Done方法沒有成對出現的例子，此時Add方法調多了，此時計數器永遠大于0，Wait 方法會一直阻塞等待。

package main
import (
    "fmt"
    "sync"
)
func main() {
    var wg sync.WaitGroup
    wg.Add(2)
    go func() {
        defer wg.Done()
        fmt.Println("Goroutine 1")
    }()
    go func() {
        fmt.Println("Goroutine 2")
    }()
    wg.Wait()
    fmt.Println("All goroutines finished")
}

在上述代碼中，我們調用了wg.Add(2)，但只調用了一次wg.Done()。這會導致counter的值大于0，因此調用wg.Wait()會被永久阻塞，不會繼續(xù)向下繼續(xù)執(zhí)行。

還有另外一種情況時Done方法調用多了，此時任務計數器counter的值為負數，從WaitGroup設計的語意來看，就是需要等待完成的任務數為負數，這個不符合預期，此時將會直接panic

package main
import (
    "fmt"
    "sync"
)
func main() {
    var wg sync.WaitGroup
    wg.Add(1)
    go func() {
        fmt.Println("Goroutine 1 started")
        wg.Done() // 第一次調用Done方法
        wg.Done() // 第二次調用Done方法
        fmt.Println("Goroutine 1 completed")
    }()
    wg.Wait()
    fmt.Println("All goroutines completed")
}

在上面的例子中，我們啟動了一個goroutine，第一次調用Add方法，counter的值變?yōu)?，在第14行調用Done，此時計數器的值變?yōu)?，此時等待中的goroutine將會被喚醒。在第15行又調用了一次Done方法，當counter減小為0時，再次調用Done方法會導致panic，因為此時waitGroup的計數器已經為0，再次減少將導致負數計數，這是不被允許的。

所以在調用Done方法時，需要保證每次調用都與Add方法的調用一一對應，否則會導致程序出現錯誤。

4.2 在所有任務都已經添加之后，才調用Wait方法進行等待

WaitGroup的設計初衷就是為了等待一組操作完成后再執(zhí)行下一步操作。所以，如果在所有任務添加之前，便調用Wait方法進行等待，此時有可能會導致等待協(xié)程提前被喚醒，執(zhí)行下一步操作，而尚未添加的任務則不會被等待，這違反了WaitGroup的設計初衷，也不符合預期。下面是一個簡單的例子:

package main
import (
        "fmt"
        "sync"
        "time"
)
func main() {
        var wg sync.WaitGroup
        for i := 1; i <= 3; i++ {
           go func(id int) {
              wg.Add(1)
              defer wg.Done()
              fmt.Printf("Goroutine %d started\n", id)
              time.Sleep(time.Duration(id) * time.Second) 
              fmt.Printf("Goroutine %d finished\n", id)
           }(i)
        }
        // 不等待所有任務添加，就開始等待
        wg.Wait()
        fmt.Println("All goroutines finished")
        time.Sleep(10 * time.Second)
}

代碼執(zhí)行結果如下，等待協(xié)程被提前喚醒，執(zhí)行之后的操作，而子任務在等待協(xié)程喚醒后才開始執(zhí)行:

All goroutines finished
Goroutine 1 started
Goroutine 3 started
Goroutine 2 started
Goroutine 1 finished
Goroutine 2 finished
Goroutine 3 finished

在這個例子中，我們創(chuàng)建了三個協(xié)程并打印出它們開始和結束的消息。但是，我們沒有在任務開始前調用Add方法添加任務，而是在任務開始之后再調用Add方法添加任務。

這可能會導致某些任務未被加入到WaitGroup中，等待協(xié)程就調用了wg.Wait方法，這樣就會導致一些任務未被加入WaitGrou，從而導致等待協(xié)程不會等待這些任務執(zhí)行完成。如果這種情況發(fā)生了，我們會看到"All goroutines finished"被輸出，但實際上有一些協(xié)程還沒有完成。

因此，我們應該在所有任務添加完畢之后再調用Wait方法，以保證等待的正確性。

5. WaitGroup常見使用場景

在函數或方法中使用，如果一個大任務可以拆分為多個獨立的子任務，此時會將其進行拆分，并使用多個協(xié)程來并發(fā)執(zhí)行這些任務，提高執(zhí)行效率，同時使用WaitGroup等待所有子任務執(zhí)行完成，完成協(xié)程間的同步。

下面來看go-redis中ClusterClient結構體中ForEachMaster方法中對于WaitGroup的使用。ForEachMaster方法通常用于在 Redis 集群中執(zhí)行針對所有主節(jié)點的某種操作，例如在集群中添加或刪除鍵，或者執(zhí)行一些全局的診斷操作，具體執(zhí)行的操作由傳入參數fn指定。

這里ForEachMaster方法會對所有主節(jié)點執(zhí)行某種操作，這里的實現是對所有主節(jié)點執(zhí)行某種操作這個大任務，拆分為多個獨立的子任務，每個子任務完成對一個Master節(jié)點執(zhí)行指定操作，然后每個子任務啟動一個協(xié)程去執(zhí)行，主協(xié)程使用WaitGroup等待所有協(xié)程完成指定子任務，ForEachMaster也就完成了對所有主節(jié)點執(zhí)行某種操作的任務。具體實現如下：

func (c *ClusterClient) ForEachMaster(
   ctx context.Context,
   fn func(ctx context.Context, client *Client) error,
) error {
   // 重新加載集群狀態(tài),以確保狀態(tài)信息是最新的
   state, err := c.state.ReloadOrGet(ctx)
   if err != nil {
      return err
   }
   var wg sync.WaitGroup
   // 用于協(xié)程間通信
   errCh := make(chan error, 1)
    // 獲取到redis集群中所有的master節(jié)點
   for _, master := range state.Masters {
      // 啟動一個協(xié)程來執(zhí)行該任務
      wg.Add(1)
      go func(node *clusterNode) {
         // 任務完成時,調用Done告知WaitGroup任務已完成
         defer wg.Done()
         err := fn(ctx, node.Client)
         if err != nil {
            select {
            case errCh <- err:
            default:
            }
         }
      }(master)
   }
   // 主協(xié)程等待所有任務完成
   wg.Wait()
   return nil
 }

總結

本文介紹了 Go 語言中的 WaitGroup 并發(fā)原語，它提供了一種簡單且強大的機制來協(xié)調多個 Goroutine 的執(zhí)行。我們首先學習了 WaitGroup 的基本使用方法，包括如何創(chuàng)建 WaitGroup、如何向計數器中添加值、如何等待所有 Goroutine 完成以及如何在 Goroutine 中通知 WaitGroup 完成。

接著，我們了解了 WaitGroup 的實現原理，包括計數器和等待計數器的實現。了解了實現原理之后，我們可以更好地理解 WaitGroup 的內部機制以及如何更好地使用它來實現我們的需求。

在接下來的部分中，我們介紹了一些使用 WaitGroup 的注意事項，以及常見的使用方式?；诖耍覀兺瓿闪藢aitGroup的介紹,更多關于go同步協(xié)程WaitGroup的資料請關注腳本之家其它相關文章！

最新評論