Java源码分析 深入探讨Iterator模式

开发 后端
本文将从分析源码入手,深入研究一个集合类的内部结构,以及遍历集合的迭代模式的Java源码实现内幕。

Java.util包中包含了一系列重要的集合类。本文将从分析源码入手,深入研究一个集合类的内部结构,以及遍历集合的迭代模式的Java源码实现内幕。

下面我们先简单讨论一个根接口Collection,然后分析一个抽象类AbstractList和它的对应Iterator接口,并仔细研究迭代子模式的实现原理。

本文讨论的Java源码版本是JDK 1.4.2,因为JDK 1.5在Java.util中使用了很多泛型代码,为了简化问题,所以我们还是讨论1.4版本的代码。

集合类的根接口Collection

Collection接口是所有集合类的根类型。它的一个主要的接口方法是:

boolean add(Object c)
 
add()方法将添加一个新元素。注意这个方法会返回一个boolean,但是返回值不是表示添加成功与否。仔细阅读doc可以看 到,Collection规定:如果一个集合拒绝添加这个元素,无论任何原因,都必须抛出异常。这个返回值表示的意义是add()方法执行后,集合的内容 是否改变了(就是元素有无数量,位置等变化),这是由具体类实现的。即:如果方法出错,总会抛出异常;返回值仅仅表示该方法执行后这个 Collection的内容有无变化。

类似的还有:

  1. boolean addAll(Collection c);      
  2. boolean remove(Object o);      
  3. boolean removeAll(Collection c);      
  4. boolean remainAll(Collection c); 

Object[] toArray()方法很简单,把集合转换成数组返回。Object[] toArray(Object[] a)方法就有点复杂了,首先,返回的Object[]仍然是把集合的所有元素变成的数组,但是类型和参数a的类型是相同的,比如执行:

String[] o = (String[])c.toArray(new String[0]);
 
得到的o实际类型是String[]。

其次,如果参数a的大小装不下集合的所有元素,返回的将是一个新的数组。如果参数a的大小能装下集合的所有元素,则返回的还是a,但a的内容用集合的元素来填充。尤其要注意的是,如果a的大小比集合元素的个数还多,a后面的部分全部被置为null。

***一个最重要的方法是iterator(),返回一个Iterator(迭代子),用于遍历集合的所有元素。

用Iterator模式实现遍历集合

Iterator模式是用于遍历集合类的标准访问方法。它可以把访问逻辑从不同类型的集合类中抽象出来,从而避免向客户端暴露集合的内部结构。

例如,如果没有使用Iterator,遍历一个数组的方法是使用索引:

  1. for(int i=0; i<array.size();   
  2. i++) { ... get(i) ... } 

而访问一个链表(LinkedList)又必须使用while循环:

  1. while((e=e.next())!=null)   
  2. { ... e.data() ... } 

 以上两种方法客户端都必须事先知道集合的内部结构,访问代码和集合本身是紧耦合,无法将访问逻辑从集合类和客户端代码中分离出来,每一种集合对应一种遍历方法,客户端代码无法复用。

更恐怖的是,如果以后需要把ArrayList更换为LinkedList,则原来的客户端代码必须全部重写。

为解决以上问题,Iterator模式总是用同一种逻辑来遍历集合:

  1. for(Iterator it = c.iterater();   
  2. it.hasNext(); ) { ... } 

奥秘在于客户端自身不维护遍历集合的"指针",所有的内部状态(如当前元素位置,是否有下一个元素)都由Iterator来维护,而这个Iterator由集合类通过工厂方法生成,因此,它知道如何遍历整个集合。

客户端从不直接和集合类打交道,它总是控制Iterator,向它发送"向前","向后","取当前元素"的命令,就可以间接遍历整个集合。

首先看看Java.util.Iterator接口的定义:

  1. public interface Iterator   
  2. {        boolean hasNext();          
  3. Object next();        void remove();    } 

依赖前两个方法就能完成遍历,典型的代码如下:

  1. for(Iterator it = c.iterator();   
  2. it.hasNext(); )   
  3. {        Object o = it.next();          
  4. // 对o的操作...    } 

在JDK1.5中,还对上面的代码在语法上作了简化:

// Type是具体的类型,如String。    for(Type t : c) {        // 对t的操作...    }
 
每一种集合类返回的Iterator具体类型可能不同,Array可能返回ArrayIterator,Set可能返回 SetIterator,Tree可能返回TreeIterator,但是它们都实现了Iterator接口,因此,客户端不关心到底是哪种 Iterator,它只需要获得这个Iterator接口即可,这就是面向对象的威力。

Iterator源码剖析


让我们来看看AbstracyList如何创建Iterator。首先AbstractList定义了一个内部类(inner class):

private class Itr implements Iterator {        ...    }
 

而iterator()方法的定义是:

  1. public Iterator iterator()   
  2. {        return new Itr();    }

因此客户端不知道它通过Iterator it = a.iterator();所获得的Iterator的真正类型。

现在我们关心的是这个申明为private的Itr类是如何实现遍历AbstractList的:

  1. private class Itr implements Iterator   
  2. {        int cursor = 0;          
  3. int lastRet = -1;          
  4. int expectedModCount = modCount;    } 

Itr类依靠3个int变量(还有一个隐含的AbstractList的引用)来实现遍历,cursor是下一次next()调用时元素的位置,***次调用next()将返回索引为0的元素。lastRet记录上一次游标所在位置,因此它总是比cursor少1。

变量cursor和集合的元素个数决定hasNext():

  1. public boolean hasNext()   
  2. {        return cursor != size();    } 

方法next()返回的是索引为cursor的元素,然后修改cursor和lastRet的值:

  1. public Object next() {        checkForComodification();          
  2. try {            Object next = get(cursor);              
  3. lastRet = cursor++;              
  4. return next;  
  5.         } catch(IndexOutOfBoundsException e)   
  6. {            checkForComodification();              
  7. throw new NoSuchElementException();        }    } 

expectedModCount表示期待的modCount值,用来判断在遍历过程中集合是否被修改过。AbstractList包含一个 modCount变量,它的初始值是0,当集合每被修改一次时(调用add,remove等方法),modCount加1。因此,modCount如果不 变,表示集合内容未被修改。

Itr初始化时用expectedModCount记录集合的modCount变量,此后在必要的地方它会检测modCount的值:

  1. final void checkForComodification()   
  2. {        if   
  3. (modCount != expectedModCount)              
  4. throw new ConcurrentModificationException();    } 

如果modCount与一开始记录在expectedModeCount中的值不等,说明集合内容被修改过,此时会抛出ConcurrentModificationException。

这个ConcurrentModificationException是RuntimeException,不要在客户端捕获它。如果发生此异常,说明程序代码的编写有问题,应该仔细检查代码而不是在catch中忽略它。

但是调用Iterator自身的remove()方法删除当前元素是完全没有问题的,因为在这个方法中会自动同步expectedModCount和modCount的值:

  1. public void remove()   
  2. {        ...        AbstractList.this.remove(lastRet);  
  3.         ...          
  4. // 在调用了集合的remove()方法之后重新设置了expectedModCount:          
  5. expectedModCount = modCount;        ...    } 

要确保遍历过程顺利完成,必须保证遍历过程中不更改集合的内容(Iterator的remove()方法除外),因此,确保遍历可靠的原则是只在一个线程中使用这个集合,或者在多线程中对遍历代码进行同步。

***给个完整的示例:

  1. Collection c = new ArrayList();      
  2. c.add("abc");    c.add("xyz");      
  3. for(Iterator it = c.iterator();   
  4. it.hasNext(); ) {        String s = (String)it.next();          
  5. System.out.println(s);    } 

如果你把***行代码的ArrayList换成LinkedList或Vector,剩下的代码不用改动一行就能编译,而且功能不变,这就是针对抽象编程的原则:对具体类的依赖性最小。

【编辑推荐】

  1. 对Java编程思想的忠告
  2. 和我共同了解Java是什么
  3. 著名的Java论坛和网站
  4. 2009年十大Java技术解决方案
  5. 2008最值得学习的五种JAVA技术
责任编辑:仲衡 来源: 百度博客
相关推荐

2009-12-23 16:13:00

WPF Attache

2011-02-25 09:23:00

Java类加载器

2015-09-02 08:57:56

JavaHashMap工作原理

2009-11-20 17:17:08

Oracle函数索引

2021-05-17 05:36:02

CSS 文字动画技巧

2010-07-21 09:38:15

PHP缓存技术

2010-11-22 14:18:32

MySQL锁机制

2012-02-28 14:43:43

2017-01-03 17:57:46

Android异步精髓Handler

2009-12-14 14:40:10

Ruby全局域变量

2009-10-16 09:17:39

屏蔽布线系统

2009-11-12 13:56:54

2009-12-07 13:55:58

PHP array_m

2009-12-11 11:08:31

静态路由策略

2009-12-07 16:07:03

PHP类的继承

2013-07-11 09:45:48

扁平化扁平化设计

2024-01-26 06:42:05

Redis数据结构

2010-03-31 14:58:03

云计算

2010-03-05 13:44:00

Python序列

2009-08-27 11:27:58

foreach语句C# foreach语
点赞
收藏

51CTO技术栈公众号