UML软件工程组织

[J2SE 1.5]逐渐挖掘Enhanced for Loop
作者:孙海涛
J2SE 1.5提供了另一种形式的for循环。借助这种形式的for循环,可以用更简单地方式来遍历数组和Collection等类型的对象。本文介绍使用这种循环的具体方式,说明如何自行定义能被这样遍历的类,并解释和这一机制的一些常见问题。

在Java程序中,要“逐一处理”——或者说,“遍历”——某一个数组或Collection中的元素的时候,一般会使用一个for循环来实现(当然,用其它种类的循环也不是不可以,只是不知道是因为for这个词的长度比较短,还是因为for这个词的含义和这种操作比较配,在这种时候for循环比其它循环常用得多)。

对于遍历数组,这个循环一般是采取这样的写法:

清单1:遍历数组的传统方式
/* 建立一个数组 */
int[] integers = {1, 2, 3, 4};
/* 开始遍历 */
for (int j = 0; j < integers.length; j++) {
    int i = integers[j];
    System.out.println(i);
}

而对于遍历Collection对象,这个循环则通常是采用这样的形式:

清单2:遍历Collection对象的传统方式
/* 建立一个Collection */
String[] strings = {"A", "B", "C", "D"};
Collection stringList = java.util.Arrays.asList(strings);
/* 开始遍历 */
for (Iterator itr = stringList.iterator(); itr.hasNext();) {
    Object str = itr.next();
    System.out.println(str);
}

而在Java语言的最新版本——J2SE 1.5中,引入了另一种形式的for循环。借助这种形式的for循环,现在可以用一种更简单地方式来进行遍历的工作。

1. 第二种for循环

不严格的说,Java的第二种for循环基本是这样的格式:

for (循环变量类型 循环变量名称 : 要被遍历的对象) 循环体

借助这种语法,遍历一个数组的操作就可以采取这样的写法:

清单3:遍历数组的简单方式
/* 建立一个数组 */
int[] integers = {1, 2, 3, 4};
/* 开始遍历 */
for (int i : integers) {
    System.out.println(i);/* 依次输出“1”、“2”、“3”、“4” */
}

这里所用的for循环,会在编译期间被看成是这样的形式:

清单4:遍历数组的简单方式的等价代码
/* 建立一个数组 */
int[] integers = {1, 2, 3, 4};
/* 开始遍历 */
for (int 变量名甲 = 0; 变量名甲 < integers.length; 变量名甲++) {
    System.out.println(integers[变量名甲]);/* 依次输出“1”、“2”、“3”、“4” */
}

这里的“变量名甲”是一个由编译器自动生成的不会造成混乱的名字。

而遍历一个Collection的操作也就可以采用这样的写法:

清单5:遍历Collection的简单方式
/* 建立一个Collection */
String[] strings = {"A", "B", "C", "D"};
Collection list = java.util.Arrays.asList(strings);
/* 开始遍历 */
for (Object str : list) {
    System.out.println(str);/* 依次输出“A”、“B”、“C”、“D” */
}

这里所用的for循环,则会在编译期间被看成是这样的形式:

清单6:遍历Collection的简单方式的等价代码
/* 建立一个Collection */
String[] strings = {"A", "B", "C", "D"};
Collection stringList = java.util.Arrays.asList(strings);
/* 开始遍历 */
for (Iterator 变量名乙 = list.iterator(); 变量名乙.hasNext();) {
    Object str = 变量名乙.next();
    System.out.println(str);/* 依次输出“A”、“B”、“C”、“D” */
}

这里的“变量名乙”也是一个由编译器自动生成的不会造成混乱的名字。

因为在编译期间,J2SE 1.5的编译器会把这种形式的for循环,看成是对应的传统形式,所以不必担心出现性能方面的问题。

2. 防止在循环体里修改循环变量

在默认情况下,编译器是允许在第二种for循环的循环体里,对循环变量重新赋值的。不过,因为这种做法对循环体外面的情况丝毫没有影响,又容易造成理解代码时的困难,所以一般并不推荐使用。

Java提供了一种机制,可以在编译期间就把这样的操作封杀。具体的方法,是在循环变量类型前面加上一个“final”修饰符。这样一来,在循环体里对循环变量进行赋值,就会导致一个编译错误。借助这一机制,就可以有效的杜绝有意或无意的进行“在循环体里修改循环变量”的操作了。

清单7:禁止重新赋值
int[] integers = {1, 2, 3, 4};
for (final int i : integers) {
    i = i / 2; /* 编译时出错 */
}

注意,这只是禁止了对循环变量进行重新赋值。给循环变量的属性赋值,或者调用能让循环变量的内容变化的方法,是不被禁止的。

清单8:允许修改状态
Random[] randoms = new Random[]{new Random(1), new Random(2), new Random(3)};
for (final Random r : randoms) {
    r.setSeed(4);/* 将所有Random对象设成使用相同的种子 */
    System.out.println(r.nextLong());/* 种子相同,第一个结果也相同 */
}
3. 类型相容问题

为了保证循环变量能在每次循环开始的时候,都被安全的赋值,J2SE 1.5对循环变量的类型有一定的限制。这些限制之下,循环变量的类型可以有这样一些选择:

  • 循环变量的类型可以和要被遍历的对象中的元素的类型相同。例如,用int型的循环变量来遍历一个int[]型的数组,用Object型的循环变量来遍历一个Collection等。
    清单9:使用和要被遍历的数组中的元素相同类型的循环变量
    int[] integers = {1, 2, 3, 4};
    for (int i : integers) {
        System.out.println(i);/* 依次输出“1”、“2”、“3”、“4” */
    }
    清单10:使用和要被遍历的Collection中的元素相同类型的循环变量
    Collection<String> strings = new ArrayList<String>();
    strings.add("A");
    strings.add("B");
    strings.add("C");
    strings.add("D");
    for (String str : integers) {
        System.out.println(str);/* 依次输出“A”、“B”、“C”、“D” */
    }
  • 循环变量的类型可以是要被遍历的对象中的元素的上级类型。例如,用int型的循环变量来遍历一个byte[]型的数组,用Object型的循环变量来遍历一个Collection<String>(全部元素都是String的Collection)等。
    清单11:使用要被遍历的对象中的元素的上级类型的循环变量
    String[] strings = {"A", "B", "C", "D"};
    Collection<String> list = java.util.Arrays.asList(strings);
    for (Object str : list) {
        System.out.println(str);/* 依次输出“A”、“B”、“C”、“D” */
    }
  • 循环变量的类型可以和要被遍历的对象中的元素的类型之间存在能自动转换的关系。J2SE 1.5中包含了“Autoboxing/Auto-Unboxing”的机制,允许编译器在必要的时候,自动在基本类型和它们的包裹类(Wrapper Classes)之间进行转换。因此,用Integer型的循环变量来遍历一个int[]型的数组,或者用byte型的循环变量来遍历一个Collection<Byte>,也是可行的。
    清单12:使用能和要被遍历的对象中的元素的类型自动转换的类型的循环变量
    int[] integers = {1, 2, 3, 4};
    for (Integer i : integers) {
        System.out.println(i);/* 依次输出“1”、“2”、“3”、“4” */
    }

注意,这里说的“元素的类型”,是由要被遍历的对象的决定的——如果它是一个Object[]型的数组,那么元素的类型就是Object,即使里面装的都是String对象也是如此。

4. 被这样遍历的前提

有两种类型的对象可以通过这种方法来遍历——数组和实现了java.lang.Iterable接口的类的实例。试图将结果是其它类型的表达式放在这个位置上,只会在编译时导致一个提示信息是“foreach not applicable to expression type”的问题。

java.lang.Iterable接口中定义的方法只有一个:

iterator()
返回一个实现了java.util.Iterator接口的对象

而java.util.Iterator接口中,则定义了这样三个方法:

hasNext()
返回是否还有没被访问过的对象
next()
返回下一个没被访问过的对象
remove()
把最近一次由next()返回的对象从被遍历的对象里移除。这是一个可选的操作,如果不打算提供这个功能,在实现的时候抛出一个UnsupportedOperationException即可。因为在整个循环的过程中,这个方法根本没有机会被调用,所以是否提供这个功能,在这里没有影响。

借助这两个接口,就可以自行实现能被这样遍历的类了。

清单13:一个能取出10个Object元素的类
import java.util.*;
class TenObjects implements Iterable {
    public Iterator iterator() {
        return new Iterator() {
            private int count = 0;
            public boolean hasNext() {
                return (count < 10);
            }
            public Object next() {
                return new Integer(count++);
            }
            public void remove() {
                throw new UnsupportedOperationException();
            }
        };
    }
    public static void main(String[] args)
    {
        TenObjects objects = new TenObjects();
        for (Object i : objects)
        {
            System.out.println(i);/* 依次输出从“0"到“9”的十个整数 */
        }
    }
}
5. 加入更精确的类型控制

如果在遍历自定义的可遍历对象的时候,想要循环变量能使用比Object更精确的类型,就需要在实现java.lang.Iterable接口和java.util.Iterator接口的时候,借助J2SE 1.5中的泛型机制,来作一些类型指派的工作。

如果想要使循环变量的类型为T,那么指派工作的内容是:

  • 在所有要出现java.lang.Iterable的地方,都写成“Iterable<T>”。
  • 在所有出现java.util.Iterator的地方,都写成“Iterator<T>”。
  • 在实现java.util.Iterator的接口的时候,用T作为next()方法的返回值类型。

注意,这里的T不能是一个基本类型。如果打算用基本类型作为循环变量,那么得用它们的包裹类来代替这里的T,然后借助Auto-Unboxing机制,来近似的达到目的。

清单14:用int型的循环变量来遍历一个能取出10个Integer元素的类
import java.util.*;
public class TenIntegers implements Iterable<Integer> {
    public Iterator<Integer> iterator() {
        return new Iterator<Integer>() {
                private int count = 0;
                public boolean hasNext() {
                    return (count < 10);
                }
                public Integer next() {
                    return Integer.valueOf(count++);
                }
                public void remove() {
                    throw new UnsupportedOperationException();
                }
            };
    }
    public static void main(String[] args)
    {
        TenIntegers integers = new TenIntegers();
        for (int i : integers)
        {
            System.out.println(i);/* 依次输出从“0"到“9”的十个整数 */
        }
    }
}

另外,一个类只能实现一次java.lang.Iterable接口,即使在后面的尖括号里使用不同的类型。类似“class A implements Iterable<String>, Iterable<Integer>”的写法,是不能通过编译的。所以,没有办法让一个可遍历对象能在这样遍历时,既可以使用Integer,又可以使用String来作为循环变量的类型(当然,把它们换成另外两种没有继承和自动转化关系的类也一样行不通)。

6. 归纳总结

借助J2SE 1.5中引入的第二种for循环,可以用一种更简单地方式来完成遍历。能用这种方法遍历的对象的类型,可以是数组、Collection或者任何其它实现了java.lang.Iterable接口的类。通过跟同样是在J2SE 1.5中引入的泛型机制配合使用,可以精确的控制能采用的循环变量的类型。而且,因为这么编写的代码,会在编译期间被自动当成是和传统写法相同的形式,所以不必担心要额外付出性能方面的代价。

 

版权所有:UML软件工程组织