Java中的Iterable與Iterator詳解

在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 each循環。後面兩種方式涉及到Java中的iterator和iterable對象,接下來我們來看看這兩個對象的區別以及如何在自定義類中實現for each循環。

Iterator與Iterable
iterator爲Java中的迭代器對象,是能夠對List這樣的集合進行迭代遍歷的底層依賴。而iterable接口裏定義了返回iterator的方法,相當於對iterator的封裝,同時實現了iterable接口的類可以支持for each循環。

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 each循環。

for each原理

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

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 each增強循環是通過iterator迭代器方式實現的。

深入探討Iterable與Iterator關係

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

原因是有些集合類可能不止一種遍歷方式,實現了Iterable的類可以再實現多個Iterator內部類,例如LinkedList中的ListItr和DescendingIterator兩個內部類,就分別實現了雙向遍歷和逆序遍歷。通過返回不同的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 each遍歷:

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 each循環

現在還不能支持for each循環訪問,因爲我們還沒有實現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()方法中返回的類型不匹配。

總結與感想
(1)學會深入思考,一點點抽絲剝繭,多想想爲什麼這樣實現,很多問題沒有自己想象中的那麼複雜。

(2)遇到疑惑不放棄,這是提升自己最好的機會,遇到某個疑難的點,解決的過程中會挖掘出很多相關東西。

參考資料:

(1)CS61B

(2)for each實現原理

(3)Iterable與iterator區別 歡迎工作一到五年的Java工程師朋友們加入Java羣: 891219277
羣內提供免費的Java架構學習資料(裏面有高可用、高併發、高性能及分佈式、Jvm性能調優、Spring源碼,MyBatis,Netty,Redis,Kafka,Mysql,Zookeeper,Tomcat,Docker,Dubbo,Nginx等多個知識點的架構資料)合理利用自己每一分每一秒的時間來學習提升自己,不要再用"沒有時間“來掩飾自己思想上的懶惰!趁年輕,使勁拼,給未來的自己一個交代!

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章