C# yield 关键字

前言

  在 C# 中，yield 关键字是一个非常独特且强大的语言特性，它主要用于迭代器块（Iterator Block）中，能够让开发者以一种简洁高效的方式实现自定义的可迭代类型，轻松地生成并返回一个序列的值，而无需像传统方式那样创建一个完整的集合对象来存储所有要返回的数据。简单来说，yield 关键字帮助我们实现了一种 “按需生成” 数据的机制，特别适用于处理大数据量或者无限序列的情况，避免了一次性占用大量内存空间。
  例如，想象要生成一个包含所有自然数的序列，如果不使用 yield 关键字，可能需要先创建一个非常大的数组或者列表来存储这些数，这显然会消耗大量内存且效率低下。而借助 yield 关键字，就可以在需要的时候逐个生成这些自然数，不会造成不必要的内存开销。

一、yield 关键字的语法形式及使用场景

（一）yield return

  yield return 语句是 yield 关键字最常见的用法，它用于从迭代器块中返回一个值，并且会 “记住” 当前的执行位置，下次调用迭代器继续执行时，会从这个位置接着往下执行，继续生成下一个值，以此类推，直到迭代结束。
  以下是一个简单的示例，定义了一个方法来生成斐波那契数列（这里只生成有限项）：

using System;
using System.Collections.Generic;

public static IEnumerable<int> FibonacciSequence(int count)
{
    int a = 0, b = 1;
    for (int i = 0; i < count; i++)
    {
        yield return a;
        int temp = a;
        a = b;
        b = temp + b;
    }
}

  在上述代码中，FibonacciSequence 方法返回一个实现了 IEnumerable 接口的可迭代序列，通过 yield return 语句，每次循环时返回斐波那契数列中的一项。例如，我们可以这样调用并遍历这个序列：

foreach (int num in FibonacciSequence(10))
{
    Console.Write(num + " ");
}

  输出结果将会是斐波那契数列的前 10 项：0 1 1 2 3 5 8 13 20 34。在这个过程中，每次 foreach 循环迭代时，就会触发 yield return 执行，生成下一个数列的值，并不会一次性把整个斐波那契数列都计算并存储好再返回。

（二）yield break

  yield break 语句用于终止迭代器的执行，提前结束整个迭代过程。通常在满足某些特定条件，不需要再继续生成后续数据时使用。
  例如，修改上面的斐波那契数列生成方法，假设当生成的数大于 100 时就停止生成，代码可以修改为如下：

using System;
using System.Collections.Generic;

public static IEnumerable<int> FibonacciSequence(int count)
{
    int a = 0, b = 1;
    for (int i = 0; i < count; i++)
    {
        if (a > 100)
        {
            yield break;
        }
        yield return a;
        int temp = a;
        a = b;
        b = temp + b;
    }
}

  在这个示例中，一旦生成的斐波那契数 a 大于 100，就会执行 yield break，迭代器停止工作，后续的元素就不会再被生成和返回了。

二、yield 关键字的工作原理

  当使用 yield 关键字的迭代器方法被调用时（比如在 foreach 循环中调用），编译器会自动生成一个状态机（State Machine）来管理迭代的过程。这个状态机负责跟踪迭代器的当前执行位置、局部变量的值等信息，每次遇到 yield return 时，它会保存当前的状态，返回相应的值给调用者，等到下一次调用继续迭代时，又能恢复到之前保存的状态，接着往下执行，继续生成下一个值。
  从内存管理角度来看，由于数据是按需生成的，在某个时刻只有当前正在生成和返回的值会占用内存，而不是一次性将整个序列的数据都加载到内存中，这对于处理大量数据或者无限序列的情况非常有优势，大大节省了内存资源，同时也提升了程序的性能和响应速度。

三、yield 关键字的优势与应用场景

（一）优势

内存高效： 避免了提前创建和存储大量的数据，只在需要的时候生成并返回值，有效减少了内存占用，特别是对于大数据集或者无限长的序列，这种优势更为明显。
代码简洁： 能够以简洁的代码实现复杂的可迭代逻辑，相较于传统的通过创建集合对象、手动管理索引等方式来生成序列数据，使用 yield 关键字的代码更加清晰、易读和易于维护。
灵活性高： 可以方便地根据不同的条件动态地生成数据序列，比如根据用户输入、运行时的配置等因素实时调整生成的数据内容，而不需要对整个数据生成逻辑进行大规模重构。

（二）应用场景

处理大数据集合： 比如从数据库中查询大量的数据记录，不想一次性将所有记录都加载到内存中，可以使用 yield 关键字实现一个迭代器，每次从数据库中读取一条记录并返回，这样可以在内存有限的情况下高效地处理大量数据。
生成无限序列： 像生成自然数序列、质数序列等无限长的序列时，使用 yield 关键字能够让程序可以持续生成后续的值，而不会因为内存耗尽而崩溃，同时调用者可以根据自己的需要获取指定数量的元素，具有很高的灵活性。
遍历复杂的数据结构： 当需要遍历一些复杂的数据结构（如树形结构、图结构等），并按照特定顺序返回节点的值时，利用 yield 关键字可以轻松地实现深度优先遍历、广度优先遍历等不同的遍历逻辑，将遍历过程中节点的值逐个返回给调用者。