我們常常使用 JDK 提供的迭代接口進行 Java 集合的迭代。
Iterator iterator = list.iterator(); while(iterator.hasNext()){ String string = iterator.next(); //do something }
迭代其實我們可以簡單地理解為遍歷,是一個標准化遍歷各類容器裡面的所有對象的方法類,它是一個很典型的設計模式。Iterator 模式是用於遍歷集合類的標准訪問方法。它可以把訪問邏輯從不同類型的集合類中抽象出來,從而避免向客戶端暴露集合的內部結構。 在沒有迭代器時我們都是這麼進行處理的。如下:
對於數組我們是使用下標來進行處理的:
int[] arrays = new int[10]; for(int i = 0 ; i < arrays.length ; i++){ int a = arrays[i]; //do something }
對於 ArrayList 是這麼處理的:
List<String> list = new ArrayList<String>(); for(int i = 0 ; i < list.size() ; i++){ String string = list.get(i); //do something }
對於這兩種方式,我們總是都事先知道集合的內部結構,訪問代碼和集合本身是緊密耦合的,無法將訪問邏輯從集合類和客戶端代碼中分離出來。同時每一種集合對應一種遍歷方法,客戶端代碼無法復用。 在實際應用中如何需要將上面將兩個集合進行整合是相當麻煩的。所以為了解決以上問題, Iterator 模式騰空出世,它總是用同一種邏輯來遍歷集合。使得客戶端自身不需要來維護集合的內部結構,所有的內部狀態都由 Iterator 來維護。客戶端從不直接和集合類打交道,它總是控制 Iterator,向它發送”向前”,”向後”,”取當前元素”的命令,就可以間接遍歷整個集合。
上面只是對 Iterator 模式進行簡單的說明,下面我們看看 Java 中 Iterator 接口,看他是如何來進行實現的。
在 Java 中 Iterator 為一個接口,它只提供了迭代了基本規則,在 JDK 中他是這樣定義的:對 collection 進行迭代的迭代器。迭代器取代了 Java Collections Framework 中的 Enumeration。迭代器與枚舉有兩點不同:
1、迭代器允許調用者利用定義良好的語義在迭代期間從迭代器所指向的 collection 移除元素。
2、方法名稱得到了改進。
其接口定義如下:
public interface Iterator { boolean hasNext(); Object next(); void remove(); }
其中:
Object next():返回迭代器剛越過的元素的引用,返回值是 Object,需要強制轉換成自己需要的類型
boolean hasNext():判斷容器內是否還有可供訪問的元素
void remove():刪除迭代器剛越過的元素
對於我們而言,我們只一般只需使用 next()、hasNext() 兩個方法即可完成迭代。如下:
for(Iterator it = c.iterator(); it.hasNext(); ) { Object o = it.next(); //do something }
前面闡述了 Iterator 有一個很大的優點,就是我們不必知道集合的內部結果,集合的內部結構、狀態由 Iterator 來維持,通過統一的方法 hasNext()、next() 來判斷、獲取下一個元素,至於具體的內部實現我們就不用關心了。但是作為一個合格的程序員我們非常有必要來弄清楚 Iterator 的實現。下面就 ArrayList 的源碼進行分析分析。
下面就 ArrayList 的 Iterator 實現來分析,其實如果我們理解了 ArrayList、Hashset、TreeSet 的數據結構,內部實現,對於他們是如何實現 Iterator 也會胸有成竹的。因為 ArrayList 的內部實現采用數組,所以我們只需要記錄相應位置的索引即可,其方法的實現比較簡單。
在 ArrayList 內部首先是定義一個內部類 Itr,該內部類實現 Iterator 接口,如下:
private class Itr implements Iterator<E> { //do something }
而 ArrayList 的 iterator() 方法實現:
public Iterator<E> iterator() { return new Itr(); }
所以通過使用 ArrayList.iterator() 方法返回的是 Itr() 內部類,所以現在我們需要關心的就是 Itr() 內部類的實現:
在 Itr 內部定義了三個 int 型的變量:cursor、lastRet、expectedModCount。其中 cursor 表示下一個元素的索引位置,lastRet 表示上一個元素的索引位置
int cursor; int lastRet = -1; int expectedModCount = modCount;
從 cursor、lastRet 定義可以看出,lastRet 一直比 cursor 少一所以 hasNext() 實現方法異常簡單,只需要判斷 cursor 和 lastRet 是否相等即可。
public boolean hasNext() { return cursor != size; }
對於 next() 實現其實也是比較簡單的,只要返回 cursor 索引位置處的元素即可,然後修改 cursor、lastRet 即可
public E next() { checkForComodification(); int i = cursor; //記錄索引位置 if (i >= size) //如果獲取元素大於集合元素個數,則拋出異常 throw new NoSuchElementException(); Object[] elementData = ArrayList.this.elementData; if (i >= elementData.length) throw new ConcurrentModificationException(); cursor = i + 1; //cursor + 1 return (E) elementData[lastRet = i]; //lastRet + 1 且返回cursor處元素 }
checkForComodification() 主要用來判斷集合的修改次數是否合法,即用來判斷遍歷過程中集合是否被修改過。modCount 用於記錄 ArrayList 集合的修改次數,初始化為 0,,每當集合被修改一次(結構上面的修改,內部update不算),如 add、remove 等方法,modCount + 1,所以如果 modCount 不變,則表示集合內容沒有被修改。該機制主要是用於實現 ArrayList 集合的快速失敗機制,在 Java 的集合中,較大一部分集合是存在快速失敗機制的,這裡就不多說,後面會講到。所以要保證在遍歷過程中不出錯誤,我們就應該保證在遍歷過程中不會對集合產生結構上的修改(當然 remove 方法除外),出現了異常錯誤,我們就應該認真檢查程序是否出錯而不是 catch 後不做處理。
final void checkForComodification() { if (modCount != expectedModCount) throw new ConcurrentModificationException(); }
對於 remove() 方法的是實現,它是調用 ArrayList 本身的 remove() 方法刪除 lastRet 位置元素,然後修改 modCount 即可。
public void remove() { if (lastRet < 0) throw new IllegalStateException(); checkForComodification(); try { ArrayList.this.remove(lastRet); cursor = lastRet; lastRet = -1; expectedModCount = modCount; } catch (IndexOutOfBoundsException ex) { throw new ConcurrentModificationException(); } }