快捷導(dǎo)航

Go并發(fā):使用sync.WaitGroup實(shí)現(xiàn)協(xié)程同步方式

更新時(shí)間：2021年05月04日 09:19:09 作者：Cynhard85

這篇文章主要介紹了Go并發(fā):使用sync.WaitGroup實(shí)現(xiàn)協(xié)程同步方式，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧

經(jīng)常看到有人會(huì)問(wèn)如何等待主協(xié)程中創(chuàng)建的協(xié)程執(zhí)行完畢之后再結(jié)束主協(xié)程，例如如下代碼：

package main
import (
    "fmt"
)
func main() {
    go func() {
        fmt.Println("Goroutine 1")
    }()
    go func() {
        fmt.Println("Goroutine 2")
    }()
}

執(zhí)行以上代碼很可能看不到輸出，因?yàn)橛锌赡苓@兩個(gè)協(xié)程還沒得到執(zhí)行主協(xié)程已經(jīng)結(jié)束了，而主協(xié)程結(jié)束時(shí)會(huì)結(jié)束所有其他協(xié)程。

解決辦法是可以在main函數(shù)結(jié)尾加上等待：

package main
import (
    "fmt"
    "time"
)
func main() {
    go func() {
        fmt.Println("Goroutine 1")
    }()
    go func() {
        fmt.Println("Goroutine 2")
    }()
    time.Sleep(time.Second * 1) // 睡眠1秒，等待上面兩個(gè)協(xié)程結(jié)束
}

這并不是完美的解決方法，如果這兩個(gè)協(xié)程中包含復(fù)雜的操作，可能很耗時(shí)間，就無(wú)法確定需要睡眠多久，當(dāng)然可以用管道實(shí)現(xiàn)同步：

package main
import (
    "fmt"
)
func main() {
    ch := make(chan struct{})
    count := 2 // count 表示活動(dòng)的協(xié)程個(gè)數(shù)
    go func() {
        fmt.Println("Goroutine 1")
        ch <- struct{}{} // 協(xié)程結(jié)束，發(fā)出信號(hào)
    }()
    go func() {
        fmt.Println("Goroutine 2")
        ch <- struct{}{} // 協(xié)程結(jié)束，發(fā)出信號(hào)
    }()
    for range ch {
        // 每次從ch中接收數(shù)據(jù)，表明一個(gè)活動(dòng)的協(xié)程結(jié)束
        count--
        // 當(dāng)所有活動(dòng)的協(xié)程都結(jié)束時(shí)，關(guān)閉管道
        if count == 0 {
            close(ch)
        }
    }
}

上面的解決方案是比較完美的方案，但是Go提供了更簡(jiǎn)單的方法——使用sync.WaitGroup。

WaitGroup顧名思義，就是用來(lái)等待一組操作完成的。

WaitGroup內(nèi)部實(shí)現(xiàn)了一個(gè)計(jì)數(shù)器，用來(lái)記錄未完成的操作個(gè)數(shù)，它提供了三個(gè)方法，Add()用來(lái)添加計(jì)數(shù)。

Done()用來(lái)在操作結(jié)束時(shí)調(diào)用，使計(jì)數(shù)減一。

Wait()用來(lái)等待所有的操作結(jié)束，即計(jì)數(shù)變?yōu)?，該函數(shù)會(huì)在計(jì)數(shù)不為0時(shí)等待，在計(jì)數(shù)為0時(shí)立即返回。

package main
import (
    "fmt"
    "sync"
)
func main() {
    var wg sync.WaitGroup
    wg.Add(2) // 因?yàn)橛袃蓚€(gè)動(dòng)作，所以增加2個(gè)計(jì)數(shù)
    go func() {
        fmt.Println("Goroutine 1")
        wg.Done() // 操作完成，減少一個(gè)計(jì)數(shù)
    }()
    go func() {
        fmt.Println("Goroutine 2")
        wg.Done() // 操作完成，減少一個(gè)計(jì)數(shù)
    }()
    wg.Wait() // 等待，直到計(jì)數(shù)為0
}

可見用sync.WaitGroup是最簡(jiǎn)單的方式。

補(bǔ)充：Golang 中使用WaitGroup的那點(diǎn)坑

sync.WaitGroup對(duì)于Golang開發(fā)者來(lái)說(shuō)并不陌生，其經(jīng)常作為多協(xié)程之間同步的一種機(jī)制。用好它勢(shì)必會(huì)讓你事半功倍，但是一旦錯(cuò)用將引發(fā)問(wèn)題。

關(guān)于WaitGroup的使用網(wǎng)上有很多例子，在此就不做介紹了，我想說(shuō)的是我在項(xiàng)目中使用WaitGroup遇到的坑。

在項(xiàng)目中，因?yàn)榉?wù)器有同步需求，所以直接使用了WaitGroup，但是未考慮使用場(chǎng)景，結(jié)果在項(xiàng)目上線之后，高峰期的時(shí)候客戶端經(jīng)常出現(xiàn)卡頓，經(jīng)過(guò)多方查找，才發(fā)現(xiàn)如果使用WaitGroup的時(shí)候，未啟動(dòng)單獨(dú)的goroutine，那么極有可能造成主線程的阻塞，

所以我做了下面的測(cè)試(測(cè)試中，我把WaitGroup置于協(xié)程內(nèi))：

import (
 "fmt"
 "sync"
 "time"
)
 
func main() {
    fmt.Println("main-1")
 testW()
 fmt.Println("main-2")
 time.Sleep(time.Duration(15) * time.Second) 
}
 
func testW() {
 fmt.Println("testW-1")
 go func() {
  var wg sync.WaitGroup
  fmt.Println("testW-2")
  testW1(&wg)
  fmt.Println("testW-5")
  wg.Wait()
  fmt.Println("testW-6")
 }()
}
 
func testW1(wg *sync.WaitGroup) {
 wg.Add(1)
 fmt.Println("testW-3")
 time.AfterFunc(time.Second*5, func() {
  wg.Done()
 })
 fmt.Println("testW-4") 
}

輸出為：