设计模式（十七）迭代器模式

迭代器模式

迭代器模式（Iterator Pattern）是 Java 和 .Net 编程环境中非常常用的设计模式。这种模式用于顺序访问集合对象的元素，不需要知道集合对象的底层表示。

迭代器模式属于行为型模式。

介绍

意图 ：提供一种方法顺序访问一个聚合对象中各个元素, 而又无须暴露该对象的内部表示。

主要解决 ：不同的方式来遍历整个整合对象。

何时使用 ：遍历一个聚合对象。

如何解决 ：把在元素之间游走的责任交给迭代器，而不是聚合对象。

关键代码 ：定义接口：hasNext, next。

应用实例 ：JAVA 中的 iterator。

优点 ： 1、它支持以不同的方式遍历一个聚合对象。 2、迭代器简化了聚合类。 3、在同一个聚合上可以有多个遍历。 4、在迭代器模式中，增加新的聚合类和迭代器类都很方便，无须修改原有代码。

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

使用场景 ： 1、访问一个聚合对象的内容而无须暴露它的内部表示。 2、需要为聚合对象提供多种遍历方式。 3、为遍历不同的聚合结构提供一个统一的接口。

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

实现

我们将创建一个叙述导航方法的 Iterator 接口和一个返回迭代器的 Container 接口。实现了 Container 接口的实体类将负责实现 Iterator 接口。

IteratorPatternDemo，我们的演示类使用实体类 NamesRepository 来打印 NamesRepository 中存储为集合的 Names。

步骤 1

创建接口:

Iterator.java

package demo01;

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

/**
 * @Description:
 * @Author: lay
 * @Date: Created in 14:12 2018/12/12
 * @Modified By:IntelliJ IDEA
 */
public interface Iterator<E> {
    boolean hasNext();
    E next();
}

Container.java

package demo01;

/**
 * @Description:
 * @Author: lay
 * @Date: Created in 14:22 2018/12/12
 * @Modified By:IntelliJ IDEA
 */
public interface Container<E> {
    Iterator<E>  getIterator();
}

步骤 2

创建实现了 Container 接口的实体类。该类有实现了 Iterator 接口的内部类 NameIterator。

NameRepository.java

package demo01;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.ConcurrentModificationException;
import java.util.NoSuchElementException;

/**
 * @Description:
 * @Author: lay
 * @Date: Created in 14:24 2018/12/12
 * @Modified By:IntelliJ IDEA
 */
public class NameRepository implements Container<String> {
    private static final int DEFAULT_CAPACITY = 10;
    public static final String[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA={};
    private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;

    private String[] names;

    private int size;

    public NameRepository() {
        this.names=DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }

    public void add(String name){
        ensureCapacityInternal(size + 1);
        names[size++]=name;
    }
    public String get(int index){
        if (index >= size){
            throw new IndexOutOfBoundsException("Index: "+index+", Size: "+size);
        }
        return names[index];
    }
    public int size(){
        return size;
    }

    private void ensureCapacityInternal(int minCapacity) {
        if (names == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
            minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
        }

        ensureExplicitCapacity(minCapacity);
    }

    private void ensureExplicitCapacity(int minCapacity) {
        // overflow-conscious code
        if (minCapacity - names.length > 0)
            grow(minCapacity);
    }

    private void grow(int minCapacity) {
        // overflow-conscious code
        int oldCapacity = names.length;
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        if (newCapacity - minCapacity < 0)
            newCapacity = minCapacity;
        if (newCapacity - MAX_ARRAY_SIZE > 0)
            newCapacity = hugeCapacity(minCapacity);
        // minCapacity is usually close to size, so this is a win:
        names = Arrays.copyOf(names, newCapacity);
    }

    private static int hugeCapacity(int minCapacity) {
        if (minCapacity < 0) // overflow
            throw new OutOfMemoryError();
        return (minCapacity > MAX_ARRAY_SIZE) ? Integer.MAX_VALUE : MAX_ARRAY_SIZE;
    }

    @Override
    public Iterator<String> getIterator() {
        return new NameIterator();
    }

    private class NameIterator implements Iterator<String>{
        int cursor;

        @Override
        public boolean hasNext() {
            return  cursor != size;
        }

        @Override
        public String next() {
            int i = cursor;
            if (i >= size)
                throw new NoSuchElementException();
            String[] names = NameRepository.this.names;
            if (i >= names.length)
                throw new ConcurrentModificationException();
            cursor = i + 1;
            return names[i];
        }
    }
}

步骤 3

使用 NameRepository 来获取迭代器，并打印名字。

IteratorPatternDemo.java

package demo01;

/**
 * @Description:
 * @Author: lay
 * @Date: Created in 14:59 2018/12/12
 * @Modified By:IntelliJ IDEA
 */
public class IteratorPatternDemo {
    public static void main(String[] args) {
        NameRepository nameRepository = new NameRepository();
        nameRepository.add("Robbert");
        nameRepository.add("John");
        nameRepository.add("Julie");
        nameRepository.add("Lora");
        Iterator<String> iterator = nameRepository.getIterator();
        while(iterator.hasNext()){
            System.out.println(iterator.next());
        }
    }
}

步骤 4

执行程序，输出结果：

Name : Robert
Name : John
Name : Julie
Name : Lora