本文共 7622 字,大约阅读时间需要 25 分钟。
13.6.1 迭代输出:Iterator
1.Iterator接口简介
在讲解Iterator接口之前,先向读者说一下个人的经验总结:"在使用集合输出时必须形成一个思路:'只要是碰到了集合输出的操作,就一定使用Iterator接口',因为这是最标准的做法"。
Iterator是专门的迭代输出接口,所谓的迭代输出就是将元素一个个进行判断,判断其是否有内容,如果有内容则把内容取出,如图13-3所示。
了解了其基本原理后,下面来看一下Iterator接口的定义:
1 public interface Iterator<E>
Iterator接口在使用时也需要指定泛型,当然在此处指定的泛型类型最好与集合中的泛型类型一致。此接口中定义了3个方法,如表13-8所示。
表13-8 Iterator接口中的常用方法
序号 | 方 法 | 类型 | 描 述 |
1 | public boolean hasNext() | 普通 | 判断是否有下一个值 |
2 | public E next() | 普通 | 取出当前元素 |
3 | public void remove() | 普通 | 移除当前元素 |
下面通过一些实例为读者讲解以上方法的作用,以及使用以上方法操作时的注意点。
2.Iterator接口的相关操作
(1)实例操作一:输出Collection中的全部内容
Iterator是一个接口,可以直接使用Collection接口中定义的iterator()方法为其实例化。既然Collection接口中存在了此方法,则List和Set接口中也一定存在此方法,所以也同样可以使用Iterator接口输出。
范例:进行输出
2 package org.lxh.demo13.iteratordemo;
3 import java.util.ArrayList;
4 import java.util.Iterator;
5 import java.util.List;
6 public class IteratorDemo01 {
7 public static void main(String[] args) {
8 List<String> all = new ArrayList<String>
(); // 实例化List接口9 all.add("hello");
10 // 增加元素
11 all.add("_");
12 // 增加元素
13 all.add("world");
14 // 增加元素
15 Iterator<String> iter = all.iterator(); // 直接实例化Iterator
16 接口
17 while (iter.hasNext()) { // 依次判断
18 System.out.print(iter.next() + "、"); // 输出内容
19 }
20 }
21 }
程序运行结果:
22 Hello、_、world、
以上的输出代码是Iterator的标准操作形式,将集合中的内容一个个地循环输出。此种输出也是必须掌握的形式。
(2)实例操作二:使用Iterator删除指定内容
在Iterator接口中除了可以输出内容之外,还可以删除当前的内容,直接使用remove()方法即可。
范例:删除元素
23 package org.lxh.demo13.iteratordemo;
24 import java.util.ArrayList;
25 import java.util.Iterator;
26 import java.util.List;
27 public class IteratorDemo02 {
28 public static void main(String[] args) {
29 List<String> all = new ArrayList<String>();
30 // 实例化List接口
31 all.add("hello");
32 // 增加元素
33 all.add("_");
34 // 增加元素
35 all.add("world");
36 // 增加元素
37 Iterator<String> iter = all.iterator(); // 直接实例化
38 Iterator接口
39 while (iter.hasNext()) { // 依次输出
40 String str = iter.next(); // 取出内容
41 if ("_".equals(str)) { // 判断内容是否是"_"
42 iter.remove();
43 // 删除当前元素
44 } else {
45 System.out.print(str + "、"); // 输出元素内容
46 }
47 }
48 System.out.println("\n删除之后的集合:"
+ all); // 输出集合内容,调用49 toString()方法
50 }
51 }
程序运行结果:
52 hello、world、
53 删除之后的集合:[hello, world]
(3)实例操作三:迭代输出时删除元素的注意点
正常情况下,一个集合要把内容交给Iterator输出,但是集合操作中也存在一个remove()方法,如果在使用Iterator输出时集合自己调用了删除方法,则会出现运行时的错误。
范例:不正确的删除方法
54 package org.lxh.demo13.iteratordemo;
55 import java.util.ArrayList;
56 import java.util.Iterator;
57 import java.util.List;
58 public class IteratorDemo03 {
59 public static void main(String[] args) {
60 List<String> all = new ArrayList<String>();
61 // 实例化List接口
62 all.add("hello");
63 // 增加元素
64 all.add("_");
65 // 增加元素
66 all.add("world");
67 // 增加元素
68 Iterator<String> iter = all.iterator(); // 直接实例化
69 Iterator接口
70 while (iter.hasNext()) {
71 String str = iter.next(); // 取出内容
72 if ("_".equals(str)) { // 判断内容是否是"_"
73 all.remove(str);
74 // 删除当前元素,使用
75 集合删除
76 } else {
77 System.out.print(str + "、"); // 输出元素内容
78 }
79 }
80 System.out.println("\n删除之后的集合:"
+ all); // 输出集合内容,调用81 toString()方法
82 }
83 }
程序运行结果:
84 hello、
85 删除之后的集合:[hello, world]
Iterator.remove()是删除最近(最后)使用next()方法的元素。
从迭代器指向的集合中移除迭代器返回的最后一个元素(可选操作)。每次调用 next 只能调用一次此方法。
2009-11-05 11:06:06| 分类: |字号 订阅
java.util包中包含了一系列重要的集合类。本文将从分析源码入手,深入研究一个集合类的内部结构,以及遍历集合的迭代模式的源码实现内幕。
下面我们先简单讨论一个根接口Collection,然后分析一个抽象类AbstractList和它的对应Iterator接口,并仔细研究迭代子模式的实现原理。 本文讨论的源代码版本是JDK 1.4.2,因为JDK 1.5在java.util中使用了很多泛型代码,为了简化问题,所以我们还是讨论1.4版本的代码。 集合类的根接口Collection Collection接口是所有集合类的根类型。它的一个主要的接口方法是: DE>boolean add(Object c)DE> add()方法将添加一个新元素。注意这个方法会返回一个boolean,但是返回值不是表示添加成功与否。仔细阅读doc可以看到,Collection规定:如果一个集合拒绝添加这个元素,无论任何原因,都必须抛出异常。这个返回值表示的意义是add()方法执行后,集合的内容是否改变了(就是元素有无数量,位置等变化),这是由具体类实现的。即:如果方法出错,总会抛出异常;返回值仅仅表示该方法执行后这个Collection的内容有无变化。 类似的还有: DE>boolean addAll(Collection c); boolean remove(Object o); boolean removeAll(Collection c); boolean remainAll(Collection c);DE> Object[] toArray()方法很简单,把集合转换成数组返回。Object[] toArray(Object[] a)方法就有点复杂了,首先,返回的Object[]仍然是把集合的所有元素变成的数组,但是类型和参数a的类型是相同的,比如执行: DE>String[] o = (String[])c.toArray(new String[0]);DE> 得到的o实际类型是String[]。 其次,如果参数a的大小装不下集合的所有元素,返回的将是一个新的数组。如果参数a的大小能装下集合的所有元素,则返回的还是a,但a的内容用集合的元素来填充。尤其要注意的是,如果a的大小比集合元素的个数还多,a后面的部分全部被置为null。 最后一个最重要的方法是iterator(),返回一个Iterator(迭代子),用于遍历集合的所有元素。 用Iterator模式实现遍历集合 Iterator模式是用于遍历集合类的标准访问方法。它可以把访问逻辑从不同类型的集合类中抽象出来,从而避免向客户端暴露集合的内部结构。 例如,如果没有使用Iterator,遍历一个数组的方法是使用索引: DE>for(int i=0; i<array.size(); i++) { ... get(i) ... }DE> 而访问一个链表(LinkedList)又必须使用while循环: DE>while((e=e.next())!=null) { ... e.data() ... }DE> 以上两种方法客户端都必须事先知道集合的内部结构,访问代码和集合本身是紧耦合,无法将访问逻辑从集合类和客户端代码中分离出来,每一种集合对应一种遍历方法,客户端代码无法复用。 更恐怖的是,如果以后需要把ArrayList更换为LinkedList,则原来的客户端代码必须全部重写。 为解决以上问题,Iterator模式总是用同一种逻辑来遍历集合: DE>for(Iterator it = c.iterater(); it.hasNext(); ) { ... }DE> 奥秘在于客户端自身不维护遍历集合的"指针",所有的内部状态(如当前元素位置,是否有下一个元素)都由Iterator来维护,而这个Iterator由集合类通过工厂方法生成,因此,它知道如何遍历整个集合。 客户端从不直接和集合类打交道,它总是控制Iterator,向它发送"向前","向后","取当前元素"的命令,就可以间接遍历整个集合。 首先看看java.util.Iterator接口的定义: DE>public interface Iterator { boolean hasNext(); Object next(); void remove(); }DE> 依赖前两个方法就能完成遍历,典型的代码如下: DE>for(Iterator it = c.iterator(); it.hasNext(); ) { Object o = it.next(); // 对o的操作... }DE> 在JDK1.5中,还对上面的代码在语法上作了简化: DE>// Type是具体的类型,如String。 for(Type t : c) { // 对t的操作... }DE> 每一种集合类返回的Iterator具体类型可能不同,Array可能返回ArrayIterator,Set可能返回SetIterator,Tree可能返回TreeIterator,但是它们都实现了Iterator接口,因此,客户端不关心到底是哪种Iterator,它只需要获得这个Iterator接口即可,这就是面向对象的威力。 Iterator源码剖析 让我们来看看AbstracyList如何创建Iterator。首先AbstractList定义了一个内部类(inner class): DE>private class Itr implements Iterator { ... }DE> 而iterator()方法的定义是: DE>public Iterator iterator() { return new Itr(); }DE> 因此客户端不知道它通过Iterator it = a.iterator();所获得的Iterator的真正类型。 现在我们关心的是这个申明为private的Itr类是如何实现遍历AbstractList的: DE>private class Itr implements Iterator { int cursor = 0; int lastRet = -1; int expectedModCount = modCount; }DE> Itr类依靠3个int变量(还有一个隐含的AbstractList的引用)来实现遍历,cursor是下一次next()调用时元素的位置,第一次调用next()将返回索引为0的元素。lastRet记录上一次游标所在位置,因此它总是比cursor少1。 变量cursor和集合的元素个数决定hasNext(): DE>public boolean hasNext() { return cursor != size(); }DE> 方法next()返回的是索引为cursor的元素,然后修改cursor和lastRet的值: DE>public Object next() { checkForComodification(); try { Object next = get(cursor); lastRet = cursor++; return next; } catch(IndexOutOfBoundsException e) { checkForComodification(); throw new NoSuchElementException(); } }DE> expectedModCount表示期待的modCount值,用来判断在遍历过程中集合是否被修改过。AbstractList包含一个modCount变量,它的初始值是0,当集合每被修改一次时(调用add,remove等方法),modCount加1。因此,modCount如果不变,表示集合内容未被修改。 Itr初始化时用expectedModCount记录集合的modCount变量,此后在必要的地方它会检测modCount的值: DE>final void checkForComodification() { if (modCount != expectedModCount) throw new ConcurrentModificationException(); }DE> 如果modCount与一开始记录在expectedModeCount中的值不等,说明集合内容被修改过,此时会抛出ConcurrentModificationException。 这个ConcurrentModificationException是RuntimeException,不要在客户端捕获它。如果发生此异常,说明程序代码的编写有问题,应该仔细检查代码而不是在catch中忽略它。 但是调用Iterator自身的remove()方法删除当前元素是完全没有问题的,因为在这个方法中会自动同步expectedModCount和modCount的值: DE>public void remove() { ... AbstractList.this.remove(lastRet); ... // 在调用了集合的remove()方法之后重新设置了expectedModCount: expectedModCount = modCount; ... }DE> 要确保遍历过程顺利完成,必须保证遍历过程中不更改集合的内容(Iterator的remove()方法除外),因此,确保遍历可靠的原则是只在一个线程中使用这个集合,或者在多线程中对遍历代码进行同步。 最后给个完整的示例: DE>Collection c = new ArrayList(); c.add("abc"); c.add("xyz"); for(Iterator it = c.iterator(); it.hasNext(); ) { String s = (String)it.next(); System.out.println(s); }DE> 如果你把第一行代码的ArrayList换成LinkedList或Vector,剩下的代码不用改动一行就能编译,而且功能不变,这就是针对抽象编程的原则:对具体类的依赖性最小。
转载地址:http://wltci.baihongyu.com/