迭代器和yield

　　2012-08-05©tc庄稼汉

　　迭代器是一种方法、get 访问器或运算符，它通过使用 yield 关键字对数组或集合类执行自定义迭代。 yield 返回语句会导致源序列中的元素在访问源序列中的下一个元素之前立即返回给调用方。 尽管您以方法的形式编写迭代器，但编译器会将其转换为一个实际上是状态机的嵌套类。 只要客户端代码中的 foreach 循环继续进行，此类就会跟踪迭代器的位置。

　　将使用 foreach 语句从客户端代码中调用迭代器。 例如，您可以为类创建一个迭代器，该迭代器将按相反顺序返回元素，或在迭代器返回元素之前对每个元素执行操作。 在为类或结构创建迭代器时，您不必实现整个 IEnumerator 接口。 当编译器检测到迭代器时，它将自动生成 IEnumerator 或 IEnumerator<T> 接口的 Current、MoveNext 和 Dispose 方法。
一、迭代器概述

• 迭代器是可以返回相同类型的值的有序序列的一段代码。

• 迭代器可用作方法、运算符或 get 访问器的代码体。

• 迭代器代码使用 yield return 语句依次返回每个元素。 yield break 将终止迭代。

• 可以在类中实现多个迭代器。 每个迭代器都必须像任何类成员一样有唯一的名称，并且可以在 foreach 语句中被客户端代码调用，如下所示：foreach(int x in SampleClass.Iterator2){}。

• 迭代器的返回类型必须为 IEnumerable、IEnumerator、IEnumerable<T> 或 IEnumerator<T>。

• 迭代器是 LINQ 查询中延迟执行行为的基础。

　　yield 关键字用于指定返回的一个或多个值。 到达 yield return 语句时，会保存当前位置。 下次调用迭代器时将从此位置重新开始执行。

　　迭代器对集合类特别有用，它提供一种简单的方法来迭代复杂的数据结构（如二进制树）。
二、yield关键字　　

　　yield 关键字向编译器指示它所在的方法是迭代器块。 编译器生成一个类来实现迭代器块中表示的行为。 在迭代器块中，yield 关键字与 return 关键字结合使用，向枚举器对象提供值。 这是一个返回值，例如，在 foreach 语句的每一次循环中返回的值。 yield 关键字也可与 break 结合使用，表示迭代结束。 有关迭代器的更多信息，请参见迭代器（C# 编程指南）。

　　使用迭代块,编译器会生成一个yield类型,其中包含一个状态机,yield类型执行IEnumerator和IDisposable接口的属性和方法.GetEnumerator()方法实例化并返回一个新的yield类型.在yield类型中,变量state定义了迭代的当前位置,每次调用MoveNext()时,当前位置都会改变.MoveNext()封装了迭代块的代码,设置了current变量的值,使Current属性根据位置返回一个对象。

下面的示例演示两种形式的 yield 语句。
　　

yield return <expression>;
yield break;

 

　　yield注意事项：　　

　　在 yield return 语句中，将计算 expression 并将结果以值的形式返回给枚举器对象；expression 必须可以隐式转换为 yield 类型的迭代器。

　　在 yield break 语句中，控制权将无条件地返回给迭代器的调用方，该调用方为枚举器对象的 IEnumerator.MoveNext 方法（或其对应的泛型 System.Collections.Generic.IEnumerable<T>）或 Dispose 方法。

　　yield 语句只能出现在 iterator 块中，这种块可作为方法、运算符或访问器的主体实现。 这类方法、运算符或访问器的体受以下约束的控制：

• 不允许不安全块。

• 方法、运算符或访问器的参数不能是 ref 或 out。

• yield return 语句不能放在 try-catch 块中的任何位置。 该语句可放在后跟 finally 块的 try 块中。

• yield break 语句可放在 try 块或 catch 块中，但不能放在 finally 块中。

　　yield 语句不能出现在匿名方法中。 有关更多信息，请参见 匿名方法（C# 编程指南）。

　　当和 expression 一起使用时，yield return 语句不能出现在 catch 块中或含有一个或多个 catch 子句的 try 块中。 有关更多信息，请参见 异常处理语句（C# 参考）。

三、使用迭代器
　　1.创建迭代器最常用的方法是对 IEnumerable 接口实现 GetEnumerator 方法，例如：

public System.Collections.IEnumerator GetEnumerator()
{for (int i = 0; i < 10; i++){yield return i;}
}

 

　　GetEnumerator 方法的存在使得类型成为可枚举的类型，并允许使用 foreach 语句。 如果上面的方法是 ListClass 的类定义的一部分，则可以对该类使用 foreach，如下所示：
　　

static void Main()
{ListClass listClass1 = new ListClass();foreach (int i in listClass1){System.Console.Write(i + " ");}// Output: 0 1 2 3 4 5 6 7 8 9
}

 

　　foreach 语句调用 ListClass.GetEnumerator() 并使用返回的枚举数来循环访问值。

　　2.还可以使用命名的迭代器以支持通过不同的方式循环访问同一数据集合。 例如，您可以提供一个按升序返回元素的迭代器，而提供按降序返回元素的另一个迭代器。 迭代器还可以带有参数，以便允许客户端控制全部或部分迭代行为。 下面的迭代器使用命名的迭代器 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;}
}

 

　　命名的迭代器的调用方法如下(ps:第一种实现GetEnumerator方法，实际上就是定义一个支持IEnumerable或者IEnumrator的可枚举类型，所以foreach (int i in listClass1)，这里的listClass1是listClass类型的实例对象，而下面这个foreach (int n in test.SampleIterator(1, 10))就是使用的迭代器的名称。)：
　　

ListClass test = new ListClass();foreach (int n in test.SampleIterator(1, 10))
{System.Console.Write(n + " ");
}
// Output: 1 2 3 4 5 6 7 8 9 10

 

　　可以在同一个迭代器中使用多个 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);
}
// Output: With an iterator, more than one value can be returned.

 

　　此示例显示以下文本：

　　With an iterator, more than one value can be returned.

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

　　迭代器不支持 IEnumerator.Reset 方法。 若要从头开始重新循环访问，必须获取新迭代器。