Golang 设计模式之单例模式

单例模式是我们常用的一种设计模式之一，其核心目的是确保一个类只有一个实例，并提供一个全局访问点。单例模式在很多情况下都非常有用，比如配置管理器、连接池、线程池等，这些场景中通常只需要一个实例来协调资源。

单例模式概述

单例模式定义为一个全局访问点，通过它来获取类的唯一实例。它在控制资源访问、减少系统资源消耗等方面发挥着重要作用。

Golang实现单例模式

在Golang中，实现单例模式很简单，使用 sync.Once 可以快速创建单例。
sync.Once是什么？sync.Once是一个同步原语，它的主要用途是确保某个操作只执行一次。它的主要方法是 Do(f func())，当调用这个方法时，会执行传入的函数 f，但是无论调用多少次 Do 方法，函数 f 都只会被执行一次。

代码如下：

import (
    "sync"
)

type ConfigModel struct {
}

var (
	instance ConfigModel
	confOnce     sync.Once
)

func NewConfig() ConfigModel {
	confOnce.Do(func() {
		instance = &ConfigModel{}
	})

	return instance
}

func (c *ConfigModel) GetValue() string {
	return "test"
}

创建单例使用了 sync.Once 是否还有必要判断 xxx == ni？

有这个疑问是因为在网上还有不少使用 sync.Once 创建单例的例子，里面还判断了 xxx == ni 。

这里随便从网上一个例子。

声明：这个纯粹只做技术探讨。

import (
	"fmt"
	"sync"
)
 
type IPhone struct {
	Version int
}
 
var iphone *IPhone
var once sync.Once
 
func GetInstance() *IPhone {
	if iphone == nil {
		once.Do(func() {
			iphone = &IPhone{Version: 13}
			fmt.Printf("初始化iphone指针：%p \n", iphone)
		})
	}
 
	return iphone
}

这个判断是否还有必要呢？其实没这个必要了。我们直接来看看 Golang 中 sync.Once 的实现方式：

文章编写时候golang版本 1.22.0，源码见：sync/once.go#L63

func (o *Once) Do(f func()) {
	if o.done.Load() == 0 {
		o.doSlow(f)
	}
}

func (o *Once) doSlow(f func()) {
	o.m.Lock()
	defer o.m.Unlock()
	if o.done.Load() == 0 {
		defer o.done.Store(1)
		f()
	}
}

代码使用 atomic.Uint32 这个原子操作函数，维护了一个计数。

1. 当计数是0的时候，才会执行函数
2. 使用了 defer 来延迟设置计数器，当函数执行完后，就会执行 defer 中的函数，把原子计数器设置为1

所以结论不需要判断 == nil 了。多次调用并不会重复执行闭包中的函数。