Golang基于sync.Once实现单例的操作示例

文章介绍了如何在Go中使用sync.Once包来实现单例模式,确保对象的唯一初始化,并且是线程安全的。通过once.Do()函数,即使在并发环境下,也只会执行一次初始化代码,其他尝试初始化的协程会被阻塞,直到初始化完成。同时,文章提到了单例模式的应用场景和限制,比如无法阻止外部通过new()创建对象,但所有对公共方法Conn()的调用都将由单例对象处理。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

导读这篇文章主要介绍了golang实现单例的操作代码,本文介绍基于sync.Once的方式来实现单例,熟练掌握这种模式,并理解其底层原理,对大部分人来讲已经完全够用了,需要的朋友可以参考下

在go里实现单例模式有多种方式:

  • 基于lock
  • 基于init函数
  • 基于sync.Once

本文介绍基于sync.Once的方式来实现单例,熟练掌握这种模式,并理解其底层原理,对大部分人来讲已经完全够用了。

基于sync.Once实现单例

// 其他package也可见,在其他地方也可以new新对象
// 但是最终调用Conn()方法时,都是用的single这个单例
// 1
type Driver struct {
    // 小写字母开头,外部不可访问,所以new个Driver新对象也没用
    // 2
    conn string
}
 
// 全局变量,指针默认值为nil
// 3
var single *Driver // 单例
var once sync.Once
 
// 对外暴露的公共方法
func (s *Driver) Conn() {
    fmt.Printf("conn=%s", single.conn) // do something
}
 
// 4
func GetDriverSingleton() *Driver {
    // 对GetDriverSingleton()方法的调用,都会执行once.Do()方法,只不过参数func()只会被执行一次
    // 若并发执行once.Do(),多个协程会阻塞,因内部是通过Mutex来控制
    once.Do(func() {
        single = new(Driver)
        single.conn = "single conn"
        time.Sleep(50 * time.Millisecond)
    })
    return single
}

单例类型定义Driver

Driver类的方法要支持跨包访问,因此需要以大写字母开头。
小写字母开头,作用域仅限于包内部。

类Field conn

类变量conn需要小写字母开头,跨包不可访问,避免在包外被修改。

但是包内还是有可能被修改。

once.Do(func() {})

每次调用GetDriverSingleton(),都会调用once.Do()方法,但是在once.Do()方法内部,仅会执行一次参数func(){},因此就保证了单例唯一初始化。

并发访问once.Do()

不会有并发访问问题,因once.Do()内部通过mutex来控制。

// once.DO()
if atomic.LoadUint32(&o.done) == 0 {
    // Outlined slow-path to allow inlining of the fast-path.
    o.doSlow(f)
}
 
// doSlow()
func (o *Once) doSlow(f func()) {
    o.m.Lock() // 互斥锁
    defer o.m.Unlock()
    if o.done == 0 {
        defer atomic.StoreUint32(&o.done, 1)
        f()
    }
}

对外暴露方法Conn()

外部对Conn()方法的调用,最终都由单例single来实现。

重新new(Driver)会发生什么?

很遗憾,无法将构造函数改成private,也就是说,在包外部是可以通过new(Driver)来创建新的对象。

但无论是哪个对象,对公开方法Conn()的调用,最终都是由单例single来执行的。

到此这篇关于golang实现单例的操作代码的文章就介绍到这了www.linuxprobe.com

<think>嗯,用户问的是Go语言中的sync.Once怎么使用。我需要先回忆一下sync.Once的基本概念和用途。记得sync.Once是用来确保某个操作只执行一次,不管有多少个goroutine调用它。这在单例模式或者初始化配置时很有用。 首先,我应该解释一下sync.Once的作用,让用户明白为什么需要这个结构。然后,可能需要举一个子,说明如何声明和使用它。比如,用Do方法包裹初始化函数,确保只运行一次。 然后,用户可能想知道具体的用法步骤,比如声明一个sync.Once变量,然后在需要的地方调用Do方法,传入要执行的函数。需要注意的是,传入的函数不能带参数,所以如果有参数的话,可能需要用闭包或者封装一下。 接下来,应该举一个实际的代码示例,展示如何在实际中使用sync.Once。比如初始化一个数据库连接或者配置文件,确保多个goroutine同时调用时,初始化只执行一次。这时候,可能需要用一些变量来存储初始化后的结果,比如全局变量或者结构体中的字段。 另外,需要提醒用户一些注意事项,比如传入的函数如果有不同的逻辑,可能会导致多次执行,因为sync.Once是根据实来判断的。所以每个不同的操作需要独的sync.Once。另外,错误处理的问题,如果在Do中的函数执行失败,再次调用Do时不会重试,所以需要内部处理错误,或者记录错误状态。 可能还需要提到sync.Once的内部实现原理,比如使用原子操作和互斥锁来保证并发安全,这样用户能更好地理解其高效性。但不需要太深入,点到为止即可。 用户可能会有疑问,如果有多个不同的初始化函数,应该怎么处理。这时候需要说明每个初始化函数都需要自己的sync.Once。比如,初始化配置和初始化数据库连接应该分别使用不同的sync.Once变量。 另外,错误处理是一个重要的点,如果在Do里面的函数返回了错误,用户可能想知道怎么处理这种情况。这时候应该建议在函数内部处理错误,或者设置一个全局的错误变量,在调用Do之后检查是否有错误发生。 总结一下,回答的结构应该是先介绍用途,然后基本用法,接着代码示例,再是注意事项,最后可能加上内部原理的简要说明。这样用户能够逐步理解并正确使用sync.Once。</think>### 一、sync.Once 的作用 `sync.Once` 是 Go 语言标准库中用于 **保证某个操作仅执行一次** 的并发安全工具。典型场景包括: - 单例模式(如数据库连接池初始化) - 延迟初始化(按需加载配置) - 避免重复计算 --- ### 二、基础用法 #### 1. 声明与调用 ```go var once sync.Once // 需要保证只执行一次的函数 initFunc := func() { fmt.Println("This runs only once") } // 在多个 goroutine 中调用 once.Do(initFunc) ``` #### 2. 完整示例 ```go package main import ( "fmt" "sync" ) var ( config map[string]string once sync.Once ) func loadConfig() { fmt.Println("Loading config...") config = map[string]string{"env": "prod", "timeout": "30s"} } func GetConfig() map[string]string { once.Do(loadConfig) // 并发安全初始化 return config } func main() { // 启动多个 goroutine 测试 var wg sync.WaitGroup for i := 0; i < 5; i++ { wg.Add(1) go func() { defer wg.Done() fmt.Println(GetConfig()) // 只有第一次会触发 loadConfig() }() } wg.Wait() } ``` 输出: ``` Loading config... map[env:prod timeout:30s] map[env:prod timeout:30s] map[env:prod timeout:30s] map[env:prod timeout:30s] map[env:prod timeout:30s] ``` --- ### 三、关键注意事项 #### 1. 函数无参数 通过闭包解决参数传递问题: ```go var ( dbConn string dbOnce sync.Once ) func InitDB(host string) { dbOnce.Do(func() { // 使用闭包传递参数 dbConn = fmt.Sprintf("connect to %s", host) }) } ``` #### 2. 错误处理 若初始化可能出错,建议内部记录错误状态: ```go var ( cache map[string]int once sync.Once initErr error ) func initCache() { defer func() { if r := recover(); r != nil { initErr = fmt.Errorf("init failed: %v", r) } }() // 可能出错的操作 cache = make(map[string]int) cache["key"] = 1 / 0 // 模拟 panic } func GetCache() (map[string]int, error) { once.Do(initCache) return cache, initErr } ``` #### 3. 不同操作需独立实 ```go var ( onceA sync.Once onceB sync.Once ) func InitA() { onceA.Do(/* ... */) } func InitB() { onceB.Do(/* ... */) } // 需使用不同的 Once ``` --- ### 四、实现原理 `sync.Once` 通过 `uint32` 原子标志位 + 互斥锁实现: 1. 原子操作检查标志位 `done` 2. 首次执行时加锁运行函数 3. 后续调用直接返回 源码关键片段: ```go 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() } } ``` --- ### 五、典型应用场景 1. 全局配置加载 2. 数据库连接池初始化 3. 文件系统次检查 4. 日志处理器设置 --- ### 六、性能建议 - 高频调用场景下性能优异(原子操作消耗极小) - 避免在 `Do` 中执行耗时操作(会阻塞后续调用) - 对需要重置的场景,建议重新创建实而非修改 `done` 标志
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值