C#中的yield关键字有什么用?揭秘C#迭代器和状态机的实现原理

yield 关键字用于简化迭代器编写,通过 yield return 逐个返回元素,实现惰性求值,避免一次性生成所有数据,提升性能并减少内存占用。

yield 关键字是 C# 中实现迭代器的核心工具,它让开发者可以轻松编写支持枚举的数据结构,而无需手动创建复杂的集合或状态管理。它的主要用途是在不一次性生成所有数据的情况下,按需返回序列中的每个元素。

简化迭代器的编写

在没有 yield 之前,如果想让一个方法返回可枚举的序列(比如 IEnumerable),通常需要创建一个集合对象,把所有结果存进去再返回。这种方式不仅占用内存,而且在数据量大时效率低下。

使用 yield return,你可以逐个“产出”元素,调用方每次通过 MoveNext() 获取下一个值时,才会执行到下一个 yield return 语句。这实现了“惰性求值”——数据只在需要时才计算。

示例:
public IEnumerable GetNumbers()
{
    for (int i = 0; i < 5; i++)
    {
        yield return i;
    }
}

这个方法不会立即返回 0~4 的数组,而是每次遍历时生成一个值。foreach 循环中每轮都会触发一次执行,直到遇到下一个 yield return。

编译器自动生成状态机

你写的简单方法,C# 编译器会转换成一个复杂的状态机类。这个类保存了当前执行位置、局部变量等信息,使得方法可以在 yield return 后暂停,并在下次继续执行。

以上面的 GetNumbers 方法为例,编译后大致生成如下结构:

  • 一个实现 IEnumerator 接口的私有类
  • 该类包含字段记录当前索引 i 和状态(如正在执行、已完成)
  • MoveNext() 方法包含原始循环逻辑,根据状态决定从哪继续执行
  • Current 属性返回当前 yield 的值

这意味着你写的是同步代码,但运行时表现像协程——函数能在中途暂停并恢复。

yield break 控制迭代终止

除了 yield return,还可以使用 yield break 提前结束迭代。它类似于普通方法中的 return,但用于中断枚举过程。

场景举例:
public IEnumerable ReadLines()
{
    string line;
    while ((line = Console.ReadLine()) != null)
    {
        if (line == "exit")
            yield break;
        yield return line.ToUpper();
    }
}

当用户输入 exit 时,迭代立即停止,后续不再产生任何值。

实际应用与注意事项

yield 常用于以下场景:

  • 处理大数据流(文件行读取、网络数据包)
  • 无限序列生成(斐波那契数列、随机数流)
  • 树形结构遍历(二叉树中序遍历)
  • 延迟加载数据库查询结果

需要注意的是:

  • 不能用在异步方法(async)中,await 和 yield 不能共存于同一方法
  • 异常处理要小心,yield 方法内部抛出的异常可能在 MoveNext() 时才暴露
  • 多次枚举同一个 yield 方法会重新执行逻辑,不是缓存结果

基本上就这些。yield 让 C# 的迭代变得高效又简洁,背后靠的是编译器生成的状态机机制。理解这一点,就能更好掌握何时该用它,以及为什么它能节省内存和提升性能。