在Java中，我們可以對(duì)List集合進(jìn)行如下幾種方式的遍歷：

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循環(huán)，第二種為迭代器遍歷，第三種是for each循環(huán)。

后面兩種方式涉及到Java中的iterator和iterable對(duì)象，接下來(lái)我們來(lái)看看這兩個(gè)對(duì)象的區(qū)別以及如何在自定義類中實(shí)現(xiàn)for each循環(huán)。

Iterator與Iterable

iterator為Java中的迭代器對(duì)象，是能夠?qū)ist這樣的集合進(jìn)行迭代遍歷的底層依賴。而iterable接口里定義了返回iterator的方法，相當(dāng)于對(duì)iterator的封裝，同時(shí)實(shí)現(xiàn)了iterable接口的類可以支持for each循環(huán)。

iterator內(nèi)部細(xì)節(jié)

jdk中Iterator接口主要方法如下：

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

iterator通過(guò)以上兩個(gè)方法定義了對(duì)集合迭代訪問(wèn)的方法，而具體的實(shí)現(xiàn)方式依賴于不同的實(shí)現(xiàn)類，具體的集合類實(shí)現(xiàn)Iterator接口中的方法以實(shí)現(xiàn)迭代。

可以發(fā)現(xiàn)，在List中并沒(méi)有實(shí)現(xiàn)Iterator接口，而是實(shí)現(xiàn)的Iterable接口。進(jìn)一步觀察Iterable接口的源碼可以發(fā)現(xiàn)其只是返回了一個(gè)Iterator對(duì)象。

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

所以我們可以使用如下方式來(lái)對(duì)List進(jìn)行迭代了（通過(guò)調(diào)用iterator()方法）

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

同時(shí)實(shí)現(xiàn)了Iterable接口的還可以使用for each循環(huán)。

for each原理

其實(shí)for each循環(huán)內(nèi)部也是依賴于Iterator迭代器，只不過(guò)Java提供的語(yǔ)法糖，Java編譯器會(huì)將其轉(zhuǎn)化為Iterator迭代器方式遍歷。我們對(duì)以下for each循環(huán)進(jìn)行反編譯：

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增強(qiáng)循環(huán)是通過(guò)iterator迭代器方式實(shí)現(xiàn)的。

深入探討Iterable與Iterator關(guān)系

有一個(gè)問(wèn)題，為什么不直接將hasNext()，next()方法放在Iterable接口中，其他類直接實(shí)現(xiàn)就可以了？

原因是有些集合類可能不止一種遍歷方式，實(shí)現(xiàn)了Iterable的類可以再實(shí)現(xiàn)多個(gè)Iterator內(nèi)部類，例如LinkedList中的ListItr和DescendingIterator兩個(gè)內(nèi)部類，就分別實(shí)現(xiàn)了雙向遍歷和逆序遍歷。通過(guò)返回不同的Iterator實(shí)現(xiàn)不同的遍歷方式，這樣更加靈活。如果把兩個(gè)接口合并，就沒(méi)法返回不同的Iterator實(shí)現(xiàn)類了。ListItr相關(guān)源碼如下：

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;
  }
  ...

如上所示可以通過(guò)調(diào)用list.listIterator()方法返回iterator迭代器（list.iterator()只是其默認(rèn)實(shí)現(xiàn)）

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();
  }
}

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

實(shí)現(xiàn)自己的迭代器

我們現(xiàn)在有一個(gè)自定義類ArrayMap，現(xiàn)在如果對(duì)其進(jìn)行如下for each遍歷：

ArrayMap<String, Integer> am = new ArrayMap<>();
am.put("hello", 5);
am.put("syrups", 10);
 
for (String s: am) {
  System.out.println(s);
}

由于我們并沒(méi)有實(shí)現(xiàn)hashNext和next抽象方法，所以無(wú)法對(duì)其進(jìn)行遍歷。

自定義迭代器類

我們首先自定義一個(gè)迭代器類實(shí)現(xiàn)hashNext和next方法，并將其作為ArrayMap的內(nèi)部類，相關(guān)代碼如下:

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;
   }
 }

可以看到我們?cè)趎ext中指定的遍歷規(guī)則是根據(jù)ArrayMap的key值進(jìn)行遍歷。有了上述迭代器類，我們就可以使用iterator方式在外部對(duì)其進(jìn)行遍歷了，遍歷代碼如下：

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());
}

如上所示，通過(guò)創(chuàng)建KeyIterator對(duì)象進(jìn)行迭代訪問(wèn)（注意外部類創(chuàng)建內(nèi)部類對(duì)象的方式）。

支持for each循環(huán)

現(xiàn)在還不能支持for each循環(huán)訪問(wèn)，因?yàn)槲覀冞€沒(méi)有實(shí)現(xiàn)iterable接口，首先在ArrayMap中實(shí)現(xiàn)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()方法，并在其中返回我們自己的迭代器對(duì)象(iterator)

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

注意我們自定義的KeyIterator類必須要實(shí)現(xiàn)Iterator接口，否則在iterator()方法中返回的類型不匹配。

最新評(píng)論