Java中的Iterable与Iterator，for-in
Java中的Iterable与Iterator，for-in
这样做的原因是 Java 5 引入了一个名为 Iterable 的接口，该接口包含一个能够生成 Iterator 的 iterator() 方法。
forin 使用此 Iterable 接口来遍历序列。因此，如果创建了任何实现了 Iterable 的类，都可以将它用于 forin 语句中：
-----《Thinking In Java》
And that is how we know the Earth to banana-shaped.
最后一点fon-in 刚开始没有看懂哈哈，不过问了个大佬，弄清楚了。看下反编译代码，一下发现新大陆。不过这里的源码是语法糖（syntactic sugar）点击查看详情。
for-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();
Boolean remove();
}
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循环。
深入探讨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()使用该迭代器。
实现自己的迭代器()
在 Java 5 中，许多类都是 Iterable ，主要包括所有的 Collection 类（但不包括各种 Maps ）。 例如，下面的代码可以显示所有的操作系统环境变量：
---《Thinking in java》
我们现在有一个自定义类ArrayMap，现在如果对其进行如下for-in遍历：
ArrayMap<String, Integer> am = new ArrayMap<>();
am.put("hello", 5);
am.put("wuroc", 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()方法中返回的类型不匹配。并且重写必须在一个类里面。
作者：WuHepeng
出处：https://www.cnblogs.com/WLCYSYS/p/13788170.html
本文版权归作者和博客园共有，欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出原文连接，否则保留追究法律责任的权利。
