设计模式之迭代器模式

一、简介

迭代器（Iterator）模式的定义：提供一个对象来顺序访问聚合对象中的一系列数据，而不暴露聚合对象的内部表示。

二、优缺点

优点：

• 访问一个聚合对象的内容而无须暴露它的内部表示。
• 遍历任务交由迭代器完成，这简化了聚合类。
• 它支持以不同方式遍历一个聚合，甚至可以自定义迭代器的子类以支持新的遍历。
• 增加新的聚合类和迭代器类都很方便，无须修改原有代码。
• 封装性良好，为遍历不同的聚合结构提供一个统一的接口。

缺点：

• 增加了类的个数，这在一定程度上增加了系统的复杂性。

三、应用场景

大多数数据结构都自带有迭代器，如Java的Iterator，故一般无需我们自己实现，除非自己实现一个数据结构。

1） 当需要为聚合对象提供多种遍历方式时。
2） 当需要为遍历不同的聚合结构提供一个统一的接口时。
3） 当访问一个聚合对象的内容而无须暴露其内部细节的表示时。

四、模式结构

1. 主要角色

• 抽象聚合（Aggregate）角色：定义存储、添加、删除聚合对象以及创建迭代器对象的接口。
• 具体聚合（ConcreteAggregate）角色：实现抽象聚合类，返回一个具体迭代器的实例。
• 抽象迭代器（Iterator）角色：定义访问和遍历聚合元素的接口，通常包含 hasNext()、first()、next() 等方法。
• 具体迭代器（Concretelterator）角色：实现抽象迭代器接口中所定义的方法，完成对聚合对象的遍历，记录遍历的当前位置。

2. UML类图

五、代码实现

1. 抽象聚合类

/**
 *
 * 抽象聚合容器
 * 集合接口，与我们常用的List接口相似
 */
public interface MyList {
    void add(String s);

    void remove(String s);

    int size();

    MyIterator<String> iterator();
}

2. 具体聚合类

/**
 * 具体聚合容器
 *  类似于ArrayList/LinkedList等实现类
 */
public class MyArrayList implements MyList {

    private List<String> list = new ArrayList<>();

    @Override
    public void add(String s) {
        list.add(s);
    }

    @Override
    public void remove(String s) {
        list.remove(s);
    }

    @Override
    public int size() {
        return list.size();
    }

    @Override
    public MyIterator<String> iterator() {
        return new MyIterator<>(list);
    }
}

3. 抽象迭代器

/**
 * 抽象迭代器类
 *  如Java中java.util包下的Iterator接口
 */
public interface Iterator<E> {
    E next();

    boolean hasNext();
}

4. 具体迭代器

/**
 * 具体迭代器，如ArrayList的内部类Itr
 */
public class MyIterator<E> implements Iterator<E> {

    private List<E> list;
    private int cursor;
    private int size;

    public MyIterator(List<E> list) {
        this.list = list;
        this.size = list.size();
    }

    @Override
    public E next() {
        E element = list.get(cursor++);
        return element;
    }

    @Override
    public boolean hasNext() {
        return cursor != size;
    }
}

5. 测试

@Test
    void test() {
        MyList list = new MyArrayList();
        for(int i = 0; i < 10; ++i){
            list.add("test" + i);
        }

        Iterator iterator = list.iterator();
        while(iterator.hasNext()){
            System.out.println(iterator.next());
        }
    }