Что делает метод Add?

Метод Add в языке Go

Метод Add — это один из ключевых методов типа sync.WaitGroup, предназначенного для синхронизации горутин в Go. Его основная задача — увеличить внутренний счётчик WaitGroup на указанное значение, что сигнализирует о запуске новых горутин, которые необходимо дождаться.

Основное назначение метода Add

Add выполняет следующие функции:

• Увеличивает счётчик ожидания на заданное положительное число (обычно на 1 при запуске каждой горутины).
• Может уменьшать счётчик, если передать отрицательное значение (например, для коррекции логики, но это редко используется).
• Синхронизирует операции с методами Done и Wait, обеспечивая безопасность в конкурентной среде.

Пример использования

В типичном сценарии Add вызывается перед запуском горутины, чтобы указать, что мы планируем дождаться её завершения. Например:

package main

import (
    "fmt"
    "sync"
)

func worker(id int, wg *sync.WaitGroup) {
    defer wg.Done() // Уменьшаем счётчик при завершении горутины
    fmt.Printf("Worker %d started\n", id)
    // Имитация работы
    fmt.Printf("Worker %d finished\n", id)
}

func main() {
    var wg sync.WaitGroup
    numWorkers := 3

    for i := 1; i <= numWorkers; i++ {
        wg.Add(1) // Увеличиваем счётчик перед запуском каждой горутины
        go worker(i, &wg)
    }

    wg.Wait() // Ожидаем завершения всех горутин
    fmt.Println("All workers completed")
}

Важные особенности

• Вызов Add должен происходить до запуска горутины. Если вызвать Add после go worker(), возможен гонок (race condition), так как горутина может завершиться раньше, чем счётчик будет увеличен.
• Можно вызывать Add несколько раз, в том числе с большими значениями, если количество горутин известно заранее. Например:

  wg.Add(numWorkers) // Увеличиваем счётчик сразу на количество горутин
  for i := 0; i < numWorkers; i++ {
      go worker(i, &wg)
  }
  

• Add безопасен для конкурентного вызова, так как sync.WaitGroup использует атомарные операции для изменения счётчика.
• Передача отрицательного значения позволяет уменьшить счётчик, но это требует осторожности: если счётчик станет отрицательным, произойдёт паника (panic).

Внутренняя реализация

Add работает с атомарным счётчиком внутри WaitGroup. В упрощённом виде (реальная реализация сложнее и оптимизирована):

// Псевдокод для иллюстрации
func (wg *WaitGroup) Add(delta int) {
    // Атомарно добавляем delta к внутреннему счётчику
    // Если счётчик становится отрицательным — panic
    // Если счётчик становится нулём, разблокировываются все ждущие в Wait()
}

Распространённые ошибки

1. Вызов Add внутри горутины — может привести к тому, что Wait завершится раньше, чем счётчик увеличится.
2. Несоответствие числа вызовов Add и Done — если Done вызывается больше раз, счётчик станет отрицательным и программа упадёт с паникой.
3. Использование Add(0) — иногда применяется для проверки состояния, но это редкий кейс.

Заключение

Add — это критически важный метод для управления жизненным циклом горутин через sync.WaitGroup. Он обеспечивает предсказуемую синхронизацию, позволяя главной горутине дождаться завершения всех зависимых задач. Правильное использование Add (вместе с Done и Wait) является фундаментом для написания безопасных конкурентных программ на Go.