C# 编程指南 之 迭代器

迭代器是一种方法、get 访问器或运算符，
它通过使用 yield 关键字对数组或集合类执行自定义迭代。yield 返回语句会导致源序列中的元素在访问源序列中的下一个元素之前立即返回给调用方。尽管您以方法的形式编写迭代器，但编译器会将其转换为一个实际上是状态机的嵌套类。只要客户端代码中的 foreach 循环继续进行，此类就会跟踪迭代器的位置。
将使用 foreach 语句从客户端代码中调用迭代器。例如，您可以为类创建一个迭代器，该迭代器将按相反顺序返回元素，或在迭代器返回元素之前对每个元素执行操作。在为类或结构创建迭代器时，您不必实现整个 IEnumerator 接口。当编译器检测到迭代器时，它将自动生成 IEnumerator 或 IEnumerator<(Of <(T>)>) 接口的 Current、MoveNext 和 Dispose 方法。

迭代器概述
  迭代器是可以返回相同类型的值的有序序列的一段代码。
  迭代器可用作方法、运算符或 get 访问器的代码体。
  迭代器代码使用 yield return 语句依次返回每个元素。yield break 将终止迭代。
  可以在类中实现多个迭代器。每个迭代器都必须像任何类成员一样有唯一的名称，并且可以在 foreach 语句中被客户端代码调用，如下所示：foreach(int x in SampleClass.Iterator2){}。
  迭代器的返回类型必须为 IEnumerable、IEnumerator、IEnumerable<(Of <(T>)>) 或 IEnumerator<(Of <(T>)>)。
  迭代器是 LINQ 查询中延迟执行行为的基础。

yield 关键字用于指定返回的一个或多个值。到达 yield return 语句时，会保存当前位置。下次调用迭代器时将从此位置重新开始执行。
迭代器对集合类特别有用，它提供一种简单的方法来迭代复杂的数据结构（如二进制树）。

使用迭代器（C# 编程指南）
创建迭代器最常用的方法是对 IEnumerable 接口实现 GetEnumerator 方法，例如：

public System.Collections.IEnumerator GetEnumerator()
{
    for (int i = 0; i < max; i++)
    {
        yield return i;
    }
}
GetEnumerator 方法的存在使得类型成为可枚举的类型，并允许使用 foreach 语句。如果上面的方法是 ListClass 的类定义的一部分，则可以对该类使用 foreach，如下所示：
static void Main()
{
    ListClass listClass1 = new ListClass();

    foreach (int i in listClass1)
    {
        System.Console.WriteLine(i);
    }
}
foreach 语句调用 ListClass.GetEnumerator() 并使用返回的枚举数来循环访问值。有关如何创建返回 IEnumerator 接口的泛型迭代器的示例，请参见如何：为泛型列表创建迭代器块（C# 编程指南）。

还可以使用命名的迭代器以支持通过不同的方式循环访问同一数据集合。例如，您可以提供一个按升序返回元素的迭代器，而提供按降序返回元素的另一个迭代器。迭代器还可以带有参数，以便允许客户端控制全部或部分迭代行为。下面的迭代器使用命名的迭代器 SampleIterator 实现 IEnumerable 接口：
// Implementing the enumerable pattern
public System.Collections.IEnumerable SampleIterator(int start, int end)
{
    for (int i = start; i <= end; i++)
    {
        yield return i;
    }
}
命名的迭代器的调用方法如下：
ListClass test = new ListClass();
foreach (int n in test.SampleIterator(1, 10))
{
    System.Console.WriteLine(n);
}
可以在同一个迭代器中使用多个 yield 语句，如下面的示例所示：
public System.Collections.IEnumerator GetEnumerator()
{
    yield return "With an iterator, ";
    yield return "more than one ";
    yield return "value can be returned";
    yield return ".";
}
然后可以使用下面的 foreach 语句输出结果：
foreach (string element in new TestClass())
{
    System.Console.Write(element);
}
此示例显示以下文本：
With an iterator, more than one value can be returned.

在 foreach 循环的每次后续迭代（或对 IEnumerator.MoveNext 的直接调用）中，下一个迭代器代码体将从前一个 yield 语句之后开始，并继续下一个语句直至到达迭代器体的结尾或遇到 yield break 语句。

 

C# 1.0中的foreach

没有迭代器的时候，创建一个可用于foreach的集合（C# 1.0）:

 public class MyCollection : IEnumerable
 {
  public MyEnumerator GetEnumerator()
  {
   return new MyEnumerator(this);
  }
  public class MyEnumerator : IEnumerator
  {
   public void Reset(){...}
   public bool MoveNext(){...}
   public int Current{ get{...} }
   object IEnumerator.Current{ get{...} }
  }
 }

对集合使用foreach语句：
  foreach(int i in col){...}

 相单于：
 IEnumerator etor = ((IEnumerable)col).GetEnumerator();
 try
 {
  while(etor.MoveNext())
  {
   ElementType clem (ElementType)etor.Current;
   ...;
  }
 }
 finally{(IDisposable)enumerator).Dispose();}

C# 2.0 中的迭代器

使用迭代器创建于foreach的集合（C# 2.0）：

 public class Stack<T>:IEnumerable<T>
 {
  T[] items;
  int count;
  public void Push(T data){...}
  public T Pop(){...}
  public IEnumerator<T> GetEnumerator()
  {
   for(int i=count-1;i>=0;--i)
   {
     yield return items[i];
   }
  }
 }

 使用foreach语句：

 Stack<int> stack = new Stack<int>();
 foreach(int i in statck){...}

 使用迭代器创建倒序遍历：

 public IEnumerable<T> BottomToTop
 {
    get
    {
       for(int i=0;i<count;i++)
       {
          yield return items[i];
       }
    }
 }

迭代器中的yield语句

使用yield return 产生枚举元素：

 for(int i=count-1;i>=0;--i)
 {
    yield return items[i];
 }

使用yield break中断迭代：
 
 for(int i=count-1;i>=0;--i)
 {
    yield return items[i];
    if(items[i]>10)
        yield break;
 }

迭代器的机制

C# 2.0中的迭代器同样是通过编译器的一层额外处理，来简化创建可用于foreach的枚举集合的工作。

通过ILDasm.exe反汇编工作，我们可以获得对迭代器的深入理解：
   - 迭代器中的GetEnumerator()方法
   - 迭代器中的嵌套类
   - 迭代器中的yield语句

 注：迭代器允许我们更加方便地编写应用于foreach语句的枚举集合。