C#设计模式系列(16)-迭代器模式

迭代器模式遍历集合的成熟模式，迭代器模式的关键是将遍历集合的任务交给一个叫做迭代器的对象，它的工作时遍历并选择序列中的对象，而客户端程序员不必知道或关心该集合序列底层的结构。

一、引言

在上篇博文中分享了我对命令模式的理解，命令模式主要是把行为进行抽象成命令，使得请求者的行为和接受者的行为形成低耦合。在一章中，将介绍一下迭代器模式。下面废话不多说了，直接进入本博文的主题。

二、迭代器模式的介绍

迭代器是针对集合对象而生的，对于集合对象而言，必然涉及到集合元素的添加删除操作，同时也肯定支持遍历集合元素的操作，我们此时可以把遍历操作也放在集合对象中，但这样的话，集合对象就承担太多的责任了，面向对象设计原则中有一条是单一职责原则，所以我们要尽可能地分离这些职责，用不同的类去承担不同的职责。迭代器模式就是用迭代器类来承担遍历集合元素的职责。

2.1 迭代器模式的定义

迭代器模式提供了一种方法顺序访问一个聚合对象（理解为集合对象）中各个元素，而又无需暴露该对象的内部表示，这样既可以做到不暴露集合的内部结构，又可让外部代码透明地访问集合内部的数据。

2.2 迭代器模式的结构

既然，迭代器模式承担了遍历集合对象的职责，则该模式自然存在2个类，一个是聚合类，一个是迭代器类。在面向对象涉及原则中还有一条是针对接口编程，所以，在迭代器模式中，抽象了2个接口，一个是聚合接口，另一个是迭代器接口，这样迭代器模式中就四个角色了，具体的类图如下所示：

从上图可以看出，迭代器模式由以下角色组成：

迭代器角色（Iterator）：迭代器角色负责定义访问和遍历元素的接口

具体迭代器角色（Concrete Iteraror）：具体迭代器角色实现了迭代器接口，并需要记录遍历中的当前位置。

聚合角色（Aggregate）：聚合角色负责定义获得迭代器角色的接口

具体聚合角色（Concrete Aggregate）：具体聚合角色实现聚合角色接口。

2.3 迭代器模式的实现

介绍完迭代器模式之后，下面就具体看看迭代器模式的实现，具体实现代码如下：

// 抽象聚合类
    public interface IListCollection
    {
        Iterator GetIterator();
    }
 
    
// 迭代器抽象类
    public interface Iterator
    {
        bool MoveNext();
        Object GetCurrent();
        void Next();
        void Reset();
    }
 
    
// 具体聚合类
    public class ConcreteList : IListCollection
    {
        int[] collection;
        public ConcreteList()
        {
            collection = new int[] { 2, 4, 6, 8 };
        }
 
        public Iterator GetIterator()
        {
            return new ConcreteIterator(this);
        }
 
        public int Length
        {
            get { return collection.Length; }
        }
 
        public int GetElement(int index)
        {
            return collection[index];
        }
    }
 
    
// 具体迭代器类
    public class ConcreteIterator : Iterator
    {
        
// 迭代器要集合对象进行遍历操作，自然就需要引用集合对象
        private ConcreteList _list;
        private int _index;
 
        public ConcreteIterator(ConcreteList list)
        {
            _list = list;
            _index = 0;
        }
 
        public bool MoveNext()
        {
            if (_index < _list.Length)
            {
                return true;
            }
            return false;
        }
 
        public Object GetCurrent()
        {
            return _list.GetElement(_index);
        }
 
        public void Reset()
        {
            _index = 0;
        }
 
        public void Next()
        {
            if (_index < _list.Length)
            {
                _index++;
            }
 
        }
    }
 
    
// 客户端
    class Program
    {
        static void Main(string[] args)
        {
            Iterator iterator;
            IListCollection list = new ConcreteList();
            iterator = list.GetIterator();
 
            while (iterator.MoveNext())
            {
                int i = (int)iterator.GetCurrent();
                Console.WriteLine(i.ToString());
                iterator.Next();
            }
 
            Console.Read();
        }
    }

自然，上面代码的运行结果也是对集合每个元素的输出，具体运行结果如下图所示：

三、.NET中迭代器模式的应用

在.NET下，迭代器模式中的聚集接口和迭代器接口都已经存在了，其中IEnumerator接口扮演的就是迭代器角色，IEnumberable接口则扮演的就是抽象聚集的角色，只有一个GetEnumerator()方法，关于这两个接口的定义可以自行参考MSDN。在.NET 1.0中，.NET 类库中很多集合都已经实现了迭代器模式，大家可以用反编译工具Reflector来查看下mscorlib程序集下的System.Collections命名空间下的类，这里给出ArrayList的定义代码，具体实现代码可以自行用反编译工具查看，具体代码如下所示：

public class ArrayList : IList, ICollection, IEnumerable, ICloneable
{
    
// Fields
    private const int _defaultCapacity = 4;
    private object[] _items;
    private int _size;
    [NonSerialized]
    private object _syncRoot;
    private int _version;
    private static readonly object[] emptyArray;
 
    public virtual IEnumerator GetEnumerator();
    public virtual IEnumerator GetEnumerator(int index, int count);
 
    
// Properties
    public virtual int Capacity { get; set; }
    public virtual int Count { get; }
    ..............
// 更多代码请自行用反编译工具Reflector查看
}

通过查看源码你可以发现，ArrayList中迭代器的实现与我们前面给出的示例代码非常相似。然而，在.NET 2.0中，由于有了yield return关键字，实现迭代器模式就更简单了，关于迭代器的更多内容可以参考我的这篇博文。