Для чего нужно ключевое слово yield в C#? Как использовать yield return и yield break?

Что такое yield и зачем он нужен?

Ключевое слово yield в C# используется для создания итераторов. Оно позволяет методу возвращать элементы коллекции по одному, не загружая всю коллекцию в память сразу. Это реализация паттерна "ленивые вычисления" (lazy evaluation). Ваш пример с List<int> и пример с yield действительно дают одинаковый результат, но работают они принципиально по-разному.

Как это работает под капотом?

Когда вы пишете метод с yield return, компилятор C# генерирует специальный класс-состояние (state machine), который реализует интерфейс IEnumerable<T> и IEnumerator<T>. Этот класс хранит текущее состояние итерации. При каждом вызове MoveNext() (который неявно вызывается в цикле foreach) выполняется код метода до следующего yield return, и выполнение "замораживается" до следующего запроса.

Ключевое отличие: время выполнения

Рассмотрим два подхода на примере:

// Подход 1: Обычный список
static IEnumerable<int> GetNumbersList()
{
    var list = new List<int>();
    Console.WriteLine("Начинаем заполнять список...");
    for (int i = 0; i < 10; i++)
    {
        list.Add(i);
    }
    Console.WriteLine("Список готов!");
    return list;
}

// Подход 2: С yield
static IEnumerable<int> GetNumbersYield()
{
    Console.WriteLine("Начинаем итерацию...");
    for (int i = 0; i < 10; i++)
    {
        Console.WriteLine($"Генерируем число {i}");
        yield return i;
    }
    Console.WriteLine("Итерация завершена!");
}

Теперь посмотрим, что произойдет при вызове:

// Вариант со списком
var numbers1 = GetNumbersList();
// Вывод: "Начинаем заполнять список..." и "Список готов!" — сразу!
// Весь список уже в памяти.

// Вариант с yield
var numbers2 = GetNumbersYield();
// Вывод: НИЧЕГО! Код не выполнился, пока мы не начали перебор.
foreach (var num in numbers2)
{
    Console.WriteLine($"Получили: {num}");
}
// Вывод будет перемежаться: 
// "Начинаем итерацию...", "Генерируем число 0", "Получили: 0", "Генерируем число 1", ...

Когда использовать yield?

• Работа с большими данными: Если у вас есть файл на 10 ГБ, и вы читаете его построчно через yield return, вы не загружаете весь файл в память. Без yield пришлось бы сначала прочитать все строки в List<string>, что вызовет OutOfMemoryException.
• Бесконечные последовательности: Можно создать итератор, который генерирует числа Фибоначчи "до бесконечности" — потребитель сам решит, когда остановиться:

static IEnumerable<int> Fibonacci()
{
    int a = 0, b = 1;
    yield return a;
    yield return b;
    while (true)
    {
        int next = a + b;
        yield return next;
        a = b;
        b = next;
    }
}
// Использование: взять первые 10 чисел
foreach (var num in Fibonacci().Take(10)) { ... }

• Цепочки фильтрации: LINQ методы вроде Where() и Select() внутри используют yield, что позволяет обрабатывать данные "на лету":

// Без yield: сначала отфильтровать, потом выбрать — два списка
var result1 = bigList.Where(x => x > 5).Select(x => x * 2).ToList();

// С yield внутри: каждый элемент проходит через все стадии по одному
var result2 = bigList.Where(x => x > 5).Select(x => x * 2); // Ничего не выполняется!
// Только при foreach или .ToList() начнется обработка

Что делает yield break?

yield break досрочно завершает итерацию. Это аналог break в цикле, но для итератора. Пример:

static IEnumerable<int> GetNumbersUntilError(IEnumerable<int> source)
{
    foreach (var num in source)
    {
        if (num < 0)
            yield break; // Останавливаем итерацию при первом отрицательном числе
        yield return num;
    }
}

Важные ограничения

• Нельзя использовать yield в методах с модификаторами async (для асинхронных итераторов есть IAsyncEnumerable с await foreach).
• Нельзя использовать yield в блоках try-catch (можно только в try-finally).
• Метод с yield не может содержать обычный return (кроме yield break).

Таким образом, yield — это мощный инструмент для создания эффективных итераторов, которые экономят память и позволяют работать с потенциально бесконечными последовательностями данных.

class TreeNode<T>
{
    public T Value;
    public TreeNode<T> Left;
    public TreeNode<T> Right;

    public IEnumerable<T> InOrderTraversal()
    {
        if (Left != null)
            foreach (var v in Left.InOrderTraversal())
                yield return v;
        
        yield return Value;
        
        if (Right != null)
            foreach (var v in Right.InOrderTraversal())
                yield return v;
    }
}