Go sync.Once: выполнить инициализацию один раз

Категория: Backend · Язык: Go · Обновлено:

sync.Once гарантирует, что функция выполнится ровно один раз, даже если её одновременно вызывают несколько горутин. Это стандартный способ ленивой инициализации конфигурации, пула соединений или кеша. Повторные вызовы Do просто ждут завершения первого и ничего не делают.

Инициализировать конфигурацию один раз

Go
package main

import (
    "fmt"
    "sync"
)

var (
    once   sync.Once
    config string
)

func loadConfig() {
    config = "loaded"
    fmt.Println("init")
}

func main() {
    var wg sync.WaitGroup
    for i := 0; i < 3; i++ {
        wg.Add(1)
        go func() {
            defer wg.Done()
            once.Do(loadConfig)
        }()
    }
    wg.Wait()
    fmt.Println(config)
}

Три горутины вызывают Do, но init печатается один раз. Остальные вызовы ждут, пока первая функция завершится, а затем возвращаются. sync.Once нельзя копировать после первого использования; храните его в структуре по указателю или как поле, которое не копируется.

Использовать OnceValue в Go 1.21+

Go
package main

import (
    "fmt"
    "sync"
)

var getConfig = sync.OnceValue(func() string {
    fmt.Println("init value")
    return "loaded"
})

func main() {
    fmt.Println(getConfig())
    fmt.Println(getConfig())
}

sync.OnceValue возвращает функцию, которая вычисляет значение один раз и кеширует его. sync.OnceFunc делает то же для функции без результата. Это короче ручного once.Do с переменной, но требует Go 1.21+.

Если функция в Do паникует, Once считает её выполненной и повторно не вызывает — ошибка не будет исправлена. Для инициализации с повтором используйте собственную блокировку и флаг либо возвращайте ошибку и обрабатывайте её на уровне приложения. Не вызывайте Do рекурсивно из той же функции: это приведёт к взаимной блокировке.

Не используйте Once для периодического обновления данных: он выполнится только раз. Для TTL-кеша нужен отдельный механизм. В тестах сбрасывайте состояние через новый экземпляр структуры, а не пытайтесь «переинициализировать» sync.Once.

Документация: sync.Once, sync.OnceValue.