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

 更新时间:2016年04月07日 11:50:52   作者:小米干饭   我要评论

这篇文章主要介绍了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的原因分析,希望对大家有所帮助!

相关文章

  • Spring MVC温故而知新系列教程之从零开始

    Spring MVC温故而知新系列教程之从零开始

    Spring MVC 框架在 Java 的 Web 项目中应该是无人不知的吧,你不会搭建一个 Spring 框架?作为身为一个刚刚学习Java的我都会,如果你不会的话,那可真令人忧伤。下面这篇文章主要给大家介绍了关于Spring MVC从零开始的相关资料,需要的朋友可以参考下
    2018-05-05
  • java实现数字转大写的方法

    java实现数字转大写的方法

    这篇文章主要介绍了 java实现数字转大写的方法的相关资料,希望通过本文能帮助到大家,让大家实现这样的功能,需要的朋友可以参考下
    2017-10-10
  • java获取服务器基本信息的方法

    java获取服务器基本信息的方法

    这篇文章主要介绍了java获取服务器基本信息的方法,涉及java获取系统CPU、内存及操作系统等相关信息的技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-07-07
  • Lock、Condition实现简单的生产者消费者模式示例

    Lock、Condition实现简单的生产者消费者模式示例

    这篇文章主要介绍了Lock、Condition实现简单的生产者消费者模式示例,需要的朋友可以参考下
    2014-04-04
  • Java语言实现非递归实现树的前中后序遍历总结

    Java语言实现非递归实现树的前中后序遍历总结

    今天小编就为大家分享一篇关于Java语言实现非递归实现树的前中后序遍历总结,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2019-01-01
  • java的arrays数组排序示例分享

    java的arrays数组排序示例分享

    排序算法,基本的高级语言都有一些提供。C语言有qsort()函数,C++有sort()函数,java语言有Arrays类(不是Array)。用这些排序时,都可以写自己的排序规则
    2014-02-02
  • java基于C/S结构实现多线程聊天室

    java基于C/S结构实现多线程聊天室

    这篇文章主要为大家详细介绍了java基于C/S结构实现多线程聊天室,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-01-01
  • Java处理日期时间的方法汇总

    Java处理日期时间的方法汇总

    这篇文章主要给大家介绍了利用Java中的Calendar 类处理日期时间的方法汇总,其中包括取日期的每部分、取当月的第一天或最后一天、求两个日期之间相隔的天数以及一年前的日期等等的示例代码,有需要的朋友们可以直接参考借鉴,下面来一起看看吧。
    2016-12-12
  • 如何解决SpringBoot2.x版本对Velocity模板不支持的方案

    如何解决SpringBoot2.x版本对Velocity模板不支持的方案

    这篇文章主要介绍了如何解决SpringBoot2.x版本对Velocity模板不支持的方案,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-12-12
  • Java中String、StringBuffer、StringBuilder的区别介绍

    Java中String、StringBuffer、StringBuilder的区别介绍

    这篇文章主要介绍了Java中String、StringBuffer、StringBuilder的区别介绍,本文讲解了可变与不可变、是否多线程安全、gBuilder与StringBuffer共同点等内容,需要的朋友可以参考下
    2015-06-06

最新评论