Go sync.OnceValue 怎样安全共享一次计算结果

需要把一次初始化结果安全地交给多个 goroutine 时，可以让 sync.OnceValue 返回一个可重复调用的函数。第一次调用执行计算并保存结果，之后的调用直接共享这次结果；这个函数本身允许并发调用，因此不需要再手写“加锁、判断标记、保存值”的组合。

核心结论：把不需要自动刷新的计算放进同一个 OnceValue 闭包，始终调用同一个返回函数；如果计算可能返回错误，使用 sync.OnceValues 保存值和错误，而不是把错误吞掉。

官方资料：https://pkg.go.dev/sync#OnceValue

把一次计算封装成可复用函数

OnceValue 的签名可以理解为“传入 func() T，返回 func() T”。它适合配置快照、静态字典、首次解析和只需初始化一次的昂贵计算。注意闭包只创建一次，不能在每个请求里重新调用 sync.OnceValue，否则每个请求都会得到一套新的缓存。

package main

import (
	"fmt"
	"sync"
)

type Config struct {
	Endpoint string
}

func main() {
	loadConfig := sync.OnceValue(func() Config {
		// 这里模拟一次昂贵加载；真实项目可读取文件或环境配置。
		fmt.Println("load config once")
		return Config{Endpoint: "https://api.example.test"}
	})

	first := loadConfig()
	second := loadConfig()
	// 两次调用读取同一个计算结果，闭包不会重复执行加载函数。
	fmt.Println(first == second, second.Endpoint)
}

代码中的关键是保存 loadConfig，而不是只保存某一次调用的结果。函数可以传给其他组件，也可以被多个 goroutine 调用。若程序需要最低 Go 版本约束，应在模块的 go.mod 中声明不低于 1.21 的版本要求。

并发读取时只保留一条计算路径

并发场景下，多个 goroutine 可以同时调用同一个闭包。第一个进入计算阶段的调用负责生成结果，其他调用等待并读取完成后的值。这样做的实际收益是把“初始化动作”与“读取结果”合成了一个有明确边界的函数。

package cache

import (
	"sync"
	"sync/atomic"
)

var calls atomic.Int64

var shared = sync.OnceValue(func() []string {
	// 用计数观察初始化只发生一次；生产代码应返回真正的只读快照。
	calls.Add(1)
	return []string{"cn", "us"}
})

func Regions() []string {
	// 返回同一份快照；调用方不要修改切片内容。
	return shared()
}

如果返回的是切片、映射或指针，OnceValue 只负责“计算一次”，不负责保护结果对象后续的并发修改。常见做法是把结果当作只读快照，或在构造时复制出不会被外部写入的数据。

错误和 panic 要先定好语义

OnceValue 只有一个返回值。初始化可能失败时，推荐使用 sync.OnceValues 返回 (T, error)，这样错误也会和结果一起被缓存，所有调用者看到一致的初始化结论。

官方文档明确说明，计算函数 panic 时，返回函数后续调用仍会以同一个值 panic。这种行为能避免并发调用者看到互相矛盾的初始化状态，但也意味着不能指望下一次调用自动重试。若业务需要重试，应在外层定义明确的失败策略，并在合适时机创建新的闭包。

用场景表判断是否应该采用

OnceValue 适合生命周期与进程或组件一致的结果，不适合需要定时更新的配置或带租约的缓存。可以用下面的判断快速收敛设计：

• 一次性：证书解析、静态路由表、启动期配置快照可以使用。
• 可变数据：需要过期、刷新或按租户隔离时，不要把刷新逻辑藏进 OnceValue。
• 可修改返回值：返回切片或 map 时，限制写入权限，避免共享结果被调用方破坏。

相关问题

OnceValue 会不会每次调用都重新执行函数？

不会。返回函数只调用一次传入的计算函数，后续调用复用已保存的值；多个 goroutine 共享同一个返回函数时也遵循这个语义。

OnceValue 初始化失败后能自动重试吗？

不能把它当重试器。使用 OnceValues 时错误会随结果保存；需要重新尝试时，应在外层决定何时重建闭包。

返回切片后还能修改吗？

技术上可以，但修改共享切片会引入数据竞争或破坏其他调用者看到的快照。更稳妥的做法是返回只读约定的数据，或每次复制。

小结：sync.OnceValue 把并发安全的一次性计算封装成普通函数。正确用法是复用同一个闭包、把错误纳入返回值、把结果视为稳定快照，并把刷新和重试放在闭包生命周期之外。