在.NET中,迭代器模式是通过IEnumerator和IEnumerable接口以及它们的泛型版本来实现的。如果某个类实现了IEnumerable接口,就说明它可以被迭代访问,调用GetEnumerator()方法将返回IEnumerator的实现,这个就是迭代器本身。
在C# 1.0中,利用foreach语句实现了访问迭代器的内置支持,让集合的遍历变得简单、明了。其实,foreach的实现就是调用GetEnumerator和MoveNext方法以及Current属性。所以说,在C# 1.0中要获得迭代器就必须实现IEnumerable接口中的GetEnumerator方法,要实现一个迭代器就要实现IEnumerator接口中的MoveNext和Reset方法
在C# 2.0中提供的语法糖来简化迭代器的实现,可以通过yield关键字来简化迭代器的实现。
假设我们要实现一个字符列表类型,并且可以通过foreach来遍历这个类型。那么,在C# 1.0中,就要实现IEnumerable和IEnumerator接口。
在上面的例子中,CharIterator就是迭代器的实现,position字段存储当前的迭代位置,通过Current属性可以得到当前迭代位置的元素,MoveNext方法用于更新迭代位置,并且查看下一个迭代位置是不是有效的。
当我们通过VS单步调试下面语句的时候
代码首先执行到foreach语句的charList处获得迭代器CharIterator的实例,然后代码执行到in会调用迭代器的MoveNext方法,最后变量c会得到迭代器Current属性的值;前面的步骤结束后,会开始一轮新的循环,调用MoveNext方法,获取Current属性的值。
通过C# 1.0中迭代器的代码看到,要实现一个迭代器就要实现IEnumerator接口,然后实现IEnumerator接口中的MoveNext、Reset方法和Current属性。
在C# 2.0中可以直接使用yield语句来简化迭代器的实现。
通过上面的代码可以看到,通过使用yield return语句,我们可以替换掉整个CharIterator类。
yield return语句就是告诉编译器,要实现一个迭代器块。如果GetEnumerator方法的返回类型是非泛型接口,那么迭代器块的生成类型(yield type)是object,否则就是泛型接口的类型参数。
通过IL代码可以看到,对于yield return语句语句,编译器为我们生成了一个嵌套的类型(nested type) d__0,并且这个类实现了IEnumerator接口。

当编译器遇到迭代块时,它创建了一个实现了状态机的内部类。这个类记住了我们迭代器的准确当前位置以及本地变量,包括参数。这个类有点类似与C# 1.0中手写的那段代码,它将所有需要记录的状态保存为实例变量。为了实现一个迭代器,这个状态机需要按顺序执行的操作:
注意,当我们想要避免迭代器中的装箱和拆箱是,就要实现迭代器的泛型版本,由于泛型IEnumerable 接口继承了泛型型IEnumerable接口,我们需要在泛型迭代器代码中加入
这样,非泛型方法转而调用泛型方法,从而不需要再去实现非泛型的IEnumerable接口了。
前面简单提到了迭代器的工作流程,下面我们通过一个例子进一步看看迭代器工作流程。
一般迭代器都会结合foreach语句,然后foreach会在最后调用Dispose方法。这里为了演示,代码中使用while语句实现循环。
稍微打断一下,插入一个内容的介绍,通常为了实现IEnumerable,我们只会返回IEnumerator;如果仅仅是在方法中生成一个序列,可以返回IEnumerable。所以将代码改为下面的方式也可以工作:
两种方式的IL代码是不同的,这里只列出了编译器内嵌类型实现了那些接口,更详细的内容可以通过ILSpy查看:
返回IEnumerable
返回IEnumerator
回到这个例子,程序的输出结果为:

在这段代码中有几个注意点:
第一点尤为重要:这意味着如果在方法调用时需要立即执行,就不能使用迭代器块。例如如果将参数验证放在迭代块中,那么他将不能够很好的起作用,这是经常会导致的错误的地方,而且这种错误不容易发现。