Go中sync.Once源码的深度讲解_Golang

概念

sync.once是go语言标准库中的一个同步原语，用于确保某个操作只执行一次。它在多线程环境中非常有用，尤其是在需要初始化共享资源或执行某些一次性任务时。

简单示例

当我们在web服务访问某个路由时，如果需要事先获取某些配置，往往会写一个loadconfig函数，获取一个cfg配置项。多次路由访问所需要获取的配置项通常是相同的，如果对于每次路由访问，都加载一次loadconfig函数，会导致产生一些不必要的开销。如果loadconfig涉及到读取文件、解析配置、网络请求时，有可能会额外增加的请求响应时间，降低服务的吞吐量。使用sync.once包提供的do函数，就可以只在第一次请求时调用loadconfig函数加载配置，之后的请求都复用第一次请求的配置，缩短响应时间。

package main

import (
    "log"
    "net/http"
    "sync"
)

type config struct {
    apikey   string
    loglevel string
}

var (
    config *config
    once   sync.once
)

func loadconfig() {
    // 模拟从文件或环境变量加载配置
    config = &config{
       apikey:   "secret-key",
       loglevel: "debug",
    }
    log.println("configuration loaded")
}

func getconfig() *config {
    once.do(loadconfig) // 仅第一次访问时会执行loadconfig函数
    return config
}

func handler(w http.responsewriter, r *http.request) {
    cfg := getconfig()
    log.printf("request handled with api key: %s", cfg.apikey)
    w.write([]byte("ok"))
}

func main() {
    http.handlefunc("/", handler)
    log.fatal(http.listenandserve(":8888", nil))
}

源码解读

源码文件：src/sync/once.go (go 1.23 版本)

package sync

import (
    "sync/atomic"
)

type once struct {
    done atomic.uint32 // 是否已执行标识位，0-未执行 1-已执行
    m    mutex         // 互斥锁，确保并发安全
}

func (o *once) do(f func()) {
    // 第一次执行do函数时，原子操作检查o.done==0,执行doslow函数后，o.done==1
    // 第二次及之后执行do函数,原子操作检查o.done标识位为1，do函数不执行任何功能，确保了f函数只在第一次被执行
    if o.done.load() == 0 {
       o.doslow(f) // 调用doslow函数执行f方法。第一次执行时，同一时间可能有多个goroutine尝试同时执行doslow函数
    }
}

func (o *once) doslow(f func()) {
    o.m.lock() // 加锁保护，避免多个goroutine同时绕过之前的原子操作检查，并发修改o.done的值
    defer o.m.unlock()
    // 二次检查o.done的值，同一时间并发执行doslow函数的goroutine,在第一个goroutine将o.done置为1并解除互斥锁后,
    // 剩下的goroutine识别到自身的o.done已经被设为1，无法绕过二次检查
    if o.done.load() == 0 { 
       defer o.done.store(1) // 需要在f()函数执行完成之后，原子性地将o.done设为1
       f() // 执行f方法，一定只有一个goroutine会调用这个方法
    }
}

可以看到，once.go文件的代码非常精炼。仅定义了一个含2个非导出字段done和m的结构体once，并提供了一个doslow方法用于执行f函数。当我们调用do方法时，程序经历了几个关键步骤:

判断done标志位是否等于0，如果是，说明f函数还没有被执行，执行doslow方法
mu互斥锁加锁，防止多个goroutine并发操作
double-check done标志位是否等于0，如果是，说明f函数还没有被执行，执行f函数
f函数执行完成之后，再将done标志位原子性设为1。使用原子操作是从内存可见性的角度出发，如果done使用uint32而不是atomic.uint32，done修改可能不会立即被其它goroutine感知，解锁后仍有可能存在goroutine的done等于0，重复执行f函数
mu互斥锁解锁。此时进入到doslow函数的其它goroutine也感知到了o.done等于1，不会重复执行f函数了