详解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()方法中返回的类型不匹配。