Java 數據結構：Iterator 需要注意的點

前言

Java 集合框架

Iterator 是 Java 數據結構框架的起始，它是一個頂級接口，夢開始的地方。

讓這個迭代器作為頂級接口可能是出于功能的考慮，不管怎樣的數據結構，都需要遍歷不是。那么就需要提供一種可以用來遍歷的方式，讓開發者使用也讓 JVM 認識。

一、前世今生

JDK 1.0 的 Enumeration，因名字太長和方法數量有點少不太好擴展被廢棄。

JDK 1.2 推出 Iterator 替代。

Iterator JDK 1.8

public interface Iterator<E> {
    // 是否包含下一元素
    boolean hasNext();
    // 下一元素
    E next();
    // 移除元素
    default void remove() {
        throw new UnsupportedOperationException("remove");
    }
    // 遍歷剩余元素，游標之后的
    default void forEachRemaining(Consumer<? super E> action) {
        Objects.requireNonNull(action);
        while (hasNext())
            action.accept(next());
}

用來遍歷元素，且遍歷的過程中可以刪除。

  • hasNext() 是否含有下一個元素；
  • next() 獲取下一元素；
  • remove() 移除某元素；
  • forEachRemaining() 遍歷當前迭代器尚未遍歷的元素。

二、一致性

遍歷過程中可以修改原數據的稱為弱一致性，不可修改的為強一致性。下面舉兩個例子：

1. 強一致性

數據修改過程中會記錄操作次數 modCount，遍歷過程發現該值與期望的不一致，會拋出 ConcurrentModificationException 異常。

常見的有 HashMap、ArrayList。

HashMap.HashIterator # nextNode

final Node<K,V> nextNode() {
    Node<K,V>[] t;
    Node<K,V> e = next;
    if (modCount != expectedModCount) // 就是這里
        throw new ConcurrentModificationException();
    if (e == null)
        throw new NoSuchElementException();
    if ((next = (current = e).next) == null && (t = table) != null) {
        do {} while (index < t.length && (next = t[index++]) == null);
    }
    return e;
}

ArrayList.Itr # next()

public E next() {
    if (modCount != expectedModCount) // 此處表現
        throw new ConcurrentModificationException();
    int i = cursor;
    if (i >= limit)
        throw new NoSuchElementException();
    Object[] elementData = ArrayList.this.elementData;
    if (i >= elementData.length)
        throw new ConcurrentModificationException();
    cursor = i + 1;
    return (E) elementData[lastRet = i];
}

這種強一致性的迭代器官稱為 fail-fast 迭代器。

2. 弱一致性

弱一致性相當于創建時做一個數據的拷貝，因為操作的不是原數據，所以不會出現問題也沒用拋異常。

但是弱一致性帶來一些問題：

  • 空間浪費，因為是復制嘛；
  • 數據不一致，如果遍歷過程中原數據進行了修改，操作的結果可能與想要的發生差異。

弱一致性的有 CopyOnWriteArrayList、ConcurrentHashMap。

CopyOnWriteArrayList.COWIterator # next()

public E next() {
    if (! hasNext())
        throw new NoSuchElementException();
    // snapshot 是創建時用當時數據賦值的，相當于拷貝副本
    return (E) snapshot[cursor++];
}

三、迭代器種類

1. 線性迭代器

  • 持有一個游標 cursor 用來記錄當前遍歷到的位置；
  • 可以正序、倒序遍歷；
  • 可以查找前后元素；
  • 可以調用 add() set() 添加和修改數據，兩者都是往當前迭代器遍歷下標處新增和修改。

比如 ArrayList 的 Itr 就是一種線性迭代器。

private class Itr implements Iterator<E> {
    // Android 添加 limit 參數，也就是當前數據長度作為臨界值
    protected int limit = ArrayList.this.size;

    int cursor;       // 游標
    int lastRet = -1; // 最后一個返回的元素，默認 -1
    int expectedModCount = modCount;

    public boolean hasNext() {
        return cursor < limit;
    }

    // 下一元素
    public E next() {
        if (modCount != expectedModCount)
            throw new ConcurrentModificationException();
        int i = cursor;
        if (i >= limit)
            throw new NoSuchElementException();
        Object[] elementData = ArrayList.this.elementData;
        if (i >= elementData.length)
            throw new ConcurrentModificationException();
        cursor = i + 1;
        return (E) elementData[lastRet = i];
    }
    // 移除元素
    public void remove() {
        if (lastRet < 0)
            throw new IllegalStateException();
        if (modCount != expectedModCount)
            throw new ConcurrentModificationException();

        try {
            ArrayList.this.remove(lastRet);
            cursor = lastRet;
            lastRet = -1;
            expectedModCount = modCount;
            limit--;
        } catch (IndexOutOfBoundsException ex) {
            throw new ConcurrentModificationException();
        }
    }
    // 遍歷剩余元素
    @Override
    @SuppressWarnings("unchecked")
    public void forEachRemaining(Consumer<? super E> consumer) {
        Objects.requireNonNull(consumer);
        final int size = ArrayList.this.size;
        int i = cursor;
        if (i >= size) {
            return;
        }
        final Object[] elementData = ArrayList.this.elementData;
        if (i >= elementData.length) {
            throw new ConcurrentModificationException();
        }
        while (i != size && modCount == expectedModCount) {
            consumer.accept((E) elementData[i++]);
        }
        // update once at end of iteration to reduce heap write traffic
        cursor = i;
        lastRet = i - 1;

        if (modCount != expectedModCount)
            throw new ConcurrentModificationException();
    }
}
}

2. 鏈式迭代器 HashIterator

  • 持有一個遍歷結點、當前遍歷下標；

HashMap 的迭代器就是一種實現 HashIterator。

abstract class HashIterator {
    Node<K,V> next;        // 下一個要返回的結點
    Node<K,V> current;     // 當前結點
    int expectedModCount;  // for fast-fail 強一致性
    int index;             // current slot 當前下標

    HashIterator() {
        expectedModCount = modCount; // 創建時賦值
        Node<K,V>[] t = table; // table 是 HashMap 的數據
        current = next = null;
        index = 0;
        if (t != null && size > 0) { // advance to first entry
            do {} while (index < t.length && (next = t[index++]) == null);
        }
    }

    public final boolean hasNext() {
        return next != null;
    }

    final Node<K,V> nextNode() {
        Node<K,V>[] t;
        Node<K,V> e = next;
        if (modCount != expectedModCount)
            throw new ConcurrentModificationException();
        if (e == null)
            throw new NoSuchElementException();
        // 遍歷查找，直到下面結點為 null 或 表為空
        if ((next = (current = e).next) == null && (t = table) != null) {
            do {} while (index < t.length && (next = t[index++]) == null);
        }
        return e;
    }

    public final void remove() {
        Node<K,V> p = current;
        if (p == null)
            throw new IllegalStateException();
        if (modCount != expectedModCount)
            throw new ConcurrentModificationException();
        current = null;
        K key = p.key;
        removeNode(hash(key), key, null, false, false);
        expectedModCount = modCount;
    }
}

final class KeyIterator extends HashIterator
    implements Iterator<K> {
    public final K next() { return nextNode().key; }
}

final class ValueIterator extends HashIterator
    implements Iterator<V> {
    public final V next() { return nextNode().value; }
}

final class EntryIterator extends HashIterator
    implements Iterator<Map.Entry<K,V>> {
    public final Map.Entry<K,V> next() { return nextNode(); }
}

四、總結和其它

Iterable 接口

如果想讓某個 Object 可以使用 "for-each loop" 也就是增強 for 循環，需要實現 Iterable 接口。

public interface Iterable<T> {
    /**
     * Returns an iterator over elements of type {@code T}.
     * @return an Iterator.
     */
    Iterator<T> iterator();
}

也就是說，想要使用增強 for 循環，必須實現該接口并提供迭代器。如果使用沒有實現該接口的類進行循環，編譯器會報錯。

實例

List<Integer> list = new ArrayList<>();
list.add(1);

for (Integer i : list) {
    System.out.print(i);
}

ArrayList 最終繼承了 Iterable 所以可以遍歷，那么這個增強 for 循環反編譯之后：

Integer i;
for(Iterator iterator = list.iterator(); iterator.hasNext(); System.out.println(i)){
   i = (Integer)iterator.next();        
}

可以看到其實是使用迭代器進行遍歷的操作，不斷給變量 i 賦值并打印。

注意

因為 Java 有 fail-fast 機制，使用增強 for 循環時要考慮所遍歷對象的一致性。使用某些強一致性的結構如 ArrayList，如果要操作數據應使用迭代器：

List<Student> students = new ArrayList<>();
...
Iterator<Student> stuIter = students.iterator();    
while (stuIter.hasNext()) {    
   Student student = stuIter.next();    
   if (student.getId() == 2) {
         // 這里要使用Iterator的remove方法移除當前對象
         // 如果使用List的remove方法，則會出現ConcurrentModificationException    
         stuIter.remove();
    }   
}

總結

  • 實現 Iterable 以提供迭代器，實現循環功能；
  • 迭代器可以用來遍歷、指定位置插入、移除數據；
  • 使用可迭代數據結構，要注意其一致性；
  • 無論是線性還是鏈式迭代器，主要是依靠內部維護的游標（下標）來標記當前遍歷位置。
?著作權歸作者所有,轉載或內容合作請聯系作者
  • 人面猴
    序言：七十年代末，一起剝皮案震驚了整個濱河市，隨后出現的幾起案子，更是在濱河造成了極大的恐慌，老刑警劉巖，帶你破解...
    沈念sama閱讀 227,572評論 6贊 531
  • 死咒
    序言：濱河連續發生了三起死亡事件，死亡現場離奇詭異，居然都是意外死亡，警方通過查閱死者的電腦和手機，發現死者居然都...
    沈念sama閱讀 98,071評論 3贊 414
  • 救了他兩次的神仙讓他今天三更去死
    文/潘曉璐 我一進店門，熙熙樓的掌柜王于貴愁眉苦臉地迎上來，“玉大人，你說我怎么就攤上這事。” “怎么了？”我有些...
    開封第一講書人閱讀 175,409評論 0贊 373
  • 道士緝兇錄：失蹤的賣姜人
    文/不壞的土叔 我叫張陵，是天一觀的道長。 經常有香客問我，道長，這世上最難降的妖魔是什么？ 我笑而不...
    開封第一講書人閱讀 62,569評論 1贊 307
  • ?港島之戀（遺憾婚禮）
    正文 為了忘掉前任，我火速辦了婚禮，結果婚禮上，老公的妹妹穿的比我還像新娘。我一直安慰自己，他們只是感情好，可當我...
    茶點故事閱讀 71,360評論 6贊 404
  • 惡毒庶女頂嫁案：這布局不是一般人想出來的
    文/花漫 我一把揭開白布。 她就那樣靜靜地躺著，像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上，一...
    開封第一講書人閱讀 54,895評論 1贊 321
  • 城市分裂傳說
    那天，我揣著相機與錄音，去河邊找鬼。 笑死，一個胖子當著我的面吹牛，可吹牛的內容都是我干的。 我是一名探鬼主播，決...
    沈念sama閱讀 42,979評論 3贊 440
  • 雙鴛鴦連環套：你想象不到人心有多黑
    文/蒼蘭香墨 我猛地睜開眼，長吁一口氣：“原來是場噩夢啊……” “哼！你這毒婦竟也來了？” 一聲冷哼從身側響起，我...
    開封第一講書人閱讀 42,123評論 0贊 286
  • 萬榮殺人案實錄
    序言：老撾萬榮一對情侶失蹤，失蹤者是張志新（化名）和其女友劉穎，沒想到半個月后，有當地人在樹林里發現了一具尸體，經...
    沈念sama閱讀 48,643評論 1贊 333
  • ?護林員之死
    正文 獨居荒郊野嶺守林人離奇死亡，尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,559評論 3贊 354
  • ?白月光啟示錄
    正文 我和宋清朗相戀三年，在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,742評論 1贊 369
  • 活死人
    序言：一個原本活蹦亂跳的男人離奇死亡，死狀恐怖，靈堂內的尸體忽然破棺而出，到底是詐尸還是另有隱情，我是刑警寧澤，帶...
    沈念sama閱讀 38,250評論 5贊 356
  • ?日本核電站爆炸內幕
    正文 年R本政府宣布，位于F島的核電站，受9級特大地震影響，放射性物質發生泄漏。R本人自食惡果不足惜，卻給世界環境...
    茶點故事閱讀 43,981評論 3贊 346
  • 男人毒藥：我在死后第九天來索命
    文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧，春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,363評論 0贊 25
  • 一樁弒父案，背后竟有這般陰謀
    文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至，卻和暖如春，著一層夾襖步出監牢的瞬間，已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,622評論 1贊 280
  • 情欲美人皮
    我被黑心中介騙來泰國打工， 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留，地道東北人。 一個月前我還...
    沈念sama閱讀 51,354評論 3贊 390
  • 代替公主和親
    正文 我出身青樓，卻偏偏與公主長得像，于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子，可洞房花燭夜當晚...
    茶點故事閱讀 47,707評論 2贊 370