关于golang:golang-系列waitgroup-解析

Golang 提供了简洁的 go 关键字来让开发者更容易的进行并发编程，同时也提供了 WaitGroup 对象来辅助并发管制。明天咱们就来剖析下 WaitGroup 的应用办法，顺便瞧一瞧它的底层源码。

当咱们有很多工作要同时进行时，如果并不需要关怀各个工作的执行进度，那间接应用 go 关键字即可。

如果咱们须要关怀所有工作实现后能力往下运行时，则须要 WaitGroup 来阻塞期待这些并发工作了。

WaitGroup 如同它的字面意思，就是期待一组 goroutine 运行实现，次要有三个办法组成：

Add(delta int)：增加工作数
Wait()：阻塞期待所有工作的实现
Done()：实现工作

上面是它们的具体用法，具体的作用都在正文上：

package main

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

func worker(wg *sync.WaitGroup) {doSomething()
    wg.Done() // 2.1、实现工作}

func main() {
    var wg sync.WaitGroup
    wg.Add(5) // 1、增加 5 个工作
    for i := 1; i <= 5; i++ {go worker(&wg) // 2、每个工作并发执行
    }
    wg.Wait() // 3、阻塞期待所有工作实现}

下面 WaitGroup 的应用很简略，接下来咱们到 src/sync/waitgroup.go 里剖析下它的源码。首先，是 WaitGroup 的构造体：

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

其中，noCopy 示意 WaitGroup 是不可复制的。那么什么叫不可复制呢？

举个例子，当咱们对函数参数定义了这个不可复制的类型时，开发者只能通过指针来传递函数参数。而规定应用指针传递又有什么益处呢？

益处在于如果有多个函数都定义了这个不可复制的参数时，那么这多个函数参数就能够共用同一个指针变量，来同步执行后果。而 WaitGroup 就是须要这样的束缚规定。

接下来咱们来看看 WaitGroup 的 state1 字段。state1 是一个蕴含了 counter 总数、waiter 期待数、sema 信号量的 uint32 数组。

每当有 goroutine 调用了 Wait() 办法阻塞期待时，就会对 waiter 数量 + 1，而后期待信号量的唤起告诉。

当咱们调用 Add() 办法时，就会对 state1 的 counter 数量 + 1。

当调用 Done() 办法时就会对 counter 数量 -1。

直到 counter == 0 时就能够通过信号量唤起对应 waiter 数量的 goroutine 了，也就是唤起刚刚阻塞期待的 goroutine 们。

对于信号量的解释，能够参考下 golang 重要常识：mutex 里的相干介绍：

PV 原语解释：
通过操作信号量 S 来解决过程间的同步与互斥的问题。
S>0：示意有 S 个资源可用；S=0 示意无资源可用；S<0 绝对值示意期待队列或链表中的过程个数。信号量 S 的初值应大于等于 0。
P 原语：示意申请一个资源，对 S 原子性的减 1，若减 1 后仍 S>=0，则该过程继续执行；若减 1 后 S<0，示意已无资源可用，须要将本人阻塞起来，放到期待队列上。
V 原语：示意开释一个资源，对 S 原子性的加 1；若加 1 后 S>0，则该过程继续执行；若加 1 后 S<=0，示意期待队列上有期待过程，须要将第一个期待的过程唤醒。

此处 操作系统 能够了解为 Go 的 运行时 runtime，过程 能够了解为协程。

最初，咱们来深刻 WaitGroup 的三个办法，进行源码剖析。大家感兴趣的能够持续往下看，次要是对源码的剖析正文。

func (wg *WaitGroup) Add(delta int) {statep, semap := wg.state()
    if race.Enabled { // 此处是 go 的竞争检测，能够不必关怀
        _ = *statep
        if delta < 0 {race.ReleaseMerge(unsafe.Pointer(wg))
        }
        race.Disable()
        defer race.Enable()}
    state := atomic.AddUint64(statep, uint64(delta)<<32)
    v := int32(state >> 32) // 获取 counter
    w := uint32(state) // 获取 waiter
    if race.Enabled && delta > 0 && v == int32(delta) { // go 的竞争检测，能够不必关怀
        race.Read(unsafe.Pointer(semap))
    }
    if v < 0 {panic("sync: negative WaitGroup counter")
    }
    if w != 0 && delta > 0 && v == int32(delta) {panic("sync: WaitGroup misuse: Add called concurrently with Wait")
    }
    if v > 0 || w == 0 { // counter > 0：还有工作在执行；waiter == 0 示意没有在阻塞期待的 goroutine
        return
    }
    if *statep != state {panic("sync: WaitGroup misuse: Add called concurrently with Wait")
    }
    // 执行到此处相当于 countr = 0，即所有的工作都已执行完，须要唤起期待的 goroutine 了
    *statep = 0
    for ; w != 0; w-- {runtime_Semrelease(semap, false, 0)
    }
}

func (wg *WaitGroup) Done() {wg.Add(-1) // 间接调用 Add 办法 对 counter -1
}

func (wg *WaitGroup) Wait() {statep, semap := wg.state()
    if race.Enabled { // go 的竞争检测，能够不必关怀
        _ = *statep
        race.Disable()}
    for {state := atomic.LoadUint64(statep)
        v := int32(state >> 32)
        w := uint32(state)
        if v == 0 {
            // counter 为 0，不须要再期待了。if race.Enabled {race.Enable()
                race.Acquire(unsafe.Pointer(wg))
            }
            return
        }
        // waiters 数目 +1.
        if atomic.CompareAndSwapUint64(statep, state, state+1) {
            if race.Enabled && w == 0 {race.Write(unsafe.Pointer(semap)) // go 的竞争检测，能够不必关怀
            }
            runtime_Semacquire(semap) // 阻塞期待唤起
            if *statep != 0 {panic("sync: WaitGroup is reused before previous Wait has returned")
            }
            if race.Enabled {race.Enable()
                race.Acquire(unsafe.Pointer(wg))
            }
            return
        }
    }
}

从这几个办法的源码，咱们能够看出，Go 并没有应用 mutex 等锁去做字段值批改，而是采纳了 atomic 原子操作来进行批改的。这是在底层硬件上反对的，所以性能更好。

WaitGroup 比较简单，就是一些计数值的保护和 goroutine 的阻塞唤起。它的使用也简略，Add、Done、Wait 这三个办法常常是同时呈现的。置信大伙深刻到源码也能瞧出个大略，这里就献丑了㋛。

感兴趣的敌人能够搜一搜公众号「阅新技术」，关注更多的推送文章。
能够的话，就顺便点个赞、留个言、分享下，感激各位反对！
阅新技术，浏览更多的新常识。

关于golang:golang-系列waitgroup-解析

摘要

WaitGroup 的应用场景和办法

WaitGroup 源码剖析

noCopy

state1 字段

源码解释

Add(delta int) 办法

Done 办法

Wait 办法

总结