Java ArrayList.toArray(T[]) 方法的参数类型是 T 而不是 E的原因分析

前两天给同事做 code review，感觉自己对 java 的 generics 掌握得不够好，便拿出 《effective java》1 这本书再看看相关的章节。在 item 24：eliminate unchecked warnings 这一节中，作者拿 arraylist 类中的 public <t> t[] toarray(t[] a) 方法作为例子来说明如何对变量使用 @suppresswarnings annotation。

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

javapublic class arraylist<e> extends abstractlist<e>
implements list<e>, randomaccess, cloneable, java.io.serializable

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

@suppresswarnings("unchecked")
public <t> t[] toarray(t[] a) {
if (a.length < size)
// make a new array of a's runtime type, but my contents:
return (t[]) arrays.copyof(elementdata, size, a.getclass());
system.arraycopy(elementdata, 0, a, 0, size);
if (a.length > size)
a[size] = null;
return a;
}

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

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

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

javapublic e[] toarray(e[] a);

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

//创建一个类型为 string 的 arraylist
list<string> strlist = new arraylist<string>();
strlist.add("abc");
strlist.add("xyz");
//将当前的 strlist 转换成一个 number 数组。注意，下面的语句没有任何编译错误。
number[] numarray = strlist.toarray(new number[0]);

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

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

上网一查，这个问题早已被讨论过多次了2, 3, 4。

2 可以提高灵活性

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

list<integer> intlist = new arraylist<integer>();
intlist.add(1);
intlist.add(2);
number[] numarray = intlist.toarray(new number[0]);

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

javapublic <t super e> t[] toarray(t[] a);

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

代码一：

list<integer> intlist = new arraylist<integer>();
intlist.add(1);
intlist.add(2); 
float[] floatarray = new float[2];
//float 是 number 的子类，所以 float[] 是 number[] 的子类
number[] numarray = floatarray;
//下面的语句会抛出 arraystoreexception 异常
numarray = intlist.toarray(numarray);

代码二：

list<number> intlist = new arraylist<number>();
//list 的类型是 number。但 number 是抽象类，只能存它的子类的实例
intlist.add(new integer());
intlist.add(new integer()); 
float[] floatarray = new float[];
//float 是 number 的子类，所以 float[] 是 number[] 的子类
number[] numarray = floatarray;
//下面的语句会抛出 arraystoreexception 异常
numarray = intlist.toarray(numarray);

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

这个帖子8里举了个例子，说明即使这个方法的类型声明成 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）就出现了9。那时它被声明称这样：

javapublic object[] toarray(object[] a)

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

javapublic <t> t[] toarray(t[] a)

这样声明可以与 java 1.5 之前的版本兼容10。

4 多啰嗦两句

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

list<integer> intlist = new arraylist<integer>();
intlist.add();
intlist.add();
//传入一个数组，它的长度为 
number[] numarray = intlist.toarray(new number[]); //语句
//传入一个数组，它的长度与 intlist 的长度相等
number[] numarray = intlist.toarray(new number[intlist.size()]); //语句

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

footnotes:

1
effective java (2nd edition)
2
link
3
link
4
link
5
link
6
link
7
link
8
link
9
link
10
link
created: 2016-04-06 wed 21:14
emacs 24.5.1 (org mode 8.2.10)
validate

以上内容是小编给大家介绍的java arraylist.toarray(t[]) 方法的参数类型是 t 而不是 e的原因分析，希望对大家有所帮助！