30分钟学透设计模式3-使用最多的Iterator模式

声明：原创文章，转载请注明出处。https://www.jianshu.com/p/23e88dfe593b

设计模式系列：
30分钟学透设计模式1-单例模式的前世今生
 30分钟学透设计模式2-随处可见的Builder模式
 30分钟学透设计模式3-使用最多的Iterator模式
 30分钟学透设计模式4-最简单的面向接口编程-简单工厂模式
 30分钟学透设计模式5-从代理模式到AOP

一、栗子

先从一个简单的栗子说起，有一个ArrayList需要遍历，通常怎么去做呢？

List<String> list = new ArrayList<String>(Arrays.asList("a", "b", "c"));
// 方法 1: foreach
for (String s : list) {
    System.out.println(s);
}
// 方法 2: for循环
for (int i = 0; i < list.size(); i++) {
    System.out.println(list.get(i));
}
// 方法 3: 迭代器
Iterator it = list.iterator();
while (it.hasNext()) {
    System.out.println(it.next());
}

这里我们不讨论这三种方法的效率，但是这几种肯定我们经常使用的。

1、但是，如下，在我们将List换成了Set之后，如果尽量不修改代码的话，这三种遍历方式有什么变化呢？

Set<String> set = new HashSet<String>(Arrays.asList("a", "b", "c"));

结论：只有方法1和方法3是可用的，因为Set不是顺序结构，不能采用for循环的方式遍历。

2、进一步，如下，在我们继续将Set换成Map之后，那现在遍历方法会怎么样呢？

Map<String, String> map = new HashMap<String, String>();

结论：方法1和3均可用，但是需要稍微修改一点。

// 方法 1
for (Map.Entry<String, String> entry: map.entrySet()) {
        System.out.println(entry.toString());
}
// 方法 3
Iterator it = map.entrySet().iterator();
while (it.hasNext()) {
    System.out.println(it.next());
}

for each这种方式遍历的对象必须是一个数组或者是一个实现了Iterator接口的对象。

无论存储结构怎么变，发现第三种遍历方式，都没有什么变化。这就是我们将要介绍的迭代器（Iterator）模式。

二、迭代器模式定义

1、定义

迭代器模式就是提供一种方法顺序访问一个聚合对象中的各个元素，而不用暴露其内部实现。在实际的开发过程中，我们可能需要针对不同的需求，以不同的方式来遍历集合对象，但不希望在集合对象的抽象接口层中充斥着各种不同的遍历操作。

通俗的讲，迭代器为集合（如Collection、List、Set、Map等）提供了统一遍历接口，提高代码复用性，并隐藏其内部实现。

2、优点

简化遍历方式，不仅可以对数组、有序表进行遍历，对Map等结构亦可。
可提供多种遍历方法。如对数组提供正序、逆序的迭代器。
迭代器简化了聚合类，而且封装性强，用户只需要得到迭代器就可以遍历，而不需要额外关注遍历算法。迭代器模式是“单一职责原则”的完美体现。

3、缺点

由于迭代器模式将存储数据和遍历数据的职责分离，增加新的聚合类需要对应增加新的迭代器类，类的个数成对增加，这在一定程度上增加了系统的复杂性。

4、使用场景

访问一个聚合对象的内容而无须暴露它的内部表示。
需要为聚合对象提供多种遍历方式。
为遍历不同的聚合结构提供一个统一的接口。

三、实现一个简单的迭代器

1、定义Iterator接口

public interface Iterator {
    Object next();
    boolean hasNext();
}

2、定义集合Container接口（类似List）

public interface Container {
    void add(Object obj);
    Iterator createIterator();
}

3、定义具体的集合类ConcreteContainer（类似ArrayList）

public class ConcreteContainer implements Container {
    private List<Object> list;

    public ConcreteContainer(List<Object> list) {
        this.list = list;
    }

    public void add(Object obj) {
        list.add(obj);
    }

    public Iterator createIterator() {
        return new ConcreteIterator();
    }

    private class ConcreteIterator implements Iterator {
        private int cursor;

        public Object next() {
            if (hasNext()) {
                return list.get(cursor++);
            }
            return null;
        }

        public boolean hasNext() {
            return cursor != list.size();
        }
    }
}

4、测试类

经过上面三个步骤，我们已经完成了一个简单版的迭代器。下面我们测试下及遍历功能。

public static void main(String[] args) {
    Container container = new ConcreteContainer(new ArrayList<Object>());
    container.add("a");
    container.add("b");
    container.add("c");

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