C#基础—迭代器(Iterator)

1、引入迭代器

    记得以前经常做到一些面试题，是关于要实现迭代器必须实现什么接口？其实，在C# 1.0里我们就经常用到foreach了，所以，只要支持foreach，那么这个类型就可以使用foreach 去遍历。那如何才能支持foreach 呢？

    其实，答案都知道，要实现IEnumerable 或 IEnumerable<T>、IEnumerator 接口，因为foreach 需要迭代器的支持，而IEnumerable 接口中含有返回迭代器的 GetEnumerator 方法，对此，可以查看下MSDN 对 IEnumerable 的定义。所以，我们只要实现这个方法就可以使用foreach 来遍历我们需要的类型。

2、迭代器的使用

什么是迭代器？ 简单的理解就是集合中的某个位置。我们先写个小Demo来认识下如何去实现一个自定义的迭代器：

//1.首先定义一个需要实现foreach遍历的对象，我们假设为要遍历一群人
class Person
{
　　public string FirstName;
　　public string LastName;
　　public Person(string firstName, string lastName)
　　{
　　　　this.FirstName = firstName;
　　　　this.LastName = lastName;
　　}
}

//2. 定义一个那个我们要遍历的一群人集合，我们把这个类型叫：PersonList
class PersonList : IEnumerable
{
　　//其实操作的是Person的数组
　　private Person[] _personList;
　　public PersonList(Person[] PersonList)
　　{
　　　　this._personList = PersonList;
　　}

　　/// <summary>
　　///用来遍历PersionList类的索引器，类似类数组
　　/// </summary>
　　/// <param name="index"></param>
　　/// <returns></returns>
　　public Person this[int index]
　　{
　　　　get
　　　　{
　　　　　　return this._personList[index];
　　　　}
　　}

　　/// <summary>
　　///一般集合也都有一个Count，我们也实现下
　　/// </summary>
　　public int Count
　　{
　　　　get
　　　　{
　　　　　　return this._personList.Length;
　　　　}
　　}

　　/// <summary>
　　///这个是返回迭代器的方法，必须要实现的
　　/// </summary>
　　/// <returns></returns>
　　public IEnumerator GetEnumerator()
　　{
　　　　return (new PersonIterator(this)); //把当前自定义的集合传给迭代器进行遍历功能的实现，并返回迭代器对象
　　}
}

//3.定义一个自定义的迭代器，我们假设叫 PersonIterator，实现迭代器需要实现 System.Collection.IEnumerator 接口
class PersonIterator : IEnumerator
{
　　//要遍历的自定义对象集合,传入迭代器进行遍历
　　private readonly PersonList _personList;
　　//当前位置的索引
　　private int _position = -1;

　　public PersonIterator(PersonList personList)
　　{
　　　　this._personList = personList;
　　}

　　#region自定义迭代器必须要实现的IEnumerator中的几个方法和属性
　　public object Current
　　{
　　　　get
　　　　{
　　　　　　try
　　　　　　{
　　　　　　　　return this._personList[this._position];
　　　　　　}
　　　　　　catch(IndexOutOfRangeException)
　　　　　　{
　　　　　　　　throw new IndexOutOfRangeException();
　　　　　　}
　　　　}
　　}

　　public bool MoveNext()
　　{
　　　　this._position++;
　　　　return (this._position < this._personList.Count);
　　}

　　public void Reset()
　　{
　　　　this._position = -1;
　　}
   #endregion
}

 

class Program
{
　　static void Main(string[] args)
　　{ 
　　　　Person[] personArray = new Person[2]
　　　　{
　　　　　　new Person("三", "张"),
　　　　　　new Person("四", "李")
　　　　};
　　  //测试
　　  PersonList pList = new PersonList(personArray);
　　  foreach (Person p in pList)
　　  {
　　　　　　Console.WriteLine("遍历的姓名: {0} {1}", p.FirstName, p.LastName);
241　　   }

　　  Console.Read();
}
}

程序输出：

遍历的姓名：三 张

遍历的姓名：四 李

     至此，我们在梳理下实现的步骤：

     (1).定义要遍历的对象 Person

 (2).定义要遍历的对象集合类 PersonList 实现 IEnumerable 接口，主要实现 GetEnumerator()方法，以便于返回一个迭代器对象。

 (3).定义一个自定义的迭代器类 PersonIterator 实现 IEnumerator 接口，主要实现该接口中定义的方法和属性。

      整个迭代器的实现过程略微显得复杂，如果每次都这样实现，的确感觉不太理想，因此C# 2.0 为我们提供了语法糖：yield return。让我们来看看实现的过程有哪些简化的呢？由于篇幅原因，我只提供了修改的地方：

///// <summary>
///// 这个是返回迭代器的方法，必须要实现的
///// </summary>
///// <returns></returns>
//public IEnumerator GetEnumerator()
//{
// 　　return (new PersonIterator(this)); //把当前自定义的集合传给迭代器进行遍历功能的实现，并返回迭代器对象
//}


/// <summary>
///这个是返回迭代器的方法，必须要实现的, C# 2.0 的yield return
/// </summary>
/// <returns></returns>
public IEnumerator GetEnumerator()
{
　　for (var i = 0; i < this._personList.Length; i++)
　　{
　　　　yield return this._personList[i];
　　}
}

      这样我们就省去了第三步去实现IEnumerator来构造一个迭代器类，但是编译器的工作还是不会少的，当编译器看到 yield return 时会自动为我们实现IEnumerator 接口，有兴趣的同仁可以查看下最后编译后的代码，在此不再敖述。    

3、迭代器的执行过程

     对于迭代器的执行过程，大家可以调试测试，这里直接引用下园子里大神的图片做个演示了：

 

     至此，迭代器先谈这么多了，至于迭代器的延迟计算，我们到Linq 中再谈，欢迎交流！