在golang中使用Sync.WaitGroup解決等待的問題

Posted on by

面對goroutine我們都需要等待它完成交給它的事情，等待它計算完成或是執行完畢，所以不得不在程序需要等待的地方使用time.Sleep()來睡眠一段時間，等待其他goroytine執行完畢，下面的代碼打印1到100的for循環可以在很快的時間內運行完畢，但是我們必須添加time.Sleep()來等待其打印完畢,如果我們不等待仿佛什麼也沒有發生一樣。。。。。這肯定不是我們想要的！

func main(){
    for i := 0; i < 100 ; i++{
        go fmt.Println(i)
    }
    time.Sleep(time.Second)
}

這就是我最開始學習goroutine想到的笨方法。。。。死等！ 等不到 time.Second*2 在等不到*3

但是對於我們實際的使用場景來說，1秒也許等待的時間有點長，而有時候是遠遠不夠的，最主要的我們無法預知gorotine的運行時間長短，所以也無法指定Sleep睡眠的時間。

正好前幾天學習瞭channel，那麼現在我們就可以

使用channel來達到我們的目的瞭

func main() {
    c := make(chan bool, 100)
    for i := 0; i < 100; i++ {
        go func(i int) {
            fmt.Println(i)
            c <- true
        }(i)
    }
 
    for i := 0; i < 100; i++ {
        <-c
    }
}

完美輸出！這裡我們可以從控制臺看到我們的勝利成果，但是我們有更好的處理方式：sync.WaitGroup

WaitGroup對象內部有一個計數器，最初從0開始，它有三個方法：Add() Done() Wait() 用來控制計數器的數量從而達到等待的目的。

func main() {
   wg := sync.WaitGroup{}
   wg.Add(100)
   for i := 0; i < 100; i++ {
      go func(i int) {
         defer wg.Done()
         fmt.Print(i)
      }(i)
   }
   wg.Wait()
}

首先使用 add(100) 把計數器的數量設置為100，每次循環運行完畢都把計數器減1，主函數使用Wait(）

阻塞，直到計數器歸0結束主線程結束阻塞。

這裡會阻塞主線程！！！需要註意。

另外：以上三種方式打印出的數字皆無序

type WaitGroup struct {
 noCopy noCopy
 state1 [3]uint32
}

它隻是一個struct所以當參數傳遞的時候需要傳遞指針。

補充：sync.WaitGroup的錯誤用法與糾正

本文主要是記錄在學習golang語言過程中錯誤使用sync.WaitGroup以及指針引起的報錯，並且糾正過程。

1.錯誤使用場景

main包的實現內容：

package main
import (
    "fmt"
    "pressure/game"
    "sync"
)
var waitGroup sync.WaitGroup //定義一個同步等待的組
func main(){
    waitGroup.Add(1) //添加一個計數
    go game.ConnSocket(serverAddr, waitGroup) //調用其他包的方法執行任務
    waitGroup.Wait() //阻塞直到所有任務完成
    fmt.Println("main DONE!!!")
}

如下是game包的內容：

package game
import (
    "fmt"
    "net"
    "strconv"
    "strings"
    "sync"
)
var gameWait sync.WaitGroup
func ConnSocket(serverAddr string, wait sync.WaitGroup) {
    var err error
    Conn, err = net.Dial("tcp", serverAddr)
    if err != nil {
        fmt.Println("Error connected:", err.Error())
        wait.Done()
        return
    }
    gameWait = wait
    fmt.Println("connected OK:", Conn.RemoteAddr())
    go readMessage()
}
func readMessage() {
    fmt.Println("readMessage:")
    for {
        if OK:=dosomething(),OK{
            gameWait.Done()
        }
    }
}

然後執行如上的代碼，會出現報錯：

panic: sync: negative WaitGroup counter

goroutine 12 [running]:

sync.(*WaitGroup).Add(0x7b8b90, 0xffffffffffffffff)

D:/Program Files/Go/src/sync/waitgroup.go:75 +0x1d0

sync.(*WaitGroup).Done(0x7b8b90)

原因：

func ConnSocket(serverAddr string, wait sync.WaitGroup)隻是把sync.WaitGroup的值傳遞過來，而非內存地址，所以在賦值給gameWait的時候也隻是賦值瞭值，gameWait並非指向的main裡的waitGroup 的內存地址，導致 gameWait.Done()的時候並沒有獲取到main裡的計數1，所以才會報負數。究其原因還是沒有對指針的理解。所以針對上面的問題做瞭修改。

2.正確的使用

main包的實現內容：

package main
import (
    "fmt"
    "pressure/game"
    "sync"
)
var waitGroup sync.WaitGroup //定義一個同步等待的組
func main(){
    waitGroup.Add(1) //添加一個計數
    //這裡傳遞waitGroup的內存地址
    go game.ConnSocket(serverAddr, &waitGroup) //調用其他包的方法執行任務
    waitGroup.Wait() //阻塞直到所有任務完成
    fmt.Println("main DONE!!!")
}

如下是game包的內容：

package game
import (
    "fmt"
    "net"
    "strconv"
    "strings"
    "sync"
)
var gameWait *sync.WaitGroup//此處也申明為指針變量
//參數傳遞為指針傳遞*sync.WaitGroup，即wait 指向的是main裡的waitGroup的內存地址
func ConnSocket(serverAddr string, wait *sync.WaitGroup) {
    var err error
    Conn, err = net.Dial("tcp", serverAddr)
    if err != nil {
        fmt.Println("Error connected:", err.Error())
        wait.Done()
        return
    }
    gameWait = wait//指針指向另一個指針，這樣就做到瞭gameWait指向的是wait的地址，所以gameWait修改wait的內存地址鎖存貯的值也會跟隨改變
    fmt.Println("connected OK:", Conn.RemoteAddr())
    go readMessage()
}
func readMessage() {
    fmt.Println("readMessage:")
    for {
        if OK:=dosomething(),OK{
            gameWait.Done()
        }
    }
}

3.結果

還是對指針傳遞以及值傳遞理解不夠透徹才會出現如此問題，因此還需要多針對指針進行學習與理解。以防在以後的工作中出現類似問題。

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。如有錯誤或未考慮完全的地方，望不吝賜教。

推薦閱讀：