Iterator(迭代器)的用法及其背後機制的探究

Iterator 怎麼使用？有什麼特點？

Java中的Iterator功能比較簡單，並且只能單向移動：

(1) 使用方法iterator()要求容器返回一個Iterator。第一次呼叫Iterator的next()方法時，它返回序列的第一個元素。注意：iterator()方法是java.lang.Iterable介面,被Collection繼承。

(2) 使用next()獲得序列中的下一個元素。

(3) 使用hasNext()檢查序列中是否還有元素。

(4) 使用remove()將迭代器新返回的元素刪除。

Iterator是Java迭代器最簡單的實現，為List設計的ListIterator具有更多的功能，它可以從兩個方向遍歷List，也可以從List中插入和刪除元素。

 Iterator 和 ListIterator 有什麼區別？

• Iterator可用來遍歷Set和List集合，但是ListIterator只能用來遍歷List。 

• Iterator對集合只能是前向遍歷，ListIterator既可以前向也可以後向。 

• ListIterator實現了Iterator介面，幷包含其他的功能，比如：增加元素，替換元素，獲取前一個和後一個元素的索引，等等。

 

迭代器是一種設計模式，它是一個物件，它可以遍歷並選擇序列中的物件，而開發人員不需要了解該序列的底層結構。迭代器通常被稱為“輕量級”物件，因為建立它的代價小。

　　Java中的Iterator功能比較簡單，並且只能單向移動：

　　(1) 使用方法iterator()要求容器返回一個Iterator。第一次呼叫Iterator的next()方法時，它返回序列的第一個元素。注意：iterator()方法是java.lang.Iterable介面,被Collection繼承。

　　(2) 使用next()獲得序列中的下一個元素。

　　(3) 使用hasNext()檢查序列中是否還有元素。

　　(4) 使用remove()將迭代器新返回的元素刪除。

只要看看下面這個例子就一清二楚了：

import java.util.*;

public class Muster {



    public static void main(String[] args) {

        ArrayList list = new ArrayList();

        list.add("a");

        list.add("b");

        list.add("c");

        Iterator it = list.iterator();

        while(it.hasNext()){

            String str = (String) it.next();

            System.out.println(str);

        }

    }

}

 

執行結果：

a
b
c

可以看到，Iterator可以不用管底層資料具體是怎樣儲存的，都能夠通過next()遍歷整個List。

但是，具體是怎麼實現的呢？背後機制究竟如何呢？

這裡我們來看看Java裡AbstractList實現Iterator的原始碼：

public abstract class AbstractList<E> extends AbstractCollection<E> implements List<E> { // List介面實現了Collection<E>, Iterable<E>



   protected AbstractList() { 

   } 

  ... 

  public Iterator<E> iterator() { 

     return new Itr();  // 這裡返回一個迭代器

  } 



  private class Itr implements Iterator<E> {  // 內部類Itr實現迭代器

    
  int cursor = 0; 
  int lastRet = -1; 
  int expectedModCount = modCount; 



  public boolean hasNext() {  // 實現hasNext方法

      return cursor != size(); 
  } 


   public E next() {  // 實現next方法

      checkForComodification(); 
       try { 

          E next = get(cursor); 
          lastRet = cursor++; 
           return next; 

        } catch (IndexOutOfBoundsException e) { 

     checkForComodification(); 
     throw new NoSuchElementException(); 

   } 

 } 


  public void remove() {
            if (lastRet < 0)
                throw new IllegalStateException();
            checkForComodification();

            try {
                AbstractList.this.remove(lastRet);
                if (lastRet < cursor)
                    cursor--;
                lastRet = -1;
                expectedModCount = modCount;
            } catch (IndexOutOfBoundsException e) {
                throw new ConcurrentModificationException();
            }
  }

  final void checkForComodification() {
            if (modCount != expectedModCount)
                throw new ConcurrentModificationException();
  }
  
}

這部分程式碼不難看懂，唯一難懂的是remove操作裡涉及到的expectedModCount = modCount;可以看到，實現next()是通過get(cursor)，然後cursor++，通過這樣實現遍歷。

在網上查到說這是集合迭代中的一種“快速失敗”機制，這種機制提供迭代過程中集合的安全性。

從原始碼裡可以看到增刪操作都會使modCount++，通過和expectedModCount的對比，迭代器可以快速的知道迭代過程中是否存在list.add()類似的操作，存在的話快速失敗!

在第一個例子基礎上新增一條語句：

import java.util.*;

public class Muster {


    public static void main(String[] args) {

        ArrayList list = new ArrayList();

        list.add("a");

        list.add("b");

        list.add("c");

        Iterator it = list.iterator();

        while(it.hasNext()){

            String str = (String) it.next();

            System.out.println(str);

            list.add("s");        //新增一個add方法

        }

    }

}

這就會丟擲一個下面的異常，迭代終止。執行結果：
Exception in thread "main" java.util.ConcurrentModificationException
　　at java.util.ArrayList$Itr.checkForComodification(Unknown Source)
　　at java.util.ArrayList$Itr.next(Unknown Source)
　　at com.hasse.Muster.main(Muster.java:11)

 

關於modCount，API解釋如下：

The number of times this list has been structurally modified. Structural modifications are those that change the size of the list, or otherwise perturb it in such a fashion that iterations in progress may yield incorrect results.

也就是說，modCount記錄修改此列表的次數：包括改變列表的結構，改變列表的大小，打亂列表的順序等使正在進行迭代產生錯誤的結果。

Tips:僅僅設定元素的值並不是結構的修改

我們知道的是ArrayList是執行緒不安全的，如果在使用迭代器的過程中有其他的執行緒修改了List就會丟擲ConcurrentModificationException，這就是Fail-Fast機制。