通过实例解析c# yield关键字使用方法

Lana ·

更新时间:2024-11-14

· 544 次阅读

1.yield实现的功能

yield return：

先看下面的代码，通过yield return实现了类似用foreach遍历数组的功能，说明yield return也是用来实现迭代器的功能的。


using static System.Console;
using System.Collections.Generic;
class Program
{
  //一个返回类型为IEnumerable<int>，其中包含三个yield return
  public static IEnumerable<int> enumerableFuc()
  {
    yield return 1;
    yield return 2;
    yield return 3;
  }
  static void Main(string[] args)
  {
    //通过foreach循环迭代此函数
    foreach(int item in enumerableFuc())
    {
      WriteLine(item);
    }
    ReadKey();
  }
}

输出结果：123

yield break:

再看下面的代码，只输出了1，2，没有输出3，说明这个迭代器被yield break停掉了，所以yield break是用来终止迭代的。


using static System.Console;
using System.Collections.Generic;
class Program
{
  //一个返回类型为IEnumerable<int>，其中包含三个yield return
  public static IEnumerable<int> enumerableFuc()
  {
    yield return 1;
    yield return 2;
    yield break;
    yield return 3;
  }
  static void Main(string[] args)
  {
    //通过foreach循环迭代此函数
    foreach(int item in enumerableFuc())
    {
      WriteLine(item);
    }
    ReadKey();
  }
}

输出结果：12

2.只能使用在返回类型必须为 IEnumerable、IEnumerable<T>、IEnumerator 或 IEnumerator<T>的方法、运算符、get访问器中。

3.yield关键字的实现原理

我们用while循环代替foreach循环，发现我们虽然没有实现GetEnumerator()，也没有实现对应的IEnumerator的MoveNext()，和Current属性，但是我们仍然能正常使用这些函数。


class Program
{
  //一个返回类型为IEnumerable<int>，其中包含三个yield return
  public static IEnumerable<int> enumerableFuc()
  {
    yield return 1;
    yield return 2;
    yield return 3;
  }
  static void Main(string[] args)
  {
    //用while循环代替foreach
    IEnumerator<int> enumerator = enumerableFuc().GetEnumerator();
    while (enumerator.MoveNext())
    {
      int current = enumerator.Current;
      WriteLine(current);
    }
    ReadKey();
  }
}

输出结果：123

至于为什么会出现这种情况，我们可以用ILSpy对生成的exe进行反编译来找到原因。

由于直接反编译成C#会变为原样

所以我们选择反编译为带C#注释的IL代码，虽然可读性差点，但是可以详细的了解其中过的原理。

先来看Program翻译的情况，编译的时候自动生成了一个新的类。

接下来我们来仔细看这些代码，EnumerableFuc()返回了这个新的类。

看这个代码自动生成的类的实现，发现它继承了IEnumerable、IEnumerable<T>、IEnumerator 或 IEnumerator<T>，这时我们应该已经能猜到这个新的类就是我们没有实现对应的IEnumerator的MoveNext()，和Current属性，但是我们仍然能正常使用这些函数的原因了。