迭代器修改元素_设计模型系列—迭代器模式

作者公众号：一角钱技术(org_yijiaoqian)

前言

• 23种设计模式速记
• 单例(singleton)模式
• 工厂方法(factory method)模式
• 抽象工厂(abstract factory)模式
• 建造者/构建器(builder)模式
• 原型(prototype)模式
• 享元(flyweight)模式
• 外观(facade)模式
• 适配器(adapter)模式
• 装饰(decorator)模式
• 观察者(observer)模式
• 策略(strategy)模式
• 桥接(bridge)模式
• 模版方法(template method)模式
• 责任链(chain of responsibility)模式
• 组合(composite)模式
• 代理(proxy)模式
• 备忘录(memento)模式
• 命令(command)模式
• 状态(state)模式
• 中介者(mediator)模式
• 持续更新中......

23种设计模式快速记忆的请看上面第一篇，本篇和大家一起来学习迭代器模式相关内容。

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

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

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

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

模式定义

提供一个对象来顺序访问聚合对象中的一系列数据，而不暴露聚合对象的内部表示。迭代器模式是一种对象行为型模式。

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

解决的问题

不同的方式来遍历整个整合对象。

模式组成

使用步骤

步骤1：定义抽象迭代器角色。迭代器角色负责定义访问和遍历元素的接口，一般包括3个方法，即访问下一个元素next()，元素是否已经访问到底部hasNext()，以及删除当前指向的元素remove()。

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

步骤2：定义具体迭代器角色。

class ConcreteIterator implements Iterator {    private List list = null;    private int index = -1;    public ConcreteIterator(List list) {        this.list = list;    }    public boolean hasNext() {        if (index 

步骤3：定义抽象聚合角色。

interface Aggregate {    public void add(Object obj);    public void remove(Object obj);    public Iterator getIterator();}

步骤4：定义具体聚合角色。

class ConcreteAggregate implements Aggregate {    private List list = new ArrayList();    public void add(Object obj) {        list.add(obj);    }    public void remove(Object obj) {        list.remove(obj);    }    public Iterator getIterator() {        return (new ConcreteIterator(list));    }}

步骤5：测试

聚合的内容有：北京 上海 深圳 First：北京

优点

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

缺点

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

应用场景

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

由于聚合与迭代器的关系非常密切，所以大多数语言在实现聚合类时都提供了迭代器类，因此大数情况下使用语言中已有的聚合类的迭代器就已经够了。

模式的扩展

迭代器模式常常与组合模式结合起来使用，在对组合模式中的容器构件进行访问时，经常将迭代器潜藏在组合模式的容器构成类中。当然，也可以构造一个外部迭代器来对容器构件进行访问，其结构如下：

源码中的应用

Java 中的容器对象有很多，基本都涉及到迭代器，我们以 ArrayList 作为例子，剖析它是如何应用迭代器模式的。

Java集合框架：List, Set, Map 都支持迭代

ArrayList 源码可以发现：

• ArrayList 实现了 List 接口，使用 Object 数组存储元素；
• 在 List 接口中定义了 iterator() 以及很多对操作集合的方法；
• 在 ArrayList 中对 iterator() 进行了重写，并返回一个 Itr 对象；
• Itr 是 ArrayList 的内部类，并且实现了 Iterator 接口。

部分源码展示

List接口

public interface List extends Collection { Iterator iterator();}

Iterator接口

public interface Iterator {  boolean hasNext(); E next(); default void remove() {        throw new UnsupportedOperationException("remove");    }}

ArrayList类和Itr类

public class ArrayList extends AbstractList        implements List, RandomAccess, Cloneable, java.io.Serializable{ public Iterator iterator() {        return new Itr();    } //Itr内部类 private class Itr implements Iterator {        int cursor;       // index of next element to return        int lastRet = -1; // index of last element returned; -1 if no such        int expectedModCount = modCount;        public boolean hasNext() {            return cursor != size;        }        @SuppressWarnings("unchecked")        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];        }        public void remove() {            if (lastRet  consumer) {            Objects.requireNonNull(consumer);            final int size = ArrayList.this.size;            int i = cursor;            if (i >= size) {                return;            }            final Object[] elementData = ArrayList.this.elementData;            if (i >= elementData.length) {                throw new ConcurrentModificationException();            }            while (i != size && modCount == expectedModCount) {                consumer.accept((E) elementData[i++]);            }            // update once at end of iteration to reduce heap write traffic            cursor = i;            lastRet = i - 1;            checkForComodification();        }        final void checkForComodification() {            if (modCount != expectedModCount)                throw new ConcurrentModificationException();        }    }}

PS：以上代码提交在 Github ：

https://github.com/Niuh-Study/niuh-designpatterns.git

文章持续更新，可以公众号搜一搜「 一角钱技术 」第一时间阅读， 本文 GitHub org_hejianhui/JavaStudy 已经收录，欢迎 Star。