设计模式-迭代器模式

Posted 2021-12-07 yijinqincai

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了设计模式-迭代器模式相关的知识，希望对你有一定的参考价值。

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

模式定义

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

模式结构

首先看下结构图：

技术图片

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());
        }

    }

}

运行结果

模式实现

在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()方法时，就会引发异常。