泛型是JAVA中一个非常重要的知识点,在Java集合类框架中泛型被广泛应用。本文我们将从零开始来看一下Java泛型的设计,将会涉及到通配符处理,以及让人苦恼的类型擦除。
作者: ZiWenXie http://www.ziwenxie.site/2017/03/01/java-generic/
泛型类
我们首先定义一个简单的Box类:
public class Box { private String object; public void set(String object) { this.object = object; } public String get() { return object; } }
这是最常见的做法,这样做的一个坏处是Box里面现在只能装入String类型的元素,今后如果我们需要装入Integer等其他类型的元素,还必须要另外重写一个Box,代码得不到复用,使用泛型可以很好的解决这个问题。
public class Box<T> { private T t; public void set(T t) { this.t = t; } public T get() { return t; } }
这样我们的Box类便可以得到复用,我们可以将T替换成任何我们想要的类型:
Box<Integer> integerBox = new Box<Integer>(); Box<Double> doubleBox = new Box<Double>(); Box<String> stringBox = new Box<String>();
泛型方法
看完了泛型类,接下来我们来了解一下泛型方法。声明一个泛型方法很简单,只要在返回类型前面加上一个类似的形式就行了:
public class Util { public static <K, V> boolean compare(Pair<K, V> p1, Pair<K, V> p2) { return p1.getKey().equals(p2.getKey()) && p1.getValue().equals(p2.getValue()); } } public class Pair<K, V> { private K key; private V value; public Pair(K key, V value) { this.key = key; this.value = value; } public void setKey(K key) { this.key = key; } public void setValue(V value) { this.value = value; } public K getKey() { return key; } public V getValue() { return value; } }
我们可以像下面这样去调用泛型方法:
Pair<Integer, String> p1 = new Pair<>(1, "Apple"); Pair<Integer, String> p2 = new Pair<>(2, "pear"); boolean same = Util.< Integer, String>compare(p1, p2);
或者在Java1.7/1.8利用type inference,让Java自动推导出相应的类型参数:
Pair<Integer, String> p1 = new Pair<>(1, "apple"); Pair<Integer, String> p2 = new Pair<>(2, "pear"); boolean same = Util.compare(p1, p2);
边界符
现在我们要实现这样一个功能,查找一个泛型数组中大于某个特定元素的个数,我们可以这样实现:
public static <T> int countGreaterThan(T[] anArray, T elem) { int count = 0; for (T e :anArray) if (e > elem) ++count; return count; }
但是这样很明显是错误的,因为除了short, int, double, long, float, byte, char等原始类型,其他的类并不一定能使用操作符>,所以编译器报错,那怎么解决这个问题呢?答案是使用边界符。
public interface Comparable<T> { public int compareTo(T o); }
做一个类似于下面这样的声明,这样就等于告诉编译器类型参数T代表的都是实现了Comparable接口的类,这样等于告诉编译器它们都至少实现了compareTo方法。
public static <T extends Comparable <T>> int countGreaterThan(T[] anArray, T elem) { int count = 0 ; for (T e :anArray) if (e.compareTo(elem) > 0 ) ++count; return count; }
在了解通配符之前,我们首先必须要澄清一个概念,还是借用我们上面定义的Box类,假设我们添加一个这样的方法:
public void boxTest( Box < Number > n) { }
那么现在Box n允许接受什么类型的参数?我们是否能够传入Box或者Box呢?答案是否定的,虽然Integer和Double是Number的子类,但是在泛型中Box或者Box与Box之间并没有任何的关系。这一点非常重要,接下来我们通过一个完整的例子来加深一下理解。面试官问:Java中的锁有哪些?我跪了……
首先我们先定义几个简单的类,下面我们将用到它:
class Fruit {} public class GenericReading { static List < Apple > apples = Arrays .asList( new Apple ()); static List < Fruit > fruit = Arrays .asList( new Fruit ()); static class Reader <T> { T readExact( List <T> list) { return list. get ( 0 ); } } static void f1() { static class CovariantReader <T> { T readCovariant( List <? extends T> list) { return list. get ( 0 ); } } static void f2() { CovariantReader < Fruit > fruitReader = new CovariantReader < Fruit >(); Fruit f = fruitReader.readCovariant(fruit); Fruit a = fruitReader.readCovariant(apples); } public static void main( String [] args) { f2(); }
这样就相当与告诉编译器, fruitReader的readCovariant方法接受的参数只要是满足Fruit的子类就行(包括Fruit自身),这样子类和父类之间的关系也就关联上了。
上面我们看到了类似的用法,利用它我们可以从list里面get元素,那么我们可不可以往list里面add元素呢?我们来尝试一下:
public class GenericsAndCovariance { public static void main( String [] args) { List <? extends Fruit > flist = new ArrayList < Apple >(); flist.add( null ); Fruit f = flist. get ( 0 ); } }
答案是否定,Java编译器不允许我们这样做,为什么呢?对于这个问题我们不妨从编译器的角度去考虑。因为Listflist它自身可以有多种含义:
List <? extends Fruit > flist = new ArrayList < Fruit >(); List <? extends Fruit > flist = new ArrayList < Apple >(); List <? extends Fruit > flist = new ArrayList < Orange >();
当我们尝试add一个Apple的时候,flist可能指向new ArrayList();
当我们尝试add一个Orange的时候,flist可能指向new ArrayList();
当我们尝试add一个Fruit的时候,这个Fruit可以是任何类型的Fruit,而flist可能只想某种特定类型的Fruit,编译器无法识别所以会报错。华为 Java 编程军规,牛逼!
所以对于实现了的集合类只能将它视为Producer向外提供(get)元素,而不能作为Consumer来对外获取(add)元素。
如果我们要add元素应该怎么做呢?可以使用:
public class GenericWriting { static List < Apple > apples = new ArrayList < Apple >(); static List < Fruit > fruit = new ArrayList < Fruit >(); static <T> void writeExact( List <T> list, T item) { list.add(item); } static void f1() { writeExact(apples, new Apple ()); writeExact(fruit, new Apple ()); } static <T> void writeWithWildcard( List <? super T> list, T item) { list.add(item) } static void f2() { writeWithWildcard(apples, new Apple ()); writeWithWildcard(fruit, new Apple ()); } public static void main( String [] args) { f1(); f2(); } }
这样我们可以往容器里面添加元素了,但是使用super的坏处是以后不能get容器里面的元素了,原因很简单,我们继续从编译器的角度考虑这个问题,对于List list,它可以有下面几种含义:
List <? super Apple > list = new ArrayList < Apple >(); List <? super Apple > list = new ArrayList < Fruit >(); List <? super Apple > list = new ArrayList < Object >();
当我们尝试通过list来get一个Apple的时候,可能会get得到一个Fruit,这个Fruit可以是Orange等其他类型的Fruit。
根据上面的例子,我们可以总结出一条规律,”Producer Extends, Consumer Super”:
“Producer Extends” – 如果你需要一个只读List,用它来produce T,那么使用? extends T。
“Consumer Super” – 如果你需要一个只写List,用它来consume T,那么使用? super T。
如果需要同时读取以及写入,那么我们就不能使用通配符了。
如何阅读过一些Java集合类的源码,可以发现通常我们会将两者结合起来一起用,比如像下面这样:
public class Collections { public static <T> void copy( List <? super T> dest, List <? extends T> src) { for ( int i= 0 ; i<src.size(); i++) dest. set (i, src. get (i)); } }
Java泛型中最令人苦恼的地方或许就是类型擦除了,特别是对于有C++经验的程序员。类型擦除就是说Java泛型只能用于在编译期间的静态类型检查,然后编译器生成的代码会擦除相应的类型信息,这样到了运行期间实际上JVM根本就知道泛型所代表的具体类型。这样做的目的是因为Java泛型是1.5之后才被引入的,为了保持向下的兼容性,所以只能做类型擦除来兼容以前的非泛型代码。对于这一点,如果阅读Java集合框架的源码,可以发现有些类其实并不支持泛型。别乱打日志了,这才是正确的打日志姿势!
说了这么多,那么泛型擦除到底是什么意思呢?我们先来看一下下面这个简单的例子:
public class Node <T> { private T data; private Node <T> next ; public Node (T data, Node <T> next ) { this .data = data; this . next = next ; } public T getData() { return data; } }
编译器做完相应的类型检查之后,实际上到了运行期间上面这段代码实际上将转换成:
public class Node { private Object data; private Node next ; public Node ( Object data, Node next ) { this .data = data; this . next = next ; } public Object getData() { return data; } }
这意味着不管我们声明Node还是Node,到了运行期间,JVM统统视为Node。有没有什么办法可以解决这个问题呢?这就需要我们自己重新设置bounds了,将上面的代码修改成下面这样:
public class Node <T extends Comparable <T>> { private T data; private Node <T> next ; public Node (T data, Node <T> next ) { this .data = data; this . next = next ; } public T getData() { return data; } }
这样编译器就会将T出现的地方替换成Comparable而不再是默认的Object了:
public class Node { private Comparable data; private Node next ; public Node ( Comparable data, Node next ) { this .data = data; this . next = next ; } public Comparable getData() { return data; } }
上面的概念或许还是比较好理解,但其实泛型擦除带来的问题远远不止这些,接下来我们系统地来看一下类型擦除所带来的一些问题,有些问题在C++的泛型中可能不会遇见,但是在Java中却需要格外小心。
问题一
在Java中不允许创建泛型数组,类似下面这样的做法编译器会报错:
List < Integer >[] arrayOfLists = new List < Integer >[ 2 ];
为什么编译器不支持上面这样的做法呢?继续使用逆向思维,我们站在编译器的角度来考虑这个问题。
我们先来看一下下面这个例子:
Object [] strings = new String [ 2 ]; strings[ 0 ] = "hi" ; strings[ 1 ] = 100 ;
对于上面这段代码还是很好理解,字符串数组不能存放整型元素,而且这样的错误往往要等到代码运行的时候才能发现,编译器是无法识别的。接下来我们再来看一下假设Java支持泛型数组的创建会出现什么后果:
Object [] stringLists = new List < String >[]; stringLists[ 0 ] = new ArrayList < String >(); stringLists[ 1 ] = new ArrayList < Integer >();
假设我们支持泛型数组的创建,由于运行时期类型信息已经被擦除,JVM实际上根本就不知道new ArrayList()和new ArrayList()的区别。类似这样的错误假如出现才实际的应用场景中,将非常难以察觉。别乱打日志了,这才是正确的打日志姿势!
如果你对上面这一点还抱有怀疑的话,可以尝试运行下面这段代码:
public class ErasedTypeEquivalence { public static void main( String [] args) { Class c1 = new ArrayList < String >().getClass(); Class c2 = new ArrayList < Integer >().getClass(); System . out .println(c1 == c2); } }
问题二
继续复用我们上面的Node的类,对于泛型代码,Java编译器实际上还会偷偷帮我们实现一个Bridge method。
public class Node <T> { public T data; public Node (T data) { this .data = data; } public void setData(T data) { System . out .println( "Node.setData" ); this .data = data; } } public class MyNode extends Node < Integer > { public MyNode ( Integer data) { super (data); } public void setData( Integer data) { System . out .println( "MyNode.setData" ); super .setData(data); } }
看完上面的分析之后,你可能会认为在类型擦除后,编译器会将Node和MyNode变成下面这样:
public class Node { public Object data; public Node ( Object data) { this .data = data; } public void setData( Object data) { System . out .println( "Node.setData" ); this .data = data; } } public class MyNode extends Node { public MyNode ( Integer data) { super (data); } public void setData( Integer data) { System . out .println( "MyNode.setData" ); super .setData(data); } }
实际上不是这样的,我们先来看一下下面这段代码,这段代码运行的时候会抛出ClassCastException异常,提示String无法转换成Integer:
MyNode mn = new MyNode ( 5 ); Node n = mn; n.setData( "Hello" );
如果按照我们上面生成的代码,运行到第3行的时候不应该报错(注意我注释掉了第4行),因为MyNode中不存在setData(String data)方法,所以只能调用父类Node的setData(Object data)方法,既然这样上面的第3行代码不应该报错,因为String当然可以转换成Object了,那ClassCastException到底是怎么抛出的?
实际上Java编译器对上面代码自动还做了一个处理:
class MyNode extends Node { public void setData( Object data) { setData(( Integer ) data); } public void setData( Integer data) { System . out .println( "MyNode.setData" ); super .setData(data); } }
这也就是为什么上面会报错的原因了,setData((Integer) data);的时候String无法转换成Integer。所以上面第2行编译器提示unchecked warning的时候,我们不能选择忽略,不然要等到运行期间才能发现异常。如果我们一开始加上Node n = mn就好了,这样编译器就可以提前帮我们发现错误。
问题三
正如我们上面提到的,Java泛型很大程度上只能提供静态类型检查,然后类型的信息就会被擦除,所以像下面这样利用类型参数创建实例的做法编译器不会通过:
public static <E> void append( List <E> list) { E elem = new E(); list.add(elem); }
但是如果某些场景我们想要需要利用类型参数创建实例,我们应该怎么做呢?可以利用反射解决这个问题:
public static <E> void append( List <E> list, Class <E> cls) throws Exception { E elem = cls.newInstance(); list.add(elem); }
我们可以像下面这样调用:
List < String > ls = new ArrayList <>(); append(ls, String . class );
实际上对于上面这个问题,还可以采用Factory和Template两种设计模式解决,感兴趣的朋友不妨去看一下Thinking in Java中第15章中关于Creating instance of types(英文版第664页)的讲解,这里我们就不深入了。
问题四
我们无法对泛型代码直接使用instanceof关键字,因为Java编译器在生成代码的时候会擦除所有相关泛型的类型信息,正如我们上面验证过的JVM在运行时期无法识别出ArrayList和ArrayList的之间的区别:
public static <E> void rtti( List <E> list) { if (list instanceof ArrayList < Integer >) { } } => { ArrayList < Integer >, ArrayList < String >, LinkedList < Character >, ... }
和上面一样,我们可以使用通配符重新设置bounds来解决这个问题:
public static void rtti( List <?> list) { if (list instanceof ArrayList <?>) { } }
工厂模式
接下来我们利用泛型来简单的实现一下工厂模式,首先我们先声明一个接口Factory:
package typeinfo.factory; public interface Factory <T> { T create(); }
接下来我们来创建几个实体类FuelFilter和AirFilter以及FanBelt和GeneratorBelt。
class Filter extends Part {} class FuelFilter extends Filter { public static class Factory implements typeinfo.factory. Factory < FuelFilter > { public FuelFilter create() { return new FuelFilter (); } } } class AirFilter extends Filter { public static class Factory implements typeinfo.factory. Factory < AirFilter > { public AirFilter create() { return new AirFilter (); } } } class Belt extends Part {} class FanBelt extends Belt { public static class Factory implements typeinfo.factory. Factory < FanBelt > { public FanBelt create() { return new FanBelt (); } } } class GeneratorBelt extends Belt { public static class Factory implements typeinfo.factory. Factory < GeneratorBelt > { public GeneratorBelt create() { return new GeneratorBelt (); } } }
Part类的实现如下,注意我们上面的实体类都是Part类的间接子类。在Part类我们注册了我们上面的声明的实体类。所以以后我们如果要创建相关的实体类的话,只需要在调用Part类的相关方法了。这么做的一个好处就是如果的业务中出现了CabinAirFilter或者PowerSteeringBelt的话,我们不需要修改太多的代码,只需要在Part类中将它们注册即可。老大难的空指针,如何优雅处理?
class Part { static List < Factory <? extends Part >> partFactories = new ArrayList < Factory <? extends Part >>(); static { partFactories.add( new FuelFilter . Factory ()); partFactories.add( new AirFilter . Factory ()); partFactories.add( new FanBelt . Factory ()); partFactories.add( new PowerSteeringBelt . Factory ()); } private static Random rand = new Random ( 47 ); public static Part createRandom() { int n = rand.nextInt(partFactories.size()); return partFactories. get (n).create(); } public String toString() { return getClass().getSimpleName(); } }
最后我们来测试一下:
public class RegisteredFactories { public static void main(String[] args) { for (int i = 0; i < 10; i++) { System.out.println(Part.createRandom()); } } }