定義

迭代器（Iterator）模式，從其英文單詞可以看出，有反覆做某件事的意思。迭代器模式常用於資料集合中，對資料集合中的資料按照順序進行遍歷。它能提供一種方法訪問一個容器物件中各個元素，而又不暴露該物件的內部細節。

問題引入

假設我們有一個書架，假設書架可以按照順序放置無數本書，現在有一個需求，那就是遍歷書架裡面的所有的書籍，將書籍的名稱打印出來。

常規的解決辦法

一般情況下，我們在用程式碼來解決該問題的時候，都是想到使用for迴圈，對書架中的每一本書進行迴圈遍歷，然後輸出名稱。這是一種比較常規的做法，考慮的問題就是為了遍歷書架中的書籍，並使用變數i來記錄當前遍歷到哪一本書了，以及將指標指向下一本書，虛擬碼如下：

List<Book> books = new ArrayList<>();
books.add(new Book("深入理解Java虛擬機器"));
books.add(new Book("深入分析Java Web技術內幕"));
books.add(new Book("Java程式設計思想"));
books.add(new Book("Linux就該這麼學"));
for (int i = 0; i < books.size(); i++) {
    System.out.println(books.get(i).getName());
}

這裡的for

語句中的i++的作用是將i的值在每一次迴圈之後就自增1，使得在遍歷的過程中就可以訪問集合中的下一本書籍，下下一本書籍，再下下一本書籍，直到遍歷完所有的書籍。如果我們考慮將i的作用進行抽象化，使其通用化，那麼就可以形成迭代器模式。

從List中獲取啟發

說到迭代器設計模式，大家肯定會想到java.util包中的集合，是的，Java中集合類中運用到了迭代器設計模式，那麼，我們在學習迭代器設計模式的時候，完全可以通過去學習集合的原始碼來學習迭代器設計模式，下面，我將從ArrayList出發，探究一下在ArrayList中如何運用的迭代器設計模式。
作為集合類的頂級介面，Collection

介面繼承了Iterable介面，Iterable介面的子介面或者實現類都具備迭代和遍歷的功能，那麼List介面繼承自Collection，自然也是具備基本的迭代功能的，那麼我們從List出發，來探究迭代器模式的運用。
List介面中有一個重寫自Collection的iterator()方法，它的返回值是一個Iterator介面的實現類物件。

那麼我們接著看ArrayList類，它實現了List介面，也實現了List介面中的iterator()方法。

那麼，針對例項化ArrayList的時候傳入的具體的泛型，可以生成其對應的迭代器，也就是說，上圖中new語句後面的Itr()創造出來的迭代器物件肯定是針對傳入的泛型的迭代器物件。我們繼續閱讀程式碼，發現Itr是ArrayList的私有內部類，它還實現了Iterator介面，也實現了基本的hasNext()方法和next()方法。

因為Itr是ArrayList的內部類，那麼Itr可以操作ArrayList的成員變數，而ArrayList作為集合，它內部的元素是儲存在變數名為elementData的Object陣列中的，整個遍歷的過程就是針對這個陣列進行遍歷的。
分析完原始碼，我們也許還是有些迷糊，那麼我們需要藉助UML類圖來描述這些介面或者類之間的關係了。

從上圖可以看出，List介面中有建立Iterator介面的實現類物件的抽象方法，而ArrayList實現了List介面，而Itr類實現了Iterator介面，且其擁有ArrayList的元素陣列，可以針對該陣列進行一系列的操作，比如遍歷。類圖可以很清晰表表現出類與類之間的關係，不太熟悉的可以去學習一下UML類圖。

手動實現迭代器設計模式

從List中獲取到迭代器設計模式實現的靈感，那麼我們需要自己手動實現自己的迭代器模式，來解決文章開始引入的遍歷書架的問題。首先，我們根據List中採用的迭代器設計模式，我們需要一個集合介面Aggregate（有“使聚集”、“聚合”的意思），該集合介面中有建立迭代器介面Iterator實現類物件的抽象方法iterator，這個迭代器介面有hasNext、next方法，用來判斷集合是否還有元素以及獲取集合元素，我們還需要具體的集合實現類，也就是具體的書架，用來承載書籍，該實現類實現了Aggregate集合的iterator方法，最後，我們還需要實現迭代器介面的具體類，它持有集合的具體的實現類，還實現了hasNext和next方法。我們將類圖設計如下所示：

根據類圖，我們可以很輕鬆地設計出基本的迭代器設計模式及的程式碼，主要程式碼如下所示：

• 集合介面Aggregate

package cn.itlemon.design.pattern.chapter01.iterator.example;

/**
 * 是需要遍歷的集合的介面
 *
 * @author jiangpingping
 * @date 2018/8/27 下午9:31
 */
public interface Aggregate<E> {

    /**
     * 返回當前集合的迭代器
     *
     * @return 當前集合的迭代器
     */
    Iterator<E> iterator();

}

該介面遵循類圖的設計，介面中包含建立Iterator介面實現類物件的方法。

• 迭代器介面Iterator

package cn.itlemon.design.pattern.chapter01.iterator.example;

/**
 * 迭代器介面
 *
 * @author jiangpingping
 * @date 2018/8/27 下午9:32
 */
public interface Iterator<E> {

    /**
     * 檢測是否有下一個元素
     *
     * @return 如果有，返回true，否則返回false
     */
    boolean hasNext();

    /**
     * 返回當前元素，並將指標指向下一個元素
     *
     * @return 當前元素
     */
    E next();

}

該迭代器介面有兩個方法，分別是判斷被遍歷的集合是否還有元素以及獲取集合中元素並將指標指向下一個元素。

• 具體的集合類BookShelf

package cn.itlemon.design.pattern.chapter01.iterator.example;

import java.util.ArrayList;

/**
 * 書架，其實就是承載書籍的集合或陣列
 *
 * @author jiangpingping
 * @date 2018/8/27 下午9:42
 */
public class BookShelf<E> implements Aggregate {

    private ArrayList<E> books;

    private int last = 0;

    public BookShelf(int initSize) {
        books = new ArrayList<>(initSize);
    }

    public E getBookAt(int index) {
        return books.get(index);
    }

    public void appendBook(E e) {
        books.add(e);
        last++;
    }

    public int getLength() {
        return last;
    }

    @Override
    public Iterator<E> iterator() {
        return new BookShelfIterator<>(this);
    }
}

getBookAt方法可以獲取指定索引位置的書籍，appendBook方法是向書架中最後一個位置新增書籍的方法，getLength方法可以得到書籍的數量，iterator方法可以獲取當前書架的迭代器實現類物件。

• 迭代器實現類BookShelfIterator

package cn.itlemon.design.pattern.chapter01.iterator.example;

/**
 * {@link BookShelf} 的迭代器
 *
 * @author jiangpingping
 * @date 2018/8/27 下午9:49
 */
public class BookShelfIterator<E> implements Iterator<E> {

    private BookShelf<E> bookShelf;

    private int index;

    public BookShelfIterator(BookShelf<E> bookShelf) {
        this.bookShelf = bookShelf;
        index = 0;
    }

    @Override
    public boolean hasNext() {
        return index < bookShelf.getLength();
    }

    @Override
    public E next() {
        E e = bookShelf.getBookAt(index);
        index++;
        return e;
    }
}

hasNext方法可以判斷遍歷的集合中是否還有未遍歷的元素，next方法直接獲取元素，並將在指標指向下一個元素，所以在使用List的迭代器的時候，要特別留意next方法，在每次迴圈的過程中，next方法只能使用一次，多次使用的話，單次遍歷會引起邏輯錯誤。

• 書籍類Book

package cn.itlemon.design.pattern.chapter01.iterator.example;

/**
 * 書籍的實體類
 *
 * @author jiangpingping
 * @date 2018/8/27 下午9:39
 */
public class Book {

    private String name;

    public Book(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }

}

• 測試類Main

package cn.itlemon.design.pattern.chapter01.iterator.example;

/**
 * 測試Iterator模式的主類
 *
 * @author jiangpingping
 * @date 2018/8/27 下午10:01
 */
public class Main {

    public static void main(String[] args) {
        BookShelf<Book> bookShelf = new BookShelf<>(4);
        bookShelf.appendBook(new Book("深入理解Java虛擬機器"));
        bookShelf.appendBook(new Book("深入分析Java Web技術內幕"));
        bookShelf.appendBook(new Book("Java程式設計思想"));
        bookShelf.appendBook(new Book("Linux就該這麼學"));
        Iterator<Book> iterator = bookShelf.iterator();
        while (iterator.hasNext()) {
            Book book = iterator.next();
            System.out.println(book.getName());
        }
    }
}

看到上面的測試主類，和使用ArrayList的迭代器一模一樣，也就是說，我們手動實現了迭代器設計模式，其實，在設計過程中，所有的泛型都是使用E來進行代替的，所以這些類不僅僅適用Book的遍歷，支援其他類的遍歷，如果在將類的名稱修改一下，改成更加通用的，那麼這個迭代器就將適合更多的集合遍歷，遍歷的元素可以是其他的類物件。

淺析迭代器模式中的重要角色

任何模式都是前人積累下來的經驗，大多數模式中都有固定的角色，使用模式的時候，可以根據固定的角色來編寫程式碼，就可以輕鬆地利用上設計模式，使自己的程式碼更具有“可複用性”。接下來將淺析迭代器設計模式中的重要角色。

• Iterator（迭代器介面）
  該角色負責定義按順序逐個遍歷元素的介面（API），在本次示例中，由Iterator介面扮演了這個角色，它定義了兩個方法，hasNext和next方法，分別是判斷被遍歷的集合或者陣列是否還有下一個元素以及直接獲取元素，並將指標指向下一個元素。

• ConcreteIterator（具體的迭代器）
  該角色實現了Iterator所定義的介面（API），在本次示例中，由BookShelfIterator類來扮演了這個角色，它持有需要遍歷的陣列或者集合的具體資訊，也就是說需要被遍歷的集合存在於這個迭代器中。

• Aggregate（集合）
  該角色負責定義建立Iterator角色的介面（API），這個介面會創建出一個Iterator的實現類物件，這個實現類物件可以對實現Aggregate集合介面類物件進行遍歷。本次示例中，由Aggregate介面來扮演這個角色。

• ConcreteAggregate（具體的集合）
  該角色負責實現Aggregate所定義的介面（API），它會創建出具體的Iterator角色，也就是ConcreteIterator角色。在本次示例中，由BookShelf扮演了這個角色，它實現類iterator方法。

迭代器設計模式UML類圖

為什麼要使用迭代器設計模式

為什麼在遍歷的時候要額外引入迭代器這種複雜的模式呢？

也許你有這樣的疑問，引入迭代器設計模式的一個重要理由是：將實現和遍歷進行了分離，也就是說遍歷的過程完全不依賴與你所選擇的集合是如何實現的，在示例中，使用的ArrayList來承載資料的，如果開發者換了其他的容器來承載資料，那麼只需要修改集合的實現方式即可，完全不需要去修改遍歷的過程程式碼，這就提高了程式碼的“可複用性”和“可靠性”。