Java中如何获取泛型类型信息

文章目录

  • 声明侧泛型
  • 使用侧泛型
  • 获取泛型类型相关方法
    • 1. Class类的泛型方法
    • 2. Field类的泛型方法
    • 3. Method类的泛型方法
    • 4. ParameterizedType类
    • 获取声明侧的泛型类型信息
    • 获取使用侧的泛型类型信息
      • 匿名内部类实现获取使用侧的泛型类型

        根据使用泛型位置的不同可以分为:声明侧泛型、使用侧泛型。

        声明侧的泛型信息被记录在Class文件的Constant pool中以Signature的形式保存。而使用侧的泛型信息并没有保存。

        声明侧泛型

        声明侧泛型包括:

        1. 泛型类,或泛型接口的声明
        2. 带有泛型参数的成员变量
        3. 带有泛型参数的方法

        使用侧泛型

        使用侧泛型包括:

        1. 方法的局部变量,
        2. 方法调用时传入的变量

        获取泛型类型相关方法

        上文有提到,声明侧的泛型被记录在Class文件的Constant pool中以Signature的形式保存。

        JDK的Class、Field、Method类提供了一系列的获取泛型类型的相关方法。

        1. Class类的泛型方法

        • Type getGenericSuperclass():获取父类的Type

          • 若父类有泛型,返回的实际Type是ParameterizedType接口的实现类ParameterizedTypeImpl类
          • 若父类无泛型,返回的实际Type是Class类
          • Type[] getGenericInterfaces():获取父接口的Type集合

            • 若父类有泛型,返回的实际Type是ParameterizedType接口的实现类ParameterizedTypeImpl类
            • 若父类无泛型,返回的实际Type是Class类

              2. Field类的泛型方法

              • Type getGenericType():获取字段的Type

                • 若字段有泛型,返回的实际Type是ParameterizedType接口的实现类ParameterizedTypeImpl类
                • 若字段无泛型,返回的实际Type是Class类

                  3. Method类的泛型方法

                  • Type getGenericReturnType():获取方法返回值的Type

                    • 若返回值有泛型,返回的实际Type是ParameterizedType接口的实现类ParameterizedTypeImpl类
                    • 若返回值无泛型,返回的实际Type是Class类
                    • Type[] getGenericParameterTypes():获取方法参数的Type集合

                      • 若方法参数有泛型,返回的实际Type是ParameterizedType接口的实现类ParameterizedTypeImpl类
                      • 若方法参数无泛型,返回的实际Type是Class类
                      • Type[] getGenericExceptionTypes():获取方法声明的异常的Type集合

                        • 若方法参数有泛型,返回的实际Type是ParameterizedType接口的实现类ParameterizedTypeImpl类
                        • 若方法参数无泛型,返回的实际Type是Class类

                          4. ParameterizedType类

                          ParameterizedType是Type的子接口,表示参数化类型,用于获取泛型的参数类型。

                          ParameterizedType的主要方法:

                          • Type[] getActualTypeArguments():获取实际类型参数的Type集合

                          • Type getRawType():获取声明此类型的类或接口的Type

                          • Type getOwnerType():如果声明此类型的类或接口为内部类,这返回的是该内部类的外部类的Type(也就是该内部类的拥有者)

                            获取声明侧的泛型类型信息

                            1. 泛型类,或泛型接口的声明
                            2. 带有泛型参数的成员变量
                            3. 带有泛型参数的方法

                            示例:

                            public class MyTest extends TestClass implements TestInterface1,TestInterface2 { private List list;
                                private Map map;
                                public List aa() { return null;
                                }
                                public void bb(List list) { }
                                public static void main(String[] args) throws Exception { System.out.println("======================================= 泛型类声明的泛型类型 =======================================");
                                    ParameterizedType parameterizedType = (ParameterizedType)MyTest.class.getGenericSuperclass();
                                    System.out.println(parameterizedType.getTypeName() + "--------->" + parameterizedType.getActualTypeArguments()[0].getTypeName());
                                    Type[] types = MyTest.class.getGenericInterfaces();
                                    for (Type type : types) { ParameterizedType typ = (ParameterizedType)type;
                                        System.out.println(typ.getTypeName() + "--------->" + typ.getActualTypeArguments()[0].getTypeName());
                                    }
                                    System.out.println("======================================= 成员变量中的泛型类型 =======================================");
                                    ParameterizedType parameterizedType1 = (ParameterizedType)MyTest.class.getDeclaredField("list").getGenericType();
                                    System.out.println(parameterizedType1.getTypeName() + "--------->" + parameterizedType1.getActualTypeArguments()[0].getTypeName());
                                    ParameterizedType parameterizedType2 = (ParameterizedType)MyTest.class.getDeclaredField("map").getGenericType();
                                    System.out.println(parameterizedType2.getTypeName() + "--------->" + parameterizedType2.getActualTypeArguments()[0].getTypeName()+","+parameterizedType2.getActualTypeArguments()[1].getTypeName());
                                    System.out.println("======================================= 方法参数中的泛型类型 =======================================");
                                    ParameterizedType parameterizedType3 = (ParameterizedType)MyTest.class.getMethod("aa").getGenericReturnType();
                                    System.out.println(parameterizedType3.getTypeName() + "--------->" + parameterizedType3.getActualTypeArguments()[0].getTypeName());
                                    System.out.println("======================================= 方法返回值中的泛型类型 =======================================");
                                    Type[] types1 = MyTest.class.getMethod("bb", List.class).getGenericParameterTypes();
                                    for (Type type : types1) { ParameterizedType typ = (ParameterizedType)type;
                                        System.out.println(typ.getTypeName() + "--------->" + typ.getActualTypeArguments()[0].getTypeName());
                                    }
                                }
                            }
                            class TestClass {}
                            interface TestInterface1 {}
                            interface TestInterface2 {}
                            

                            输出

                            ======================================= 泛型类声明的泛型类型 =======================================
                            com.joker.test.generic.TestClass--------->java.lang.String
                            com.joker.test.generic.TestInterface1--------->java.lang.Integer
                            com.joker.test.generic.TestInterface2--------->java.lang.Long
                            ======================================= 成员变量中的泛型类型 =======================================
                            java.util.List--------->java.lang.Integer
                            java.util.Map--------->java.lang.Integer,java.lang.String
                            ======================================= 方法参数中的泛型类型 =======================================
                            java.util.List--------->java.lang.String
                            ======================================= 方法返回值中的泛型类型 =======================================
                            java.util.List--------->java.lang.Long
                            

                            获取使用侧的泛型类型信息

                            上面讲的相关类的获取泛型类型相关方法都只是针对声明侧的泛型。因为声明侧的泛型被记录在Class文件的Constant pool中以Signature的形式保存。所以Java提供了相关方法能获取到这些信息。

                            那使用侧的泛型信息怎么获取呢?由于使用侧的泛型信息在编译期的时候就被类型擦除了,所以运行时是没办法获取到这些泛型信息的。

                            难道就真的没办法了吗,其实还是有的。使用侧需要获取泛型信息的地方主要是:方法调用时传入的泛型变量,通常需要在方法中获取变量的泛型类型。比如在JSON解析(反序列化)的场景,他们是怎么实现的了。

                            针对获取使用侧的泛型类型信息,主要实现方案是通过匿名内部类。

                            Gson中的泛型抽象类TypeToken,FastJson中的泛型类TypeReference等就是用的该方案。

                            匿名内部类实现获取使用侧的泛型类型

                            上文有讲到,在声明侧的泛型中,针对泛型类或泛型接口的声明的泛型,Class类提供了getGenericSuperclass()、getGenericInterfaces()来获取其子类(实现类)上声明的具体泛型类型信息。

                            而匿名内部类是什么?其本质就是一个继承/实现了某个类(接口,普通类,抽象类)的子类匿名对象。

                            匿名内部类实现获取使用侧的泛型类型的原理:

                            1. 定义泛型类,泛型类中有一个Type类型的字段,用于保存泛型类型的Type
                            2. 通过匿名内部类的方式创建该泛型类的子类实例(指定了具体的泛型类型)

                              在创建子类实例的构造方法中,已经通过子类的Class的getGenericSuperclass()获取到了泛型类型信息并复制给了Type类型的字段中。

                            3. 随后任何地方,只要得到了该子类实例,就可以通过实例得到泛型类型的Type,这就得到了使用侧的泛型类信息。

                            简单示例:

                            定义泛型类TestClass2,类中包含字段Type

                            public abstract class TestClass2 { private final Type type;
                                public TestClass2() { Type superClass = getClass().getGenericSuperclass();
                                    if (!(superClass instanceof ParameterizedType)) { throw new IllegalArgumentException("无泛型类型信息");
                                    }
                                    type = ((ParameterizedType) superClass).getActualTypeArguments()[0];
                                }
                                public Type getType() { return type;
                                }
                            }
                            

                            测试获取泛型类型

                            public class Test { public static  T get(TestClass2 tTestClass2) throws IllegalAccessException, InstantiationException { Type type = tTestClass2.getType();
                                    Class clazz = (Class) type;
                                    return (T)clazz.newInstance();
                                }
                                public static void main(String[] args) throws InstantiationException, IllegalAccessException { String str = get(new TestClass2() {});
                                    Date date = get(new TestClass2() {});
                                }
                            }