once.md

sync 包: Once

[TOC]

sync.Once 用来保证绝对一次执行的对象，例如可在单例的初始化中使用。

它内部的结构也相对简单：

// Once 对象可以保证一个动作的绝对一次执行。
type Once struct {
	m    Mutex
	done uint32
}

源码也非常简单：

// Do 当且仅当第一次调用时，f 会被执行。换句话说，给定
// 	var once Once
// 如果 once.Do(f) 被多次调用则只有第一次会调用 f，即使每次提供的 f 不同。
// 每次执行必须新建一个 Once 实例。
//
// Do 用于变量的一次初始化，由于 f 是无参数的，因此有必要使用函数字面量来捕获参数：
// 	config.once.Do(func() { config.init(filename) })
//
// 因为该调用无返回值，因此如果 f 调用了 Do，则会导致死锁。
//
// 如果 f 发生 panic，则 Do 认为 f 已经返回；之后的调用也不会调用 f。
//
func (o *Once) Do(f func()) {
	// 原子读取 Once 内部的 done 属性，是否为 1，是则立即返回，不产生 f 调用
	if atomic.LoadUint32(&o.done) == 1 {
		return
	}
	// 注意，我们只使用原子读读取了 o.done 的值，这是 fast path 的情况。
	// 但当我们需要确保在并发状态下，是不是有多个人读到 0，因此必须加锁，即 slow-path
	o.m.Lock()
	defer o.m.Unlock()

	// 正好我们有一个并发的 goroutine 读到了 0，那么立即执行 f 并在结束时候调用原子写，将 o.done 修改为 1
	if o.done == 0 {
		defer atomic.StoreUint32(&o.done, 1)
		f()
	}
	// 当 o.done 为 0 的 goroutine 解锁后，其他人会继续加锁，这时会发现 o.done 已经为了 1 ，于是 f 已经不用在继续执行了
}

许可

Go under the hood | CC-BY-NC-ND 4.0 & MIT © changkun