golang 系列：sync.Once 讲解

sync.Once 介绍

之前提到过 Go 的并发辅助对象：WaitGroup。同样的， sync.Once 也是 Go 官方的一并发辅助对象，它能够让函数方法只执行一次，达到类似 init 函数的效果。我们来看看它的简单用法：

func main() {
    var once sync.Once
    onceFunc := func() {
        fmt.Println("Only once")
    }

    for i := 0; i < 10; i++ {
        once.Do(onceFunc)
    }
}

这里执行后我们将只看到一次 Only once 的打印信息，这就是 sync.Once 的一次性效果。

sync.Once 源码

我们来看下 sync.Once 的源码：

type Once struct {
    done uint32
    m    Mutex
}

func (o *Once) Do(f func()) {
    // 原子加载标识值，判断是否已被执行过
    if atomic.LoadUint32(&o.done) == 0 {
        o.doSlow(f)
    }
}

func (o *Once) doSlow(f func()) { // 还没执行过函数
    o.m.Lock()
    defer o.m.Unlock()
    if o.done == 0 { // 再次判断下是否已被执行过函数
        defer atomic.StoreUint32(&o.done, 1) // 原子操作：修改标识值
        f() // 执行函数
    }
}

从上面可以分析出，sync.Once 是通过对一个标识值，原子性的修改和加载，来减少锁竞争的。