一文看懂golang的sync包

一文看懂golang的sync包

sync包里包含的struct以及其功能

  • sync.Mutex: 互斥量(锁)，主要是处理多个goroutine竞争同一个资源时候的同步问题。
  • sync.RWMutex: 读写互斥量(锁)，相对Mutex而言能进行更细腻的控制，主要用在读多写少的情景下。
  • sync.WaitGroup: WaitGroup用于等待一组goroutine结束。
  • sync.Cond:实现一个条件变量，即等待或宣布事件发生的goroutines的会合点。
  • sync.Pool:临时对象池，作为临时对象的保存和复用的集合。
  • sync.Once:顾名思义，Once可以使得函数的调用只执行一次。

具体解释和示例

  • Mutex 主要处理多个goroutine竞争同一个资源时的同步问题，能保证同时只有一个goroutine在使用该资源，而其他的goroutine则在等待，直到占用资源的goroutine释放了Mutex，即是调用了mutex.Unlock()
    示例：
package main

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

func main() {
    ch := make(chan struct{}, 2)

    var l sync.Mutex
    go func() {
        l.Lock()
        defer l.Unlock()
        fmt.Println("goroutine1: lock 2 seconds")
        time.Sleep(time.Second * 2)
        fmt.Println("goroutine1: unlocked")
        ch <- struct{}{}
    }()

    go func() {
        fmt.Println("goroutine2: wait for unlock")
        l.Lock()
        defer l.Unlock()
        fmt.Println("goroutine2: lock 2 seconds")
        ch <- struct{}{}
    }()

    for i:=0;i<2;i++ {
        <- ch
    }
}

执行结果

$ go run main.go
goroutine2: wait for unlock
goroutine1: lock 2 seconds
goroutine1: unlocked
goroutine2: lock 2 seconds

从结果可以看到goroutine2在调用l.Lock()时阻塞了，一直等待goroutine1，直到在goroutine1里调用了l.Unlock()。

  • RWMutex 则可以对锁进行更精细的控制，主要的规则如下：
    • 读锁之间是不互斥的
    • 读锁和写锁互斥
    • 写锁和写锁互斥
      也就意味着同时只有一个goroutine能获得写锁定，当它获得了写锁定了，其他的goroutine，无论是写锁定还是读锁定，都无法获得。而可以同时有一个或多个goroutine获得读锁定，这时其他的goroutine无法获得写锁定。
      示例如下：
package main

import (
    "fmt"
    "math/rand"
    "sync"
    "time"
)

var count int
var rw sync.RWMutex

func main() {
    ch := make(chan struct{}, 10)
    for i:=0;i<5;i++ {
        go read(i, ch)
    }
    
    for i:=0;i<5;i++ {
        <- ch
    }
}

func read(i int, ch chan struct{}) {
    rw.RLock()
    fmt.Printf("goroutine %d 进入读操作\n", i)
    v := count
    time.Sleep(time.Second * 1)
    fmt.Printf("goroutine %d 读取结束，值为:%d\n", i, v)
    rw.RUnlock()
    ch <- struct{}{}
}

示例输出为：

goroutine 4 进入读操作
goroutine 1 进入读操作
goroutine 0 进入读操作
goroutine 2 进入读操作
goroutine 3 进入读操作
goroutine 1 读取结束，值为:0
goroutine 4 读取结束，值为:0
goroutine 3 读取结束，值为:0
goroutine 2 读取结束，值为:0
goroutine 0 读取结束，值为:0

可以看到5个goroutine可以同时进入读操作，而不会有任何的goroutine会阻塞。

对上面的例子稍作调整：

package main

import (
    "fmt"
    "math/rand"
    "sync"
    "time"
)

var count int
var rw sync.RWMutex

func main() {
    ch := make(chan struct{}, 10)
    for i:=0;i<5;i++ {
        go read(i, ch)
    }

    go write(ch)

    for i:=0;i<6;i++ {
        <- ch
    }
}

func read(i int, ch chan struct{}) {
    rw.RLock()
    fmt.Printf("goroutine %d 进入读操作\n", i)
    v := count
    time.Sleep(time.Second * 1)
    fmt.Printf("goroutine %d 读取结束，值为:%d\n", i, v)
    rw.RUnlock()
    ch <- struct{}{}
}

func write(ch chan struct{}) {
    rw.Lock()
    fmt.Printf("goroutine write 进入写操作\n")
    v := rand.Intn(1000)
    count = v
    fmt.Printf("goroutine write 写入结束，新值为:%d\n", count)
    rw.Unlock()
    ch <- struct{}{}
}

加入写锁，输出如下(因为多线程的原因，结果不唯一)：

goroutine 1 进入读操作
goroutine 0 进入读操作
goroutine 1 读取结束，值为:0
goroutine 0 读取结束，值为:0
goroutine write 进入写操作
goroutine write 写入结束，新值为:81
goroutine 2 进入读操作
goroutine 3 进入读操作
goroutine 4 进入读操作
goroutine 2 读取结束，值为:81
goroutine 4 读取结束，值为:81
goroutine 3 读取结束，值为:81

可以看到加入了写锁之后，2,3,4这三个goroutine都必须等到goroutine write写入结束才能进入读操作。而0，1这两个goroutine这两个读操作完成之后，才能进入写goroutine。也就说明读写之间是互斥的，而多个读之间是不互斥的。

  • sync.WaitGroup 主要用于等待一组goroutine结束。一般用于控制主线程等待所有的goroutine都结束之后再结束。
    示例如下：
package main

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

func main() {
    wg := sync.WaitGroup{}

    for i:=0;i<5;i++{
        wg.Add(1)
        go func(i int) {
            defer wg.Done()
            fmt.Printf("goroutine %d starts sleep\n", i)
            time.Sleep(time.Second * time.Duration(i))
            fmt.Printf("goroutine %d finished sleep\n", i)
        }(i)
    }
    fmt.Println("wait group waiting...")
    wg.Wait()
    fmt.Println("wait group waitint finished")
}

输出如下：

wait group waiting...
goroutine 1 starts sleep
goroutine 3 starts sleep
goroutine 4 starts sleep
goroutine 0 starts sleep
goroutine 0 finished sleep
goroutine 2 starts sleep
goroutine 1 finished sleep
goroutine 2 finished sleep
goroutine 3 finished sleep
goroutine 4 finished sleep
wait group waitint finished

可以看到wg.Wait()这一句阻塞住了主线程，直到所有的goroutine结束之后，这里才不再阻塞。

  • Once 相对而言是比较简单的，就是控制让某个函数仅仅执行一次，后面无论怎么调用，都不会再执行了。
    示例如下：
package main

import (
    "fmt"
    "sync"
)

func onceFunc(i int) {
    fmt.Printf("goroutine %d run", i)
}

func main() {
    ch := make(chan struct{}, 10)
    var once sync.Once

    for i:=0;i<10;i++ {
        go func() {
            once.Do(func() {
                onceFunc(i)
            })
            ch <- struct{}{}
        }()
    }

    for i:=0;i<10;i++ {
        <- ch
    }
}

输出如下(多线程的原因，输出结果不唯一)：

goroutine 3 run

可以看到尽管我们在代码里调用了10次，但是实际上只会执行1次。

  • Cond 实现一个条件变量。代码示例如下：
package main

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

var count int = 4

func main() {
    ch := make(chan struct{}, 5)

    var l sync.Mutex
    cond := sync.NewCond(&l)

    for i:=0;i<5;i++ {
        go func(i int) {
            cond.L.Lock()
            defer func() {
                cond.L.Unlock()
                ch <- struct{}{}
            }()
            for count > i {
                cond.Wait()
                fmt.Printf("收到一个通知 goroutine%d\n", i)
            }
            fmt.Printf("goroutine%d 执行结束\n", i)
        }(i)
    }

    time.Sleep(time.Millisecond * 20)
    fmt.Println("broadcast...")
    cond.L.Lock()
    count -= 1
    cond.Broadcast()
    cond.L.Unlock()

    time.Sleep(time.Second * 1)
    fmt.Println("signal...")
    cond.L.Lock()
    count -= 2
    cond.Signal()
    cond.L.Unlock()

    time.Sleep(time.Second)
    fmt.Println("broadcast...")
    cond.L.Lock()
    count -= 1
    cond.Broadcast()
    cond.L.Unlock()

    for i:=0; i<5;i++{
        <- ch
    }
}

输出：

goroutine4 执行结束
broadcast...
收到一个通知 goroutine0
收到一个通知 goroutine3
goroutine3 执行结束
收到一个通知 goroutine2
收到一个通知 goroutine1
signal...
收到一个通知 goroutine0
broadcast...
收到一个通知 goroutine0
goroutine0 执行结束
收到一个通知 goroutine2
goroutine2 执行结束
收到一个通知 goroutine1
goroutine1 执行结束

可以看到cond主要是通过条件(count > i)和cond.Wait()函数来阻塞goroutine，而在外部修改了count之后，通过外部的Signal和Broadcast函数，通知到Lock了这个cond的goroutine，当条件满足时就不再阻塞了，而如果条件不满足，继续阻塞。

  • Pool主要用于存临时对象，具体细节，且听下回分解。
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 215,463评论 6赞 497
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 91,868评论 3赞 391
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 161,213评论 0赞 351
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 57,666评论 1赞 290
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 66,759评论 6赞 388
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 50,725评论 1赞 294
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,716评论 3赞 415
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 38,484评论 0赞 270
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,928评论 1赞 307
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,233评论 2赞 331
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,393评论 1赞 345
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 35,073评论 5赞 340
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,718评论 3赞 324
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,308评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,538评论 1赞 268
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 47,338评论 2赞 368
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 44,260评论 2赞 352