设计模式之迭代器模式

Posted 2021-08-15 二木成林

概述

在现实生活以及程序设计中，经常要访问一个聚合对象中的各个元素，如“数据结构”中的链表遍历，通常的做法是将链表的创建和遍历都放在同一个类中，但这种方式不利于程序的扩展，如果要更换遍历方法就必须修改程序源代码，这违背了 “开闭原则”。

既然将遍历方法封装在聚合类中不可取，那么聚合类中不提供遍历方法，将遍历方法由用户自己实现是否可行呢？答案是同样不可取，因为这种方式会存在两个缺点：

1. 暴露了聚合类的内部表示，使其数据不安全；
2. 增加了客户的负担。

“迭代器模式”能较好地克服以上缺点，它在客户访问类与聚合类之间插入一个迭代器，这分离了聚合对象与其遍历行为，对客户也隐藏了其内部细节，且满足“单一职责原则”和“开闭原则”，如Java 中的 Collection、List、Set、Map 等都包含了迭代器。

迭代器模式在生活中应用的比较广泛，比如：物流系统中的传送带，不管传送的是什么物品，都会被打包成一个个箱子，并且有一个统一的二维码。这样我们不需要关心箱子里是什么，在分发时只需要一个个检查发送的目的地即可。再比如，我们平时乘坐交通工具，都是统一刷卡或者刷脸进站，而不需要关心是男性还是女性、是残疾人还是正常人等信息。

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

结构

迭代器模式是通过将聚合对象的遍历行为分离出来，抽象成迭代器类来实现的，其目的是在不暴露聚合对象的内部结构的情况下，让外部代码透明地访问聚合的内部数据。

迭代器模式主要包含以下角色：

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

其UML类图如下：

各实现代码如下：

• Iterator.java

/**
 * @author lcl100
 * @create 2021-07-17 21:08
 * @desc 迭代器接口
 */
public interface Iterator {
    /**
     * 获取第一个元素
     *
     * @return 返回第一个元素
     */
    Object first();

    /**
     * 获取下一个元素
     *
     * @return 返回下一个元素
     */
    Object next();

    /**
     * 判断是否有下一个元素
     *
     * @return 如果有则返回true，否则返回false
     */
    boolean hasNext();
}

• ConcreteIterator.java

/**
 * @author lcl100
 * @create 2021-07-17 21:10
 * @desc 具体迭代器
 */
public class ConcreteIterator implements Iterator {
    private List<Object> list = null;
    private int index = 0;

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

    @Override
    public Object first() {
        return list.get(0);
    }

    @Override
    public Object next() {
        if (this.hasNext()) {
            return list.get(index++);
        }
        return null;
    }

    @Override
    public boolean hasNext() {
        return index < list.size();
    }
}

• Aggregate.java

/**
 * @author lcl100
 * @create 2021-07-17 21:15
 * @desc 抽象聚合接口
 */
public interface Aggregate {
    /**
     * 添加元素
     *
     * @param obj 待添加的元素
     */
    public void add(Object obj);

    /**
     * 删除指定元素
     *
     * @param obj 待删除的元素
     */
    public void remove(Object obj);

    /**
     * 获取迭代器
     *
     * @return 返回迭代器
     */
    public Iterator getIterator();
}

• ConcreteAggregate.java

/**
 * @author lcl100
 * @create 2021-07-17 21:16
 * @desc 具体聚合
 */
public class ConcreteAggregate implements Aggregate {
    private List<Object> list = new ArrayList<>();

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

    @Override
    public void remove(Object obj) {
        list.remove(obj);
    }

    @Override
    public Iterator getIterator() {
        // 返回迭代器，将传入集合
        return new ConcreteIterator(list);
    }
}

• Test.java

/**
 * @author lcl100
 * @create 2021-07-17 21:18
 * @desc 测试类
 */
public class Test {
    public static void main(String[] args) {
        Aggregate ag=new ConcreteAggregate();
        ag.add("张三");
        ag.add("李四");
        ag.add("王五");

        // 使用迭代器遍历聚合对象
        Iterator iterator = ag.getIterator();
        while (iterator.hasNext()) {
            System.out.println(iterator.next());
        }
    }
}

优缺点

迭代器模式是一种对象行为型模式，其主要优点如下。

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

其主要缺点是：

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

适用场景：

• 当需要为聚合对象提供多种遍历方式时。

• 当需要为遍历不同的聚合结构提供一个统一的接口时。

• 当访问一个聚合对象的内容而无须暴露其内部细节的表示时。

JDK源码解析

迭代器模式在JAVA的很多集合类中被广泛应用，接下来看看JAVA源码中是如何使用迭代器模式的。

List<String> list = new ArrayList<>();
Iterator<String> iterator = list.iterator(); //list.iterator()方法返回的肯定是Iterator接口的子实现类对象
while (iterator.hasNext()) {
    System.out.println(iterator.next());
}

单列集合都使用到了迭代器，我们以ArrayList举例来说明

• List：抽象聚合类

• ArrayList：具体的聚合类

• Iterator：抽象迭代器

• list.iterator()：返回的是实现了 Iterator 接口的具体迭代器对象

具体看ArrayList的代码实现：

public class ArrayList<E> extends AbstractList<E>
        implements List<E>, RandomAccess, Cloneable, java.io.Serializable {
    
    public Iterator<E> iterator() {
        return new Itr();
    }
    
    private class Itr implements Iterator<E> {
        int cursor;       // 下一个要返回元素的索引
        int lastRet = -1; // 上一个返回元素的索引
        int expectedModCount = modCount;

        Itr() {}
		
        //判断是否还有元素
        public boolean hasNext() {
            return cursor != size;
        }

        //获取下一个元素
        public E next() {
            checkForComodification();
            int i = cursor;
            if (i >= size)
                throw new NoSuchElementException();
            Object[] elementData = ArrayList.this.elementData;
            if (i >= elementData.length)
                throw new ConcurrentModificationException();
            cursor = i + 1;
            return (E) elementData[lastRet = i];
        }
        ...
}

在 iterator 方法中返回了一个实例化的 Iterator 对象。Itr是一个内部类，它实现了 Iterator 接口并重写了其中的抽象方法。

当我们在使用JAVA开发的时候，想使用迭代器模式的话，只要让我们自己定义的容器类实现java.util.Iterable并实现其中的iterator()方法使其返回一个 java.util.Iterator 的实现类就可以了。