迭代器模式

迭代器模式（Iterator Pattern），提供一种方法顺序访问一个聚合对象中各个元素，而又不暴露该对象的内部。迭代器模式属于行为型模式。

模式定义

迭代器模式就是分离了集合对象的遍历行为，抽象出一个迭代器类来负责，这样既可以做到不暴露集合的内部结构，又可让外部代码透明地访问集合内部的数据。

模式结构

首先看下结构图：

image

Iterator迭代器接口类

public interface Iterator {

    //得到下一个对象
    Object next();

    //判断是否有下一个对象
    boolean hasNext();

}

Aggregate聚集抽象类

public interface Aggregate {
    
    //添加
    void add(Object object);

    //创建迭代器
    Iterator createIterator();

}

ConcreteIterator具体迭代器类，实现Iterator

public class ConcreteIterator implements Iterator {

    private List list;
    private int currentIndex = 0;

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

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

    @Override
    public boolean hasNext() {
        if (currentIndex == list.size()) {
            return false;
        }
        return true;
    }

}

ConcreteAggregate集体聚集类，继承Aggregate

public class ConcreteAggregate implements Aggregate {

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

    @Override
    public Iterator createIterator() {
        return new ConcreteIterator(items);
    }

    public void add(Object object) {
        items.add(object);
    }

}

客户端代码

public class Client {

    public static void main(String[] args) {
        Aggregate aggregate = new ConcreteAggregate();
        aggregate.add(1);
        aggregate.add(2);
        aggregate.add(3);
        aggregate.add(4);

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

    }

}

运行结果

1
2
3
4

模式实现

在java中有一个Iterable接口，实现该接口的类就是可迭代的，并且支持增强for循环。该接口只有一个方法即获取迭代器的方法iterator()，可以获取每个容易自身的迭代器Iterator。

public interface Iterable<T> {
    //返回迭代器对象
    Iterator<T> iterator();
}

Iterator接口中的方法。

public interface Iterator<E> {
    //是否有下一个元素
    boolean hasNext();
    //下一个元素
    E next();
    //将删除上次调用next方法时返回的元素，如果想要删除指定位置上的元素，需要越过这个元素
    //next方法和remove方法是相互依赖的，如果调用remove方法之前没有调用next将是不合法的，
    //将会抛出IllegalStateException异常
    void remove()；
}

Collection继承了Iterable接口，所以Collection体系都具备获取自身迭代器的方法，只不过每个子类集合都进行了重写（因为数据结构不同）。

接下来我们主要看下ArrayList中是怎么实现的。

    //调用ArrayList的该方法返回内部实现Iterator接口的Itr对象
    public Iterator<E> iterator() {
        return new Itr();
    }

   private class Itr implements Iterator<E> {
        //下一个元素的下标
        int cursor;       // index of next element to return
        int lastRet = -1; // index of last element returned; -1 if no such
        int expectedModCount = modCount;

        Itr() {}
        
        public boolean hasNext() {
            //如果下一个元素的下表不等于容器中元素的实际大小，返回true代表有下一个元素
            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;
            //返回列表中当前下标的元素，并对lastRet赋值
            return (E) elementData[lastRet = i];
        }

        public void remove() {
            //如果lastRet小于0代表没调用过next()方法，抛出异常
            if (lastRet < 0)
                throw new IllegalStateException();
            //检查被迭代的对象是否被修改过
            checkForComodification();

            try {
                //根据调用next()给lastRet赋值的下标去删除元素
                ArrayList.this.remove(lastRet);
                //因为删除元素后容器内元素实际大小减1，给cursor赋值未加1前的下标
                cursor = lastRet;
                //lastRet重置
                lastRet = -1;
                //更新expectedModCount的值
                expectedModCount = modCount;
            } catch (IndexOutOfBoundsException ex) {
                throw new ConcurrentModificationException();
            }
        }
        
        final void checkForComodification() {
            if (modCount != expectedModCount)
                throw new ConcurrentModificationException();
        }
    }

checkForComodification()方法检查所迭代的列表对象是否被修改过，modCount是外部类的一个字段，当调用外部类的add，remove，ensureCapacity等方法，都会改变该字段的值，而expectedModCount是内部类Itr初始化时，使用modCount赋值的字段。这样，在使用迭代器过程中，如果正在对正在迭代的对象调用了add，remvoe，ensureCapacity等方法，再去调用迭代器的next方法，就会引发ConcurrentModificationException异常了。

代码示例

    @Test
    public void test2() {
        List list = new ArrayList();
        list.add(1);
        list.add(2);
        list.add(3);
        
        Iterator iterator = list.iterator();
        //while遍历
        while (iterator.hasNext()) {
            System.out.println(iterator.next());

        }
    }

运行结果

1
2
3

如果如上面所说在循环过程中修改list的列表对象，看是否会引发异常。我们队上面代码简单修改一下。

    @Test
    public void test2() {
        List list = new ArrayList();
        list.add(1);
        list.add(2);
        list.add(3);

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

1

java.util.ConcurrentModificationException
    at java.util.ArrayList$Itr.checkForComodification(ArrayList.java:909)
    at java.util.ArrayList$Itr.next(ArrayList.java:859)
    at com.lwx.arraylist.ArrayListTest.test2(ArrayListTest.java:40)

可以看出在遍历第二个元素调用next()方法时，就会引发异常。

模式的优缺点

优点

  • 在迭代器模式中，增加新的聚合类和迭代器类都很方便，无须修改原有代码。
  • 它支持以不同的方式遍历一个聚合对象。

缺点

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

模式使用场景

当你需要对聚集有多种方式遍历时，可以考虑用迭代器模式。不过大多数高级语言都对它进行了封装，所以给人感觉这种模式本身不太常用了。

文章作者:leisurexi

新博客地址:https://leisurexi.github.io

许可协议: 署名-非商业性使用-禁止演绎 4.0 国际 转载请保留原文链接及作者。

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 204,921评论 6赞 478
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 87,635评论 2赞 381
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 151,393评论 0赞 338
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,836评论 1赞 277
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,833评论 5赞 368
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,685评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 38,043评论 3赞 399
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,694评论 0赞 258
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 42,671评论 1赞 300
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,670评论 2赞 321
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,779评论 1赞 332
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,424评论 4赞 321
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 39,027评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,984评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,214评论 1赞 260
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 45,108评论 2赞 351
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,517评论 2赞 343