设计模式(17) 迭代器模式

• 迭代器模式
• 基于IEnumerable的实现
• 使用场景
• 迭代器模式的优缺点

迭代器模式

迭代器模式用于顺序访问集合对象的元素，而不需要知道集合对象的底层表示。Java和.Net等语言已经将迭代器作为其内部语法元素，比如在C#中，集合对象只需要实现IEnumberable接口，然后就可以用foreach来遍历了。
迭代器模式提示我们要从使用者的角度考虑如何设计接口，如何对外提供访问内部对象的方式。即便我们组织的对象系统内部结构很复杂，但对于客户程序而言最简单的方式莫过于通过for /foreach循环依次遍历，至于遍历过程中的次序、分类筛选等则由目标类型自己封装。

GOF对迭代器模式描述为：
Provide a way to access the elements of an aggregate objectsequentially without exposing its underlying representation.
— Design Patterns : Elements of Reusable Object-Oriented Software

UML类图：

代码实现

//迭代器接口
public interface IIterator<T>
{
    T Next();
    bool HasNext();
}
//具体迭代器
public class ConcreteIterator<T> : IIterator<T>
{
    private ConcreteAggretate<T> Aggretate; //成员变量，关联关系
    private int cursor = 0;
    public ConcreteIterator(ConcreteAggretate<T> agg)
    {
        this.Aggretate = agg;
    }
    public bool HasNext()
    {
        return !(cursor >= Aggretate.Size);
    }

    public T Next()
    {
        if (HasNext())
        {
            return Aggretate.GetELement(cursor++);
        }
        else
        {
            return default(T);
        }

    }
}
//聚合接口
public interface IAggretate<T>
{
    public void Add(T obj);
    public void Remove(T obj);
    public int Size { get; }
    public T GetELement(int index);
    public IIterator<T> GetIterator();
}
//具体聚合
public class ConcreteAggretate<T> : IAggretate<T>
{
    private List<T> list = new List<T>();  //
    public void Add(T obj)
    {
        list.Add(obj);
    }

    public void Remove(T obj)
    {
        list.Remove(obj);
    }

    public IIterator<T> GetIterator()
    {
        return new ConcreteIterator<T>(this);  //在局部方法中new实例，属依赖关系
    }

    public int Size
    {
        get
        {
            return list.Count;
        }
    }

    public T GetELement(int index)
    {
        return list[index];
    }
}

调用者代码：

IAggretate<int> aggretate = new ConcreteAggretate<int>();
aggretate.Add(9);
aggretate.Add(8);
aggretate.Add(7);
IIterator<int> iterator = aggretate.GetIterator();
while (iterator.HasNext())
{
    Console.WriteLine(iterator.Next());
}

基于IEnumerable的实现

以上便是经典的迭代器模式的实现，这种模式给聚合对象增加了一个创建其迭代器对象的方法，迭代器的抽象定义和具体迭代器类型都作为一个额外的对象存在。
实际上C#已内置了对迭代器模式的支持，只需要实现IEnumerable接口即可，不再需要从0开始，少了很多代码量：

public class ConcreteAggretate<T> : IEnumerable<T>
{
    private List<T> list = new List<T>();
    public void Add(T obj)
    {
        list.Add(obj);
    }

    public void Remove(T obj)
    {
        list.Remove(obj);
    }

    public IEnumerator<T> GetEnumerator()
    {
        foreach (var item in list)
        {
            yield return item;
        }
    }

    IEnumerator IEnumerable.GetEnumerator()
    {
        throw new NotImplementedException();
    }
}

使用foreach遍历IEnumerable接口

var aggretate = ConcreteAggretate<int>();
aggretate.Add(9);
aggretate.Add(8);
aggretate.Add(7);

foreach (var item in aggretate)
{
    Console.WriteLine(item);
}

使用场景

• 对象内部结构比较复杂，为了让调用者可以轻松地访问，同时不需要暴露其内部结构；
• 需要为聚合对象提供多种遍历方式；
• 为遍历不同的聚合结构提供一个统一的接口；

迭代器模式的优缺点

优点

• 迭代器支持以不同的方式遍历一个聚合对象，而且在同一个聚合上可以添加多个具有不同遍历方式的迭代器；
• 迭代器简化了聚合类的遍历；
• 迭代器模式可以方便地增加新的聚合类和迭代器类，无须修改原有代码。

缺点
迭代器模式通过将存储数据和遍历数据的职责分离，为封装集合地复杂性、隔离变化提供了极大的遍历，但这种方式也有其固有的缺点：每次
增加新的聚合类都需要对应增加新的迭代器类，类的个数成对增加，这在一定程度上增加了系统的复杂性。

参考书籍：
王翔著 《设计模式——基于C#的工程化实现及扩展》