迭代器模式（Interator Pattern）

2023-05-22 18:21 由街酒发表于 #软件设计

一、模式动机

迭代器模式（Iterator Pattern）是一种使用频率非常高的行为型设计模式，迭代器用于对一个聚合对象进行遍历。通过引入迭代器可以将数据的遍历功能从聚合对象中分离出来，聚合对象只负责存储数据，而遍历数据由迭代器来完成，简化了聚合对象的设计，更符合“单一职责原则”的要求。Java语言提供了对迭代器模式的完美支持，通常我们不需要自己定义新的迭代器，直接使用Java提供的迭代器即可。迭代器模式又称为“游标（Cursor）模式”，它是一种对象行为型模式。
类比：

电视机   存储电视频道的集合   聚合类(Aggregate Classes)
电视机遥控器   操作电视频道   迭代器(Iterator)
如何访问一个聚合对象中的元素但又不需要暴露它的内部结构，还能提供多种不同的遍历方式   迭代器模式

二、模式定义

迭代器模式(Iterator Pattern) ：提供一种方法来访问聚合对象，而不用暴露这个对象的内部表示。
提供一个外部的迭代器对聚合对象进行访问和遍历，迭代器中定义了一个访问该聚合对象的接口，并且可以跟踪当前遍历的元素，了解哪些元素已经遍历，哪些没有。
其别名为游标(Cursor)
迭代器模式是一种对象行为型模式

三、模式结构

抽象迭代器类

public interface Iterator {
    public void first();              //将游标指向第一个元素
    public void next();               //将游标指向下一个元素
    public boolean hasNext();         //判断是否存在下一个元素
    public Object currentItem();      //获取游标指向的当前元素
}

具体迭代器类

public class ConcreteIterator implements Iterator {
    private ConcreteAggregate objects; //维持一个对具体聚合对象的引用，以便于访问存储在聚合对象中的数据
    private int cursor;         //定义一个游标，用于记录当前访问位置
    public ConcreteIterator(ConcreteAggregate objects) {
        this.objects=objects;
    }
    public void first() {  ......  }		
    public void next() {  ......  }
    public boolean hasNext( ) {  ......  }	
    public Object currentItem( ) {  ......  }
}

抽象聚合类

public interface Aggregate {
    Iterator createIterator( );
}

具体聚合类

public class ConcreteAggregate implements Aggregate {	
    ......	
    public Iterator createIterator( ) {
        return new ConcreteIterator(this);
    }
    ......
}

四、案例实现

案例背景

遥控操控电视频道遍历

案例结构

代码实现

抽象迭代器类：电视机遥控器类

public interface TVInterator {

    void setChannel(int i);
    Object currentChannel();
    void next();
    void previous();
    boolean isLast();
    boolean isFirst();

}

抽象聚合类

public interface Television {

    TVInterator createInterator();

}

具体电视机类：创维电视机类

public class SkyworthTelevision implements Television{

    private Object[] obj = {"CCTV-1","CCTV-2","CCTV-3","CCTV-4","CCTV-5","CCTV-6"};

    @Override
    public TVInterator createInterator() {
        return new SkyworthInterator(obj);
    }

}

具体电视机类：TCL

public class TCLTelevision implements Television{

    private Object[] obj = {"湖南卫视","上海卫视","山西卫视","河北卫视","上海卫视","北京卫视"};

    @Override
    public TVInterator createInterator() {
        return new SkyworthInterator(obj);
    }

}

具体电视机遥控器类：创维

public class SkyworthInterator implements TVInterator{

    private int currentIndex = 0;
    private Object obj[];

    public SkyworthInterator(Object[] obj) {
        this.obj = obj;
    }

    @Override
    public void setChannel(int i) {
        currentIndex = i;
    }

    @Override
    public Object currentChannel() {
        return obj[currentIndex];
    }

    @Override
    public void next() {
        if (currentIndex < obj.length){
            currentIndex ++;
        }
    }

    @Override
    public void previous() {
        if (currentIndex > 0){
            currentIndex --;
        }
    }

    @Override
    public boolean isLast() {
        return currentIndex == obj.length;
    }

    @Override
    public boolean isFirst() {
        return currentIndex ==0;
    }
}

具体电视机遥控器类：TCL

public class TCLInterator implements TVInterator{

    private int currentIndex = 0;
    private Object obj[];

    public TCLInterator(Object[] obj) {
        this.obj = obj;
    }

    @Override
    public void setChannel(int i) {
        currentIndex = i;
    }

    @Override
    public Object currentChannel() {
        return obj[currentIndex];
    }

    @Override
    public void next() {
        if (currentIndex < obj.length){
            currentIndex ++;
        }
    }

    @Override
    public void previous() {
        if (currentIndex > 0){
            currentIndex --;
        }
    }

    @Override
    public boolean isLast() {
        return currentIndex == obj.length;
    }

    @Override
    public boolean isFirst() {
        return currentIndex ==0;
    }
}

客户类

public class Client {

    public static void display(Television tv){
        TVInterator interator = tv.createInterator();
        System.out.println("电视机频道：");
        while (!interator.isLast()){
            System.out.println(interator.currentChannel().toString());
            interator.next();
        }
    }
    public static void reverseDisplay(Television tv){
        TVInterator interator = tv.createInterator();
        interator.setChannel(6);
        System.out.println("逆向遍历电视机频道：");
        while (!interator.isFirst()){
            interator.previous();
            System.out.println(interator.currentChannel().toString());
        }
    }

    public static void main(String a[]) {
        Television tv = (Television) XMLUtil.getBean();
        display(tv);
        System.out.println("===============");
        reverseDisplay(tv);
    }

}

案例分析

如果需要增加一个新的具体聚合类，只需增加一个新的聚合子类和一个新的具体迭代器类即可，原有类库代码无须修改，符合开闭原则
如果需要更换一个迭代器，只需要增加一个新的具体迭代器类作为抽象迭代器类的子类，重新实现遍历方法即可，原有迭代器代码无须修改，也符合开闭原则
如果要在迭代器中增加新的方法，则需要修改抽象迭代器的源代码，这将违背开闭原则

五、模式分析

聚合对象的两个职责：
- 存储数据，聚合对象的基本职责
- 遍历数据，既是可变化的，又是可分离的
将遍历数据的行为从聚合对象中分离出来，封装在迭代器对象中
由迭代器来提供遍历聚合对象内部数据的行为，简化聚合对象的设计，更符合单一职责原则

六、总结

模式优点

支持以不同的方式遍历一个聚合对象，在同一个聚合对象上可以定义多种遍历方式
简化了聚合类
由于引入了抽象层，增加新的聚合类和迭代器类都很方便，无须修改原有代码，符合开闭原则

模式缺点

在增加新的聚合类时需要对应地增加新的迭代器类，类的个数成对增加，这在一定程度上增加了系统的复杂性
抽象迭代器的设计难度较大，需要充分考虑到系统将来的扩展。在自定义迭代器时，创建一个考虑全面的抽象迭代器并不是一件很容易的事情

使用情形

访问一个聚合对象的内容而无须暴露它的内部表示
需要为一个聚合对象提供多种遍历方式
为遍历不同的聚合结构提供一个统一的接口，在该接口的实现类中为不同的聚合结构提供不同的遍历方式，而客户端可以一致性地操作该接口

热门相关：无量真仙神的礼物梦回大明春法医王妃不好当！朕是红颜祸水