1. 程式人生 > 實用技巧 >Java中的Iterable與Iterator,for-in

Java中的Iterable與Iterator,for-in

Java中的Iterable與Iterator詳解

這樣做的原因是 Java 5 引入了一個名為 Iterable 的介面,該介面包含一個能夠生成 Iterator 的 iterator() 方法。

for­in 使用此 Iterable 介面來遍歷序列。因此,如果建立了任何實現了 Iterable 的類,都可以將它用於 for­in 語句中:

                                          -----《Thinking In Java》

最後一點fon-in 剛開始沒有看懂哈哈,不過問了個大佬,弄清楚了。看下反編譯程式碼,一下發現新大陸。

在Java中,我們可以對List集合進行如下幾種方式的遍歷:

List<Integer> list = new ArrayList<>();
list.add(5);
list.add(23);
list.add(42);
for (int i = 0; i < list.size(); i++) {
    System.out.print(list.get(i) + ",");
}

Iterator it = list.iterator();
while (it.hasNext()) {
    System.out.print(it.next() + ",");
}

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

第一種就是普通的for迴圈,第二種為迭代器遍歷,第三種是for-in迴圈。後面兩種方式涉及到Java中的iterator和iterable物件,接下來我們來看看這兩個物件的區別以及如何在自定義類中實現for-in迴圈。

Iterator與Iterable

Iterator,是能夠對集合進行迭代遍歷的底層依賴。而iterable接口裡定義了返回iterator()方法,相當於對Iterator的封裝,同時實現了Iterable介面的類,可以支援for-in迴圈。

iterator內部細節

jdk中Iterator介面主要方法如下:

public interface Iterator<E> {
	boolean hasNext();
  	E next();
}

iterator通過以上兩個方法定義了對集合迭代訪問的方法,而具體的實現方式依賴於不同的實現類,具體的集合類實現Iterator介面中的方法以實現迭代。

可以發現,在List中並沒有實現Iterator介面,而是實現的Iterable介面。進一步觀察Iterable介面的原始碼可以發現其只是返回了一個Iterator物件。

public interface Iterable<T> {
  Iterator<T> iterator();
}

所以我們可以使用如下方式來對List進行迭代了(通過呼叫iterator()方法)

Iterator it = list.iterator();
while (it.hasNext()) {
    System.out.print(it.next() + ",");
}

同時實現了Iterable介面的還可以使用for-in迴圈。

for-in原理

其實for-in迴圈內部也是依賴於Iterator迭代器,只不過Java提供的語法糖,Java編譯器會將其轉化為Iterator迭代器方式遍歷。我們對以下for-in迴圈進行反編譯:

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

反編譯後:

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

可以看到Java的for-in增強迴圈是通過iterator迭代器方式實現的。

深入探討Iterable與Iterator關係

有一個問題,為什麼不直接將hasNext(),next()方法放在Iterable介面中,其他類直接實現就可以了?

原因是有些集合類可能不止一種遍歷方式,實現了Iterable的類可以再實現多個Iterator內部類,例如LinkedList中的ListItrDescendingIterator兩個內部類,就分別實現了雙向遍歷和逆序遍歷。通過返回不同的Iterator實現不同的遍歷方式,這樣更加靈活。如果把兩個介面合併,就沒法返回不同的Iterator實現類了。ListItr相關原始碼如下:

    public ListIterator<E> listIterator(int index) {
        checkPositionIndex(index);
        return new ListItr(index);
    }

    private class ListItr implements ListIterator<E> {
		...
        ListItr(int index) {
            // assert isPositionIndex(index);
            next = (index == size) ? null : node(index);
            nextIndex = index;
        }

        public boolean hasNext() {
            return nextIndex < size;
        }
    	...

如上所示可以通過呼叫list.listIterator()方法返回iterator迭代器(list.iterator()只是其預設實現)

DescendingIterator原始碼如下:

    public Iterator<E> descendingIterator() {
        return new DescendingIterator();
    }
    private class DescendingIterator implements Iterator<E> 	{
        private final ListItr itr = new ListItr(size());
        public boolean hasNext() {
            return itr.hasPrevious();
        }
        public E next() {
            return itr.previous();
        }
        public void remove() {
            itr.remove();
        }
    }

同樣可以通過list.descendingIterator()使用該迭代器。

實現自己的迭代器

我們現在有一個自定義類ArrayMap,現在如果對其進行如下for-in遍歷:

ArrayMap<String, Integer> am = new ArrayMap<>();
am.put("hello", 5);
am.put("syrups", 10);

for (String s: am) {
   System.out.println(s);
}

由於我們並沒有實現hashNext和next抽象方法,所以無法對其進行遍歷。

自定義迭代器類

我們首先自定義一個迭代器類實現hashNext和next方法,並將其作為ArrayMap的內部類,相關程式碼如下:

   public class KeyIterator implements Iterator<K> {
        private int ptr;

        public KeyIterator() {
            ptr = 0;
        }

        @Override
        public boolean hasNext() {
            return (ptr != size);
        }

        @Override
        public K next() {
            K returnItem = keys[ptr];
            ptr += 1;
            return returnItem;
        }
    }

可以看到我們在next中指定的遍歷規則是根據ArrayMap的key值進行遍歷。有了上述迭代器類,我們就可以使用iterator方式在外部對其進行遍歷了,遍歷程式碼如下:

ArrayMap<String, Integer> am = new ArrayMap<>();
am.put("hello", 5);
am.put("syrups", 10);
ArrayMap.KeyIterator ami = am.new KeyIterator();
while (ami.hasNext()) {
    System.out.println(ami.next());
}

如上所示,通過建立KeyIterator物件進行迭代訪問(注意外部類建立內部類物件的方式)。

支援for-in迴圈

現在還不能支援for-in迴圈訪問,因為我們還沒有實現iterable介面,首先在ArrayMap中實現Iterable介面:

public class ArrayMap<K, V> implements Iterable<K> {

    private K[] keys;
    private V[] values;
    int size;

    public ArrayMap() {
        keys = (K[]) new Object[100];
        values = (V[]) new Object[100];
        size = 0;
    }
  ....
}

然後重寫iterator()方法,並在其中返回我們自己的迭代器物件(iterator)

    @Override
    public Iterator<K> iterator() {
        return new KeyIterator();
    }

注意我們自定義的KeyIterator類必須要實現Iterator介面,否則在iterator()方法中返回的型別不匹配。

總結與感想