为什么 Java ArrayList.toArray(T[]) 方法的参数类型是 T 而不是 E ？

前两天给同事做 code review，感觉自己对 Java 的 Generics 掌握得不够好，便拿出《Effective Java》¹ 这本书再看看相关的章节。在 Item 24：Eliminate unchecked warnings 这一节中，作者拿 ArrayList 类中的 public <T> T[] toArray(T[] a) 方法作为例子来说明如何对变量使用 @SuppressWarnings annotation。

ArrayList 是一个 generic class，它是这样声明的：

public class ArrayList<E> extends AbstractList<E>

    implements List<E>, RandomAccess, Cloneable, java.io.Serializable

这个类的 toArray(T[] a) 方法是一个 generic method，它是这样声明和实现的：

 1: @SuppressWarnings("unchecked")

 2: public <T> T[] toArray(T[] a) {

 3:     if (a.length < size)

 4:         // Make a new array of a's runtime type, but my contents:

 5:         return (T[]) Arrays.copyOf(elementData, size, a.getClass());

 6:     System.arraycopy(elementData, 0, a, 0, size);

 7:     if (a.length > size)

 8:         a[size] = null;

 9:     return a;

10: }

这个方法实际上是在 Collection 接口中声明的。因为我们经常通过 ArrayList 使用它，这里就用 ArrayList 作为例子了。

1 为什么声明为不同类型？

我的问题是：为什么这个方法使用类型 T，而不使用 ArrayList 的类型 E ? 也就是说，这个方法为什么不声明成这样：

public E[] toArray(E[] a);

如果类型相同的话，在编译期间就可以发现参数的类型错误。如果类型不同，很容易产生运行时错误。比如下面这段代码：

1: //创建一个类型为 String 的 ArrayList

2: List<String> strList = new ArrayList<String>();

3: strList.add("abc");

4: strList.add("xyz");

5: //将当前的 strList 转换成一个 Number 数组。注意，下面的语句没有任何编译错误。

6: Number[] numArray = strList.toArray(new Number[0]);

运行上面的代码， Line 6 会抛出 java.lang.ArrayStoreException 异常。

如果 toArray 方法使用类型 E 的话，语句2就会产生编译错误。编译错误怎么说也比运行时错误亲切啊。并且，generics 的主要目的就是为了类型安全，把类型转换错误(ClassCastException)消灭在编译期间。这个方法却反其道而行之。难道这是一个大 bug？ Java 的 bug 俺碰上过，但这个地方出 bug 我还是不太敢相信。

上网一查，这个问题早已被讨论过多次了²^,³^,⁴。

2 可以提高灵活性

这样的声明更灵活，可以把当前 list 中的元素转换成一个更一般类型的数组。比如，当前 list 的类型是 Integer，我们可以把它的元素转换成一个 Number 数组。

1: List<Integer> intList = new ArrayList<Integer>();

2: intList.add(1);

3: intList.add(2);

4: Number[] numArray = intList.toArray(new Number[0]);

如果这个方法声明成类型 E，上面的代码就会有编译错误。看起来，该方法声明成下面这样会更合适：

public <T super E> T[] toArray(T[] a);

不过， <T super E> 这样的语法在 Java 中是不存在的。而且即使存在，对数组也不起作用。也正是因为这个原因，在使用这个方法时，即使 T 是 E 的父类，或 T 跟 E 相同，也不能完全避免 java.lang.ArrayStoreException 异常⁵^,⁶^,⁷ 。请看下面两段代码。第一段代码中 T 是 E 的父类，第二段代码中 T 和 E 一样。这两段代码都会抛出异常。

代码一：

1: List<Integer> intList = new ArrayList<Integer>();

2: intList.add(1);

3: intList.add(2);

4:

5: Float[] floatArray = new Float[2];

6: //Float 是 Number 的子类，所以 Float[] 是 Number[] 的子类

7: Number[] numArray = floatArray;

8: //下面的语句会抛出 ArrayStoreException 异常

9: numArray = intList.toArray(numArray);

代码二：

 1: List<Number> intList = new ArrayList<Number>();

 2: //List 的类型是 Number。但 Number 是抽象类，只能存它的子类的实例

 3: intList.add(new Integer(1));

 4: intList.add(new Integer(2));

 5:

 6: Float[] floatArray = new Float[2];

 7: //Float 是 Number 的子类，所以 Float[] 是 Number[] 的子类

 8: Number[] numArray = floatArray;

 9: //下面的语句会抛出 ArrayStoreException 异常

10: numArray = intList.toArray(numArray);

上面的异常都是由这个事实造成的：如果 A 是 B 的父类，那么 A[] 是 B[] 的父类。Java 中所有的类都继承自 Object，Object[] 是所有数组的父类。

这个帖子⁸里举了个例子，说明即使这个方法的类型声明成 E 也不能避免 ArrayStoreException 异常。

该方法的文档中也提到了这个异常：

ArrayStoreException if the runtime type of the specified array is not a supertype of the runtime type of every element in this list.

3 可以与 Java 1.5 之前的版本兼容

这个方法在 Java 引入 Generics 之前（JDK1.5 中引入了 Generics）就出现了⁹。那时它被声明称这样：

public Object[] toArray(Object[] a)

Generics 出现后，许多类和方法就变成 generic 的了。这个方法也随大流声明成这样：

public <T> T[] toArray(T[] a)

这样声明可以与 Java 1.5 之前的版本兼容¹⁰。

4 多啰嗦两句

这个方法需要一个数组参数。如果这个数组的 length 大于或等于当前 list 的 size，list 中的元素就会存储到这个数组当中；如果这个数组的 length 小于当前 list 的 size，就会创建一个新的数组，并把当前 list 中的元素存入到这个新创建的数组中。为提高效率，如果可能，传入的数组的 length 要大于或等于 list 的 size，以避免该方法新建数组。

1: List<Integer> intList = new ArrayList<Integer>();

2: intList.add(1);

3: intList.add(2);

4: //传入一个数组，它的长度为 0

5: Number[] numArray1 = intList.toArray(new Number[0]); //语句1

6: //传入一个数组，它的长度与 intList 的长度相等

7: Number[] numArray2 = intList.toArray(new Number[intList.size()]); //语句2

另外，作为参数的数组不能为 null ，否则的话会抛出 NullPointerException 异常。

Footnotes:

Effective Java (2nd Edition)

⁴

⁵

⁶

⁷

⁸

⁹

¹⁰

Created: 2016-04-06 Wed 21:14

Emacs 24.5.1 (Org mode 8.2.10)

Validate