设计模式之迭代器模式

迭代器模式

迭代器模式（Iterator Pattern）是常用的设计模式，属于行为模式。迭代器模式提供了一种遍历集合元素的统一接口，用一致的方法遍历集合元素，不需要知道集合对象的底层表示，即不暴露其内部的结构。

如果我们的集合元素是用不同的方式实现的，有数组，还有 java 的集合类，或者还有其他方式，当客户端要遍 历这些集合元素的时候就要使用多种遍历方式，而且还会暴露元素的内部结构，可以考虑使用迭代器模式解决。

迭代器的四个角色

• Iterator（抽象迭代器）：迭代器接口，有hasNext()、next()、remove等方法。
• ConcreateIterator（具体迭代器）：具体的迭代器类，管理迭代。
• Aggregate（抽象聚集角色）：统一的聚合接口，将客户端和具体聚合解耦。
• ConcreteAggregate（具体聚集角色）：具体的聚合持有对象集合，并提供一个方法，返回一个具体的迭代器实例，该迭代器可以正确地遍历集合。

代码实现

Iterator：迭代器接口

里面定义了三个方法，hasNext()、next()、remove。也可以根据自己的需求，增加First()获取第一个元素，Last()获取最后元素，CurrentItem()获取当前索引元素等其他功能。

package cn.personalweb.iterator;

public interface Iterator {

    /**
     * 遍历的下一个元素
     * @return 遍历到的元素
     */
    public Object next();

    /**
     * 判断是否还有下一个元素
     * @return 有返回 true,否则 false
     */
    public boolean hasNext();

    /**
     * 删除当前索引位置的元素,也就是当前元素
     * @return 删除成功返回 true, 否则 false
     */
    public boolean remove();
}

ConcreteIterator：具体的迭代器

具体的迭代器实现的Iterator接口，里面增加了三个属性，分别是list、index和size。list是储存元素的容器，可以是数组，列表和链表等，这里为了方便大家的理解，直接采用了java 内置的List方便对容器进行操作。index和size也是为了操作容器的。

然后就是实现三个方法，这个也是根据你自己定义的容器来的，为了方便理解，我也是直接使用了List提供的方法来实现的。

package cn.personalweb.iterator;

import java.util.ArrayList;
import java.util.List;

public class ConcreteIterator implements Iterator{

    private List list = new ArrayList();
    /**
     * 当前索引位置
     */
    private int index = 0;
    private int size;


    public ConcreteIterator(List list) {
        this.list = list;
        this.size = list.size();
    }

    @Override
    public Object next() {
        Object object = null;
        if (index >= 0 && index < list.size()) {
            object = list.get(index++);
        }
        return object;
    }

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

    @Override
    public boolean remove() {
        try {
            list.remove(--index);
            size--;
            return true;
        } catch (IndexOutOfBoundsException e) {
            return false;
        }
    }
}

Aggregate：抽象聚合接口

抽象聚合接口也定义了三个方法，代码里有注释，这里就不赘述了。

package cn.personalweb.iterator;

public interface Aggregate {

    /**
     * 添加元素
     * @param object 元素对象
     */
    public void add(Object object);

    /**
     * 通过元素对象删除指定元素
     * @param object 需要删除的元素对象
     */
    public void remove(Object object);

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

ConcreteAggregate：具体聚合类

具体聚合类实现了Aggregate接口的方法。

getIterator()方法通过创建一个新的具体迭代器，然后将容器(list)传给它，来获取一个迭代器。

package cn.personalweb.iterator;

import java.util.ArrayList;
import java.util.List;

public class ConcreteAggregate implements Aggregate{

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

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

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

    @Override
    public Iterator getIterator() {
        return new ConcreteIterator(this.list);
    }
}

Client：客户端

package cn.personalweb.iterator;

public class Client {
    public static void main(String[] args) {
        ConcreteAggregate concreteAggregate = new ConcreteAggregate();
        
        // 添加元素
        concreteAggregate.add("a");
        concreteAggregate.add("b");
        concreteAggregate.add("c");
        concreteAggregate.add("d");
        
        // 移除 c 元素
        concreteAggregate.remove("c");
        
        // 获取迭代器
        Iterator iterator = concreteAggregate.getIterator();
        while (iterator.hasNext()) {
            System.out.println(iterator.next());
        }

        // 移除当前索引指向的元素, 也就是最后一个元素.
        boolean remove = iterator.remove();
        System.out.println("是否移除成功:" + remove);

    }
}

输出结果

a
b
d
是否移除成功:true

迭代器模式的注意事项和细节

优点

1. 提供一个统一的方法遍历对象，客户不用再考虑聚合的类型，使用一种方法就可以遍历对象了。

2. 隐藏了聚合的内部结构，客户端要遍历聚合的时候只能取到迭代器，而不会知道聚合的具体组成。

3. 提供了一种设计思想，就是一个类应该只有一个引起变化的原因（叫做单一责任原则）。在聚合类中，我们把 迭代器分开，就是要把管理对象集合和遍历对象集合的责任分开，这样一来集合改变的话，只影响到聚合对象。 而如果遍历方式改变的话，只影响到了迭代器。

4. 当要展示一组相似对象，或者遍历一组相同对象时使用, 适合使用迭代器模式

缺点

1. 每个聚合对象都要一个迭代器，会生成多个迭代器不好管理类

---

参考资料：

尚硅谷 Java 设计模式课程笔记。