Iterator — 迭代器模式

Tue, 07 Aug 2018 22:38:21 +0800

1. 意圖

提供一種方式，讓外部程式碼可依序存取聚合物件的元素，而不需要知道其底層結構。

2. UML 類圖

classDiagram
    class Iterable~T~ {
        <>
        +iterator() Iterator~T~
    }
    class Iterator~T~ {
        <>
        +hasNext() boolean
        +next() T
        +remove()
    }
    class ConcreteCollection {
        -elements List~T~
        +iterator() Iterator~T~
    }
    class ConcreteIterator {
        -index int
        +hasNext() boolean
        +next() T
    }
    Iterable <|.. ConcreteCollection
    Iterator <|.. ConcreteIterator
    ConcreteCollection --> ConcreteIterator : creates

3. 何時用 / 何時別用

用：

需要為自訂資料結構（樹、圖、分頁資料）提供統一遍歷介面
需要支援多種遍歷方式（正序、逆序、層序）
想讓自訂集合可用 enhanced for-loop（只需實作 Iterable）

別用：

直接使用 JDK 集合時，Stream 通常比自訂 Iterator 更簡潔
資料集合固定且簡單，直接 index 迴圈反而更直覺

4. Java 範例

// 自訂範圍迭代器，避免 int[] 陣列浪費記憶體
public class Range implements Iterable<Integer> {
    private final int start;
    private final int end;   // exclusive

    public Range(int start, int end) {
        this.start = start;
        this.end   = end;
    }

    @Override
    public Iterator<Integer> iterator() {
        return new Iterator<>() {
            private int current = start;

            @Override public boolean hasNext() { return current < end; }
            @Override public Integer next() {
                if (!hasNext()) throw new NoSuchElementException();
                return current++;
            }
        };
    }
}

// 使用 enhanced for-loop
for (int n : new Range(1, 6)) {
    System.out.print(n + " "); // 1 2 3 4 5
}

// 轉成 Stream
StreamSupport.stream(new Range(1, 6).spliterator(), false)
    .filter(n -> n % 2 == 0)
    .forEach(System.out::println); // 2 4

5. JDK / Spring 真實案例

java.util.Iterator<T> + Iterable<T>：所有 JDK 集合實作 Iterable，enhanced for-loop 底層即呼叫 iterator()。這就是 Iterator Pattern 的標準 Java 實作。

Iterator on Bill.Lin's Notes

Iterator — 迭代器模式

1. 意圖

2. UML 類圖

3. 何時用 / 何時別用

4. Java 範例

5. JDK / Spring 真實案例