5 JDK内置迭代器
为了让开发人员能够更加方便地操作聚合对象,在Java、C#等编程语言中都提供了内置迭代器。在Java集合框架中,常用的List和Set等聚合类都继承(或实现)了java.util.Collection接口,在Collection接口中声明了如下方法(部分):
package java.util;
public interface Collection extends Iterable {
……
boolean add(Object c);
boolean addAll(Collection c);
boolean remove(Object o);
boolean removeAll(Collection c);
boolean remainAll(Collection c);
Iterator iterator();
……
}
除了包含一些增加元素和删除元素的方法外,还提供了一个iterator()方法,用于返回一个Iterator迭代器对象,以便遍历聚合中的元素;具体的Java聚合类可以通过实现该iterator()方法返回一个具体的Iterator对象。
JDK中定义了抽象迭代器接口Iterator,代码如下所示:
package java.util;
public interface Iterator {
boolean hasNext();
E next();
void remove();
}
其中,hasNext()用于判断聚合对象中是否还存在下一个元素,为了不抛出异常,在每次调用next()之前需先调用hasNext(),如果有可供访问的元素,则返回true;next()方法用于将游标移至下一个元素,通过它可以逐个访问聚合中的元素,它返回游标所越过的那个元素的引用;remove()方法用于删除上次调用next()时所返回的元素。
Java迭代器工作原理如图5所示,在第一个next()方法被调用时,迭代器游标由“元素1”与“元素2”之间移至“元素2”与“元素3”之间,跨越了“元素2”,因此next()方法将返回对“元素2”的引用;在第二个next()方法被调用时,迭代器由“元素2”与“元素3”之间移至“元素3”和“元素4”之间,next()方法将返回对“元素3”的引用,如果此时调用remove()方法,即可将“元素3”删除。
图5 Java迭代器示意图
如下代码片段可用于删除聚合对象中的第一个元素:
Iterator iterator = collection.iterator(); //collection是已实例化的聚合对象
iterator.next(); // 跳过第一个元素
iterator.remove(); // 删除第一个元素
需要注意的是,在这里,next()方法与remove()方法的调用是相互关联的。如果调用remove()之前,没有先对next()进行调用,那么将会抛出一个IllegalStateException异常,因为没有任何可供删除的元素。
如下代码片段可用于删除两个相邻的元素:
iterator.remove();
iterator.next(); //如果删除此行代码程序将抛异常
iterator.remove();
在上面的代码片段中如果将代码iterator.next();去掉则程序运行抛异常,因为第二次删除时将找不到可供删除的元素。
在JDK中,Collection接口和Iterator接口充当了迭代器模式的抽象层,分别对应于抽象聚合类和抽象迭代器,而Collection接口的子类充当了具体聚合类,下面以List为例加以说明,图6列出了JDK中部分与List有关的类及它们之间的关系:
图****6 Java****集合框架中部分类结构图
(注:为了简化类图,本图省略了大量方法)
在JDK中,实际情况比图6要复杂很多,在图6中,List接口除了继承Collection接口的iterator()方法外,还增加了新的工厂方法listIterator(),专门用于创建ListIterator类型的迭代器,在List的子类LinkedList中实现了该方法,可用于创建具体的ListIterator子类ListItr的对象,代码如下所示:
public ListIterator listIterator(int index) {
return new ListItr(index);
}
listIterator()方法用于返回具体迭代器ListItr类型的对象。在JDK源码中,AbstractList中的iterator()方法调用了listIterator()方法,如下代码所示:
public Iterator iterator() {
return listIterator();
}
客户端通过调用LinkedList类的iterator()方法,即可得到一个专门用于遍历LinkedList的迭代器对象。
大家可能会问?既然有了iterator()方法,为什么还要提供一个listIterator()方法呢?这两个方法的功能不会存在重复吗?干嘛要多此一举?
这是一个好问题。我给大家简单解释一下为什么要这样设计:由于在Iterator接口中定义的方法太少,只有三个,通过这三个方法只能实现正向遍历,而有时候我们需要对一个聚合对象进行逆向遍历等操作,因此在JDK的ListIterator接口中声明了用于逆向遍历的hasPrevious()和previous()等方法,如果客户端需要调用这两个方法来实现逆向遍历,就不能再使用iterator()方法来创建迭代器了,因为此时创建的迭代器对象是不具有这两个方法的。我们只能通过如下代码来创建ListIterator类型的迭代器对象:
ListIterator i = c.listIterator();
正因为如此,在JDK的List接口中不得不增加对listIterator()方法的声明,该方法可以返回一个ListIterator类型的迭代器,ListIterator迭代器具有更加强大的功能。
在Java语言中,我们可以直接使用JDK内置的迭代器来遍历聚合对象中的元素,下面的代码演示了如何使用Java内置的迭代器:
import java.util.*;
class IteratorDemo {
public static void process(Collection c) {
Iterator i = c.iterator(); //创建迭代器对象
//通过迭代器遍历聚合对象
while(i.hasNext()) {
System.out.println(i.next().toString());
}
}
public static void main(String args[]) {
Collection persons;
persons = new ArrayList(); //创建一个ArrayList类型的聚合对象
persons.add("张无忌");
persons.add("小龙女");
persons.add("令狐冲");
persons.add("韦小宝");
persons.add("袁紫衣");
persons.add("小龙女");
process(persons);
}
}
在静态方法process()中使用迭代器Iterator对Collection对象进行处理,该代码运行结果如下:
张无忌
小龙女
令狐冲
韦小宝
袁紫衣
小龙女
如果需要更换聚合类型,如将List改成Set,则只需更换具体聚合类类名,如将上述代码中的ArrayList改为HashSet,则输出结果如下:
张无忌
小龙女
令狐冲
韦小宝
袁紫衣
小龙女
在HashSet中合并了重复元素,并且元素以随机次序输出,其结果与使用ArrayList不相同。由此可见,通过使用迭代器模式,使得更换具体聚合类变得非常方便,而且还可以根据需要增加新的聚合类,新的聚合类只需要实现Collection接口,无须修改原有类库代码,符合“开闭原则”。
令狐冲
张无忌
韦小宝
小龙女
袁紫衣