004-行为型-04-迭代器模式（Iterator）

一、概述

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

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

　　迭代模式使用比较少，JDK集合也提供了Iterator的具体实现，可以直接拿来用，不必自己实现

1.1、适用场景

　　1、访问一个聚合对象的内容而无须暴露它的内部表示。

　　2、需要为聚合对象提供多种遍历方式。

　　3、为遍历不同的聚合结构提供一个统一的接口。

1.2、优缺点

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

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

1.3、类图角色及其职责

　　　

　　迭代模式的角色和职责

　　1、Iterator（迭代器接口）：

　　该接口必须定义实现迭代功能的最小定义方法集

　　比如提供hasNext()和next()方法。

　　2、ConcreteIterator（迭代器实现类）：

　　迭代器接口Iterator的实现类。可以根据具体情况加以实现。

　　3、Aggregate（容器接口）：

　　定义基本功能以及提供类似Iterator iterator()的方法。

　　4、concreteAggregate（容器实现类）：

　　容器接口的实现类。必须实现Iterator iterator()方法。

1.4、演进过程

1.4.1、初始化

创建一个容器中要存储的内容Book

public class Book {
    private String id;
    private String name;
    private double price;

    public Book(String id, String name, double price) {
        this.id = id;
        this.name = name;
        this.price = price;
    }

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public double getPrice() {
        return price;
    }

    public void setPrice(double price) {
        this.price = price;
    }

    public void display() {
        System.out.println("ID=" + id + ",\tname=" + name + ",\tprice" + price);
    }
}

创建一个容器BookList

public class BookList {
    //容器内部还是一个List，也可以用数组
    private List<Book> bookList = new ArrayList<Book>();
    private int index;

    //添加书籍
    public void addBook(Book book){
        bookList.add(book);
    }

    //删除书籍
    public void removeBook(Book book){
        int bookIndex = bookList.indexOf(book);
        bookList.remove(bookIndex);
    }

    //判断是否有下一本书
    public boolean hasNext(){
        if(index >= bookList.size()){
            return false;
        }
        return true;
    }

    //获得下一本书
    public Book getNext(){
        return bookList.get(index++);
    }

    //获取集合长度
    public int getSize(){
        return bookList.size();
    }

    //根据index获取Book
    public Book getByIndex(int index){
        return bookList.get(index);
    }
}

　　接下来，就是迭代容器了

方式一、（由容器自己实现顺序遍历。直接在容器类里直接添加顺序遍历方法）

    @Test
    public void test1() {
        BookList bookList = new BookList();

        Book book1 = new Book("001","设计模式",200);
        Book book2 = new Book("002","Java核心编程",200);
        Book book3 = new Book("003","计算机组成原理",200);

        bookList.addBook(book1);
        bookList.addBook(book2);
        bookList.addBook(book3);

        while(bookList.hasNext()){
            Book book = bookList.getNext();
            book.display();
        }
    }

输出

ID=001,    name=设计模式,    price200.0
ID=002,    name=Java核心编程,    price200.0
ID=003,    name=计算机组成原理,    price200.0

方式二、让调用者自己实现遍历。直接暴露数据细节给外部）

    @Test
    public void test2() {
        BookList bookList = new BookList();

        Book book1 = new Book("001", "设计模式", 200);
        Book book2 = new Book("002", "Java核心编程", 200);
        Book book3 = new Book("003", "计算机组成原理", 200);

        bookList.addBook(book1);
        bookList.addBook(book2);
        bookList.addBook(book3);

        for (int i = 0; i < bookList.getSize(); i++) {
            Book book = bookList.getByIndex(i);
            book.display();
        }
    }

结果同上

不使用迭代模式的缺点

　　以上方法1与方法2都可以实现对遍历，但有这些问题

　　1，容器类承担了太多功能：一方面需要提供添加删除等本身应有的功能；一方面还需要提供遍历访问功能。

　　2，往往容器在实现遍历的过程中，需要保存遍历状态，当跟元素的添加删除等功能夹杂在一起，很容易引起混乱和程序运行错误等。

应用迭代模式的条件

　　Iterator模式就是为了有效地处理按顺序进行遍历访问的一种设计模式，简单地说，Iterator模式提供一种有效的方法，可以屏蔽聚集对象集合的容器类的实现细节，而能对容器内包含的对象元素按顺序进行有效的遍历访问。

　　所以，Iterator模式的应用场景可以归纳为满足以下几个条件：

　　1、访问容器中包含的内部对象
　　2、按顺序访问

1.4.2、进化

用代码实现一下迭代模式，只需修改BookList即可，BookListIterator

public class BookListIterator {
    //容器内部还是一个List，也可以用数组
    private List<Book> bookList = new ArrayList<Book>();
    private int index;

    //添加书籍
    public void addBook(Book book){
        bookList.add(book);
    }

    //删除书籍
    public void removeBook(Book book){
        int bookIndex = bookList.indexOf(book);
        bookList.remove(bookIndex);
    }

    //获取集合长度
    public int getSize(){
        return bookList.size();
    }

    //根据index获取Book
    public Book getByIndex(int index){
        return bookList.get(index);
    }

    //得到Iterator实例
    public Iterator Iterator() {
        return new Itr();
    }

    //内部类，Iterator实例（因为要使用容器的内部信息，所以要写成内部类）
    private class Itr implements Iterator{
        //判断是否有下一本书,将刚才hasNext()中内容复制过来即可
        public boolean hasNext() {
            if(index >= bookList.size()){
                return false;
            }
            return true;
        }
        //获得下一本书,将刚才getNext()中内容复制过来即可
        public Object next() {
            return bookList.get(index++);
        }

        public void remove() {

        }
    }
}

测试

    @Test
    public void test3() {
        BookListIterator bookList = new BookListIterator();

        Book book1 = new Book("001","设计模式",200);
        Book book2 = new Book("002","Java核心编程",200);
        Book book3 = new Book("003","计算机组成原理",200);

        bookList.addBook(book1);
        bookList.addBook(book2);
        bookList.addBook(book3);

        Iterator iterator = bookList.Iterator();
        while(iterator.hasNext()){
            Book book = (Book) iterator.next();
            book.display();
        }
    }

输出同上

　　可以看到，这和使用JDK提供集合的Iterator方法就一模一样了。

二、扩展

2.1 JDK

java.util.Iterator
java.util.ArrayList中的Itr

2.2 Mybatis

org.apache.ibatis.cursor.defaults.DefaultCursor的cursorIterator

c