golang sync.Once 保证某个动作仅执行一次的机制

ercom2024-06-10 20:14

复制代码

type Once struct {
    done atomic.Uint32
    m Mutex
}

这段代码是 Go 语言标准库中 sync 包的一部分，定义了一个 Once 类型。

Once 类型用于确保某个函数只被执行一次。它包含一个 done 原子类型和一个 Mutex 互斥锁。

done 表示动作是否已经执行过，它被放置在结构体的最前面，因为它是热路径（频繁调用的代码路径）中使用的。

将 done 放在前面可以在一些架构上生成更紧凑的指令（如amd64/386），在其他架构上则可以减少计算偏移量的指令。

m 是一个互斥锁，用于保护 Once 的状态，确保在多线程环境下的一次性执行。

Once 的主要使用场景是初始化，可以避免在多个 goroutine 中对同一资源进行重复初始化。

它的方法 Do(f func()) 用于执行指定的函数f，且仅执行一次。

在 Do 方法中，会通过互斥锁保证并发安全，并使用原子操作来标记动作是否已完成，确保了动作的一次性执行。

总结来说，sync.Once 类型提供了一种保证某个动作仅执行一次的机制，常用于资源的初始化，以防止重复初始化的问题。