這篇文章給大家介紹Golang中 WaitGroup的實(shí)現(xiàn)原理是什么，內(nèi)容非常詳細(xì)，感興趣的小伙伴們可以參考借鑒，希望對大家能有所幫助。

創(chuàng)新互聯(lián)主要從事成都網(wǎng)站設(shè)計(jì)、成都做網(wǎng)站、網(wǎng)頁設(shè)計(jì)、企業(yè)做網(wǎng)站、公司建網(wǎng)站等業(yè)務(wù)。立足成都服務(wù)揭東,十多年網(wǎng)站建設(shè)經(jīng)驗(yàn),價(jià)格優(yōu)惠、服務(wù)專業(yè),歡迎來電咨詢建站服務(wù):13518219792

1 前言

WaitGroup是Golang應(yīng)用開發(fā)過程中經(jīng)常使用的并發(fā)控制技術(shù)。

WaitGroup，可理解為Wait-Goroutine-Group，即等待一組goroutine結(jié)束。比如某個(gè)goroutine需要等待其他幾個(gè)goroutine全部完成，那么使用WaitGroup可以輕松實(shí)現(xiàn)。

package main

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

func main() {
    var wg sync.WaitGroup

    wg.Add(2) //設(shè)置計(jì)數(shù)器，數(shù)值即為goroutine的個(gè)數(shù)
    go func() {
        //Do some work
        time.Sleep(1*time.Second)

        fmt.Println("Goroutine 1 finished!")
        wg.Done() //goroutine執(zhí)行結(jié)束后將計(jì)數(shù)器減1
    }()

    go func() {
        //Do some work
        time.Sleep(2*time.Second)

        fmt.Println("Goroutine 2 finished!")
        wg.Done() //goroutine執(zhí)行結(jié)束后將計(jì)數(shù)器減1
    }()

    wg.Wait() //主goroutine阻塞等待計(jì)數(shù)器變?yōu)?
    fmt.Printf("All Goroutine finished!")
}

簡單的說，上面程序中wg內(nèi)部維護(hù)了一個(gè)計(jì)數(shù)器：

1. 啟動goroutine前將計(jì)數(shù)器通過Add(2)將計(jì)數(shù)器設(shè)置為待啟動的goroutine個(gè)數(shù)。

2. 啟動goroutine后，使用Wait()方法阻塞自己，等待計(jì)數(shù)器變?yōu)?。

3. 每個(gè)goroutine執(zhí)行結(jié)束通過Done()方法將計(jì)數(shù)器減1。

4. 計(jì)數(shù)器變?yōu)?后，阻塞的goroutine被喚醒。

其實(shí)WaitGroup也可以實(shí)現(xiàn)一組goroutine等待另一組goroutine，這有點(diǎn)像玩雜技，很容出錯(cuò)，如果不了解其實(shí)現(xiàn)原理更是如此。實(shí)際上，WaitGroup的實(shí)現(xiàn)源碼非常簡單。

2 基礎(chǔ)知識

2.1 信號量

信號量是Unix系統(tǒng)提供的一種保護(hù)共享資源的機(jī)制，用于防止多個(gè)線程同時(shí)訪問某個(gè)資源。

可簡單理解為信號量為一個(gè)數(shù)值：

• 當(dāng)信號量>0時(shí)，表示資源可用，獲取信號量時(shí)系統(tǒng)自動將信號量減1；

• 當(dāng)信號量==0時(shí)，表示資源暫不可用，獲取信號量時(shí)，當(dāng)前線程會進(jìn)入睡眠，當(dāng)信號量為正時(shí)被喚醒；

由于WaitGroup實(shí)現(xiàn)中也使用了信號量，在此做個(gè)簡單介紹。

3 WaitGroup

3.1 數(shù)據(jù)結(jié)構(gòu)

源碼包中src/sync/waitgroup.go:WaitGroup定義了其數(shù)據(jù)結(jié)構(gòu)：

type WaitGroup struct {
	state1 [3]uint32
}

state1是個(gè)長度為3的數(shù)組，其中包含了state和一個(gè)信號量，而state實(shí)際上是兩個(gè)計(jì)數(shù)器：

• counter： 當(dāng)前還未執(zhí)行結(jié)束的goroutine計(jì)數(shù)器

• waiter count: 等待goroutine-group結(jié)束的goroutine數(shù)量，即有多少個(gè)等候者

• semaphore: 信號量

考慮到字節(jié)是否對齊，三者出現(xiàn)的位置不同，為簡單起見，依照字節(jié)已對齊情況下，三者在內(nèi)存中的位置如下所示：

WaitGroup對外提供三個(gè)接口：

• Add(delta int): 將delta值加到counter中

• Wait()： waiter遞增1，并阻塞等待信號量semaphore

• Done()： counter遞減1，按照waiter數(shù)值釋放相應(yīng)次數(shù)信號量

下面分別介紹這三個(gè)函數(shù)的實(shí)現(xiàn)細(xì)節(jié)。

3.2 Add(delta int)

Add()做了兩件事，一是把delta值累加到counter中，因?yàn)閐elta可以為負(fù)值，也就是說counter有可能變成0或負(fù)值，所以第二件事就是當(dāng)counter值變?yōu)?時(shí)，跟據(jù)waiter數(shù)值釋放等量的信號量，把等待的goroutine全部喚醒，如果counter變?yōu)樨?fù)值，則panic.

Add()偽代碼如下：

func (wg *WaitGroup) Add(delta int) {
    statep, semap := wg.state() //獲取state和semaphore地址指針
    
    state := atomic.AddUint64(statep, uint64(delta)<<32) //把delta左移32位累加到state，即累加到counter中
    v := int32(state >> 32) //獲取counter值
    w := uint32(state)      //獲取waiter值
    
    if v < 0 {              //經(jīng)過累加后counter值變?yōu)樨?fù)值，panic
        panic("sync: negative WaitGroup counter")
    }

    //經(jīng)過累加后，此時(shí)，counter >= 0
    //如果counter為正，說明不需要釋放信號量，直接退出
    //如果waiter為零，說明沒有等待者，也不需要釋放信號量，直接退出
    if v > 0 || w == 0 {
        return
    }

    //此時(shí)，counter一定等于0，而waiter一定大于0（內(nèi)部維護(hù)waiter，不會出現(xiàn)小于0的情況），
    //先把counter置為0，再釋放waiter個(gè)數(shù)的信號量
    *statep = 0
    for ; w != 0; w-- {
        runtime_Semrelease(semap, false) //釋放信號量，執(zhí)行一次釋放一個(gè)，喚醒一個(gè)等待者
    }
}

3.3 Wait()

Wait()方法也做了兩件事，一是累加waiter, 二是阻塞等待信號量

func (wg *WaitGroup) Wait() {
    statep, semap := wg.state() //獲取state和semaphore地址指針
    for {
        state := atomic.LoadUint64(statep) //獲取state值
        v := int32(state >> 32)            //獲取counter值
        w := uint32(state)                 //獲取waiter值
        if v == 0 {                        //如果counter值為0，說明所有g(shù)oroutine都退出了，不需要待待，直接返回
            return
        }
        
        // 使用CAS（比較交換算法）累加waiter，累加可能會失敗，失敗后通過for loop下次重試
        if atomic.CompareAndSwapUint64(statep, state, state+1) {
            runtime_Semacquire(semap) //累加成功后，等待信號量喚醒自己
            return
        }
    }
}

這里用到了CAS算法保證有多個(gè)goroutine同時(shí)執(zhí)行Wait()時(shí)也能正確累加waiter。

3.4 Done()

Done()只做一件事，即把counter減1，我們知道Add()可以接受負(fù)值，所以Done實(shí)際上只是調(diào)用了Add(-1)。

源碼如下：

func (wg *WaitGroup) Done() {
	wg.Add(-1)
}

Done()的執(zhí)行邏輯就轉(zhuǎn)到了Add()，實(shí)際上也正是最后一個(gè)完成的goroutine把等待者喚醒的。

4 編程Tips

• Add()操作必須早于Wait(), 否則會panic

• Add()設(shè)置的值必須與實(shí)際等待的goroutine個(gè)數(shù)一致，否則會panic

關(guān)于Golang中 WaitGroup的實(shí)現(xiàn)原理是什么就分享到這里了，希望以上內(nèi)容可以對大家有一定的幫助，可以學(xué)到更多知識。如果覺得文章不錯(cuò)，可以把它分享出去讓更多的人看到。