golang学习笔记之—WaitGroup

自己毕业工作过后，由于时间有限，一度中断了写学习笔记。
最近心血来潮，逛CSDN发现博客已经改版了，添加了对Markdown语法的支持。加之最近在学习google的go语言，因此想借写博客的机会学习Markdown语言，同时梳理所学的go语言知识。

本文主要讲解go标准库sync中的WaitGroup的用法。

WaitGroup的作用

WaitGroup用于goroutine的同步，当需要阻塞当前执行线程，等待一组goroutine执行完毕之后再继续执行当前线程时，就需要用到WaitGroup。

WaitGroup的定义

type WaitGroup struct {
    state1 [12]byte
    sema   uint32
}

WaitGroup的定义比较简单，由一个12字节额 state1 字段和一个32位的 sema 组成。

WaitGroup的API

1.Add(delta int)

Add的原型声明如下：

func (wg *WaitGroup) Add(delta int)

Add函数接受一个int型的参数delta，用于设置WaitGroup实例(wg)的计数器，当计数器变为0时，所有因为在该wg上调用Wait而阻塞的goroutine的都会被唤醒。

若调用Add导致计数器变为负数，会引起panic。

2.Done()

Done的原型声明如下：

func (wg *WaitGroup) Done()

Done函数的作用很简单，就是将wg的计数器减一。该函数等同于wg.Add(-1)，从go的源码中可以看到Done()就是用wg.Add(-1)实现的。

// Done decrements the WaitGroup counter.
func (wg *WaitGroup) Done() {
    wg.Add(-1)
}

3.Wait()

Wait的原型声明如下：

func (wg *WaitGroup) Wait()

Wait会阻塞调用该函数的goroutine，直到wg的计数器变为1。

WaitGroup的用法

package main

import (
    "fmt"
    "sync"
)

func main() {
    var wg sync.WaitGroup

    for i := 0; i < 10; i++ {
        wg.Add(1)
        go func(i int){
            fmt.Println("Hello world",i)
            wg.Done()
        }(i)
    }
    wg.Wait()
}

该程序启动了十个goroutine，并在main函数中使用wg.Wait等待这些goroutine执行结束。该程序的输出如下：

Hello world 9
Hello world 2
Hello world 3
Hello world 4
Hello world 5
Hello world 6
Hello world 7
Hello world 0
Hello world 8
Hello world 1

若去掉示例代码中wg的使用，则不会输出任何信息，因为main函数在goroutine执行之前就结束了。