如何实现一个sync.Once

sync.Once 是 golang里用来实现单例的同步原语。Once 常常用来初始化单例资源,
或者并发访问只需初始化一次的共享资源,或者在测试的时候初始化一次测试资源。
单例,就是某个资源或者对象,只能初始化一次,类似全局唯一的变量。
一般都认为只要使用一个flag标记即可,然后使用原子操作这个flag,代码如下:

type XOnce struct {
	done uint32
}

func (x *XOnce) Do(f func()) {
	if atomic.CompareAndSwapUint32(&x.done, 0, 1)  {
		f()
	}
}

这种方式有很大的问题,就是如果参数f执行很慢,其他调用Do方法的goroutine,
虽然看到done已经设置过值,标记为已执行过,但是初始化资源的函数并未执行完,
在获取初始化资源的时候,可能会得到空的资源或者发生空指针的panic。

来看下go源码中是如何解决这个问题的。

type Once struct {
	m    sync.Mutex
	done uint32
}

func (x *Once) Do(f func()) {
	if atomic.LoadUint32(&x.done) == 0 {
		x.doSlow(f)
	}
}

func (x *Once) doSlow(f func()) {
	x.m.Lock()
	defer x.m.Unlock()

	if x.done == 0 {
		defer atomic.StoreUint32(&x.done, 1)
		f()
	}
}

Once类中有一个互斥锁和一个done标记。
用并发场景来校验一下,假设有两个goroutine同时调用Do方法,并进入doSlow,此时互斥锁的机制保证只有一个g能执行f。
同时利用双检查机制,再次判断x.done是否为,如果是0,则是第一次执行,执行完毕后,将x.done置为1,最后释放锁。
即时第二个g被唤醒了,但是由于此时的x.done==1,也就不会在执行f了。

双检查机制:既保证了并发的goroutine会等待f完成,而且还不会多次执行f

posted @ 2023-05-05 18:08  JonPan  阅读(206)  评论(0编辑  收藏  举报