一文帶你瞭解Golang中的WaitGroups

Posted on by

什麼是WaitGroups

WaitGroups是同步你的goroutines的一種有效方式。想象一下，你和你的傢人一起駕車旅行。你的父親在一個條形商場或快餐店停下來，買些食物和上廁所。你最好想等大傢回來後再開車去地平線。WaitGroups幫助你做到這一點。

WaitGroups是通過調用標準庫中的sync包來定義的。

var wg sync.WaitGroup

那麼，什麼是WaitGroup呢？WaitGroup是一個結構，它包含瞭程序需要等待多少個goroutine的某些信息。它是一個包含你需要等待的goroutines數量的組。

WaitGroups有三個最重要的方法: Add, Done和 Wait。

  • Add: 添加到你需要等待的goroutines的總量上。
  • Done: 從你需要等待的goroutines總數中減去一個。
  • Wait: 阻止代碼繼續進行，直到沒有更多的goroutines需要等待。

如何使用WaitGroups

讓我們來看看一段代碼：

package main

import (
    "fmt"
    "sync"
    "time"
)

func main() {
    var wg sync.WaitGroup
    wg.Add(1)

    go func() {
        defer wg.Done()

        fmt.Println(time.Now(), "start")
        time.Sleep(time.Second)
        fmt.Println(time.Now(), "done")
    }()

    wg.Wait()
    fmt.Println(time.Now(), "exiting...")
}

2022-08-21 17:01:54.184744229 +0900 KST m=+0.000021800 start
2022-08-21 17:01:55.184932851 +0900 KST m=+1.000210473 done
2022-08-21 17:01:55.18507731 +0900 KST m=+1.000354912 exiting…

  • 我們首先初始化一個WaitGroup wg的實例。
  • 然後我們在wg中添加1，因為我們要等待一個goroutine完成。
  • 然後我們運行這個goroutine。在goroutine內部，我們對wg.Done()進行延遲調用，以確保我們遞減要等待的goroutine的數量。如果我們不這樣做，那麼代碼將永遠等待goroutine完成，並將導致死鎖。
  • 在goroutine調用之後，我們要確保阻斷代碼，直到WaitGroup為空。我們通過調用wg.Wait()來做到這一點。

為什麼使用WaitGroups而不是channel

現在我們知道瞭如何使用WaitGroups，一個自然而然的想法將我們引向這個問題：為什麼使用WaitGroups而不是通道？

根據我的經驗，有幾個原因。

  • WaitGroups往往更直觀。當你閱讀一段代碼時，當你看到一個WaitGroup時，你會立即知道代碼在做什麼。方法的名稱很明確，而且直奔主題。然而，對於通道來說，有時就不是那麼清楚瞭。使用通道是很聰明的，但當你閱讀一段復雜的代碼時，理解起來會很麻煩。
  • 有的時候，你不需要使用通道。例如，讓我們看一下這段代碼：
 var wg sync.WaitGroup

  for i := 0; i < 5; i++ {
      wg.Add(1)
      go func() {
          defer wg.Done()

          fmt.Println(time.Now(), "start")
          time.Sleep(time.Second)
          fmt.Println(time.Now(), "done")
      }()
  }

  wg.Wait()
  fmt.Println(time.Now(), "exiting...")

你可以看到，這個goroutine並沒有與其他goroutine進行數據交流。如果你的goroutine是一次性的工作，你不需要知道結果，使用WaitGroup是可取的。現在看一下這段代碼：

  ch := make(chan int)

  for i := 0; i < 5; i++ {
      go func() {
          randomInt := rand.Intn(10)
          ch <- randomInt
      }()
  }

  for i := 0; i < 5; i++ {
      fmt.Println(<-ch)
  }

這裡，goroutine正在向 channel 發送數據。在這些情況下，我們不需要使用WaitGroup，因為這將是多餘的。如果接收已經做瞭足夠的阻塞，為什麼還要等待goroutine完成？

WaitGroups是專門用來處理等待goroutines的。我覺得通道的主要目的是為瞭交流數據。你不能用WaitGroup來發送和接收數據，但你可以用一個channel來同步你的goroutines。

最後，沒有正確的答案。我知道這可能很煩人，但這取決於你和你工作的團隊。無論什麼方法都是最好的，沒有答案是錯誤的。我個人傾向於使用WaitGroups進行同步，但你的情況可能有所不同。選擇對你來說最直觀的東西。

需要註意的一件事

有時，你可能需要將WaitGroup實例傳遞給goroutine。可能有幾個WaitGroup來處理不同的goroutine，也可能是一種設計選擇。不管是什麼原因，請確保傳遞指向WaitGroup的指針，像這樣：

var wg sync.WaitGroup

for i := 0; i < 5; i++ {
    wg.Add(1)
    go func(wg *sync.WaitGroup) {
        defer wg.Done()

        fmt.Println(time.Now(), "start")
        time.Sleep(time.Second)
        fmt.Println(time.Now(), "done")
    }(&wg)
}

wg.Wait()
fmt.Println(time.Now(), "exiting...")

原因是Go是一種值傳遞的語言。這意味著每當你向一個函數傳遞一個參數時，Go會復制一個參數並傳遞給它而不是原始對象。在這種情況下發生的是，整個WaitGroup對象將被復制，這意味著goroutine將處理一個完全不同的WaitGroup。wg.Done()不會從原始的wg中減去，而是減去它的一個副本，這個副本隻存在於goroutine中。

總結

通過使用WaitGroups，我們可以輕松同步goroutines，從而確保我們的代碼在正確的時間執行。盡管通道也可以用於同步，但WaitGroups通常更直觀且更易於閱讀。在使用WaitGroup時，請確保正確傳遞指向WaitGroup的指針，以防止出現副本問題。無論您選擇哪種方法，都應該選擇最直觀和最適合您和您的團隊的方法。

到此這篇關於一文帶你瞭解Golang中的WaitGroups的文章就介紹到這瞭,更多相關Golang WaitGroups內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：