Java——反射

这里写目录标题

• • 1、Class类
  • • 1.1、名称信息
    • 1.2、字段信息
    • 1.3、方法信息
    • 1.4、创建对象和构造方法
    • 1.5、类型检查和转换
    • 1.6、Class的类型信息
    • 1.7、类的声明信息
    • 1.8、类的加载
    • 1.9、反射与数组
    • 1.10、反射与枚举
  • 2、应用示例
  • 3、反射与泛型

1、Class类

每个已加载的类在内存都有一份类信息，每个对象都有指向它所属类信息的引用。Java中，类信息对应的类就是java.lang.Class。注意不是小写的class, class是定义类的关键字。所有类的根父类Object有一个方法，可以获取对象的Class对象：

public final native Class<? > getClass()

Class是一个泛型类，有一个类型参数，getClass()并不知道具体的类型，所以返回Class<?>。

获取Class对象不一定需要实例对象，如果在写程序时就知道类名，可以使用<类名>.class获取Class对象，比如：

Class<Date> cls = Date.class;

接口也有Class对象，且这种方式对于接口也是适用的，比如：

Class<Integer> intCls = int.class;
Class<Byte> byteCls = byte.class;
Class<Character> charCls = char.class;
Class<Double> doubleCls = double.class;

void作为特殊的返回类型，也有对应的Class：

Class<Void> voidCls = void.class;

对于数组，每种类型都有对应数组类型的Class对象，每个维度都有一个，即一维数组有一个，二维数组有一个不同的类型。比如：

String[] strArr = new String[10];
int[][] twoDimArr = new int[3][2];
int[] oneDimArr = new int[10];
Class<? extends String[]> strArrCls = strArr.getClass();
Class<? extends int[][]> twoDimArrCls = twoDimArr.getClass();
Class<? extends int[]> oneDimArrCls = oneDimArr.getClass();

枚举类型也有对应的Class，比如：

enum Size {
    SMALL, MEDIUM, BIG
}
Class<Size> cls = Size.class;

Class有一个静态方法forName，可以根据类名直接加载Class，获取Class对象，比如：

try {
    Class<? > cls = Class.forName("java.util.HashMap");
    System.out.println(cls.getName());
} catch (ClassNotFoundException e) {
    e.printStackTrace();
}

注意forName可能抛出异常ClassNotFoundException。

有了Class对象后，我们就可以了解到关于类型的很多信息，并基于这些信息采取一些行动。Class的方法很多，大部分比较简单直接，容易理解，下面，我们分为若干组，包括名称信息、字段信息、方法信息、创建对象和构造方法、类型信息等，进行简要介绍。

1.1、名称信息

Class有如下方法，可以获取与名称有关的信息：

public String getName()
public String getSimpleName()
public String getCanonicalName()
public Package getPackage()

getSimpleName返回的名称不带包信息，getName返回的是Java内部使用的真正的名称，getCanonicalName返回的名称更为友好，getPackage返回的是包信息，它们的不同如表所示。

Class对象	getName	getSimpleName	getCanonicalName	getPackage
int.class	int	int	int	null
int[].class	{I	int[]	int{}	null
int[][].class	[[I	int[][]	int[][]	null
String.class	java.lang.String	String	java.lang.String	java.lang
String[].class	[Ljava.lang.String;	String[]	java.lang.String[]	null
HashMap.class	java.util.HashMap	HashMap	java.util.HashMap	java.util
Map.Entry.class	java.util.Map$Entry	Entry	java.util.Map.Entry	java.util

需要说明的是数组类型的getName返回值，它使用前缀[表示数组，有几个[表示是几维数组；数组的类型用一个字符表示，I表示int, L表示类或接口，其他类型与字符的对应关系为：boolean(Z)、byte(B)、char©、double(D)、float(F)、long(J)、short(S)。对于引用类型的数组，注意最后有一个分号；​。

1.2、字段信息

类中定义的静态和实例变量都被称为字段，用类Field表示，位于包java.lang.reflect下，后文涉及的反射相关的类都位于该包下。Class有4个获取字段信息的方法：

//返回所有的public字段，包括其父类的，如果没有字段，返回空数组
public Field[] getFields()
//返回本类声明的所有字段，包括非public的，但不包括父类的
public Field[] getDeclaredFields()
//返回本类或父类中指定名称的public字段，找不到抛出异常NoSuchFieldException
public Field getField(String name)
//返回本类中声明的指定名称的字段，找不到抛出异常NoSuchFieldException
public Field getDeclaredField(String name)

Field也有很多方法，可以获取字段的信息，也可以通过Field访问和操作指定对象中该字段的值，基本方法有：

//获取字段的名称
public String getName()
//判断当前程序是否有该字段的访问权限
public boolean isAccessible()
//flag设为true表示忽略Java的访问检查机制，以允许读写非public的字段
public void setAccessible(boolean flag)
//获取指定对象obj中该字段的值
public Object get(Object obj)
//将指定对象obj中该字段的值设为value
public void set(Object obj, Object value)

在get/set方法中，对于静态变量，obj被忽略，可以为null，如果字段值为基本类型， get/set会自动在基本类型与对应的包装类型间进行转换；对于private字段，直接调用get/set会抛出非法访问异常IllegalAccessException，应该先调用setAccessible(true)以关闭Java的检查机制。看段简单的示例代码：

public static void main(String[] args) throws IllegalAccessException {
    List<String> obj = Arrays.asList(new String[]{"tom", "jerry"});
    Class<? extends List> cls = obj.getClass();
    for (Field f : cls.getDeclaredFields()) {
        f.setAccessible(true);
        System.out.println(f.getName() + " - " + f.get(obj));
    }
}

代码比较简单，就不赘述了。除了以上方法，Field还有很多其他方法，比如：

//返回字段的修饰符
public int getModifiers()
//返回字段的类型
public Class<? > getType()
//以基本类型操作字段
public void setBoolean(Object obj, boolean z)
public boolean getBoolean(Object obj)
public void setDouble(Object obj, double d)
public double getDouble(Object obj)
//查询字段的注解信息，下一章介绍注解
public <T extends Annotation> T getAnnotation(Class<T> annotationClass)
public Annotation[] getDeclaredAnnotations()

getModifiers返回的是一个int，可以通过Modifier类的静态方法进行解读。比如，假定Student类有如下字段：

public static final int MAX_NAME_LEN = 255;

可以这样查看该字段的修饰符：

Field f = Student.class.getField("MAX_NAME_LEN");
int mod = f.getModifiers();
System.out.println(Modifier.toString(mod));
System.out.println("isPublic: " + Modifier.isPublic(mod));
System.out.println("isStatic: " + Modifier.isStatic(mod));
System.out.println("isFinal: " + Modifier.isFinal(mod));
System.out.println("isVolatile: " + Modifier.isVolatile(mod));

输出为：

public static final
isPublic: true
isStatic: true
isFinal: true
isVolatile: false

1.3、方法信息

类中定义的静态和实例方法都被称为方法，用类Method表示。Class有如下相关方法：

 //返回所有的public方法，包括其父类的，如果没有方法，返回空数组
 public Method[] getMethods()
 //返回本类声明的所有方法，包括非public的，但不包括父类的
 public Method[] getDeclaredMethods()
 //返回本类或父类中指定名称和参数类型的public方法，
 //找不到抛出异常NoSuchMethodException
 public Method getMethod(String name, Class<? >... parameterTypes)
 //返回本类中声明的指定名称和参数类型的方法，找不到抛出异常NoSuchMethodException
 public Method getDeclaredMethod(String name, Class<? >... parameterTypes)

通过Method可以获取方法的信息，也可以通过Method调用对象的方法，基本方法有：

//获取方法的名称
public String getName()
//flag设为true表示忽略Java的访问检查机制，以允许调用非public的方法
public void setAccessible(boolean flag)
//在指定对象obj上调用Method代表的方法，传递的参数列表为args
public Object invoke(Object obj, Object... args) throws
   IllegalAccessException, Illegal-ArgumentException, InvocationTargetException

对invoke方法，如果Method为静态方法，obj被忽略，可以为null, args可以为null，也可以为一个空的数组，方法调用的返回值被包装为Object返回，如果实际方法调用抛出异常，异常被包装为InvocationTargetException重新抛出，可以通过getCause方法得到原异常。看段简单的示例：

Class<? > cls = Integer.class;
try {
    Method method = cls.getMethod("parseInt", new Class[]{String.class});
    System.out.println(method.invoke(null, "123"));
} catch (NoSuchMethodException e) {
    e.printStackTrace();
} catch (InvocationTargetException e) {
    e.printStackTrace();
}

Method还有很多方法，可以获取其修饰符、参数、返回值、注解等信息，具体就不列举了。

1.4、创建对象和构造方法

Class有一个方法，可以用它来创建对象：

public T newInstance() throws InstantiationException, IllegalAccessException

它会调用类的默认构造方法（即无参public构造方法）​，如果类没有该构造方法，会抛出异常InstantiationException。看个简单示例：

Map<String, Integer> map = HashMap.class.newInstance();
map.put("hello", 123);

newInstance只能使用默认构造方法。Class还有一些方法，可以获取所有的构造方法：

//获取所有的public构造方法，返回值可能为长度为0的空数组
public Constructor<? >[] getConstructors()
//获取所有的构造方法，包括非public的
public Constructor<? >[] getDeclaredConstructors()
//获取指定参数类型的public构造方法，没找到抛出异常NoSuchMethodException
public Constructor<T> getConstructor(Class<? >... parameterTypes)
//获取指定参数类型的构造方法，包括非public的，没找到抛出异常NoSuchMethodException
public Constructor<T> getDeclaredConstructor(Class<? >... parameterTypes)

类Constructor表示构造方法，通过它可以创建对象，方法为：

public T newInstance(Object ... initargs) throws InstantiationException,
        IllegalAccessException, IllegalArgumentException, InvocationTargetException

看个例子：

Constructor<StringBuilder> contructor= StringBuilder.class
                    .getConstructor(new Class[]{int.class});
StringBuilder sb = contructor.newInstance(100);

除了创建对象，Constructor还有很多方法，可以获取关于构造方法的很多信息，包括参数、修饰符、注解等，具体就不列举了。

1.5、类型检查和转换

我们之前介绍过instanceof关键字，它可以用来判断变量指向的实际对象类型。instanceof后面的类型是在代码中确定的，如果要检查的类型是动态的，可以使用Class类的如下方法：

public native boolean isInstance(Object obj)

也就是说，如下代码：

if(list instanceof ArrayList){
    System.out.println("array list");
}

和下面代码的输出是相同的：

Class cls = Class.forName("java.util.ArrayList");
if(cls.isInstance(list)){
    System.out.println("array list");
}

除了判断类型，在程序中也往往需要进行强制类型转换，比如：

List list = ..
if(list instanceof ArrayList){
    ArrayList arrList = (ArrayList)list;
}

在这段代码中，强制转换到的类型是在写代码时就知道的。如果是动态的，可以使用Class的如下方法：

public T cast(Object obj)

比如：

public static <T> T toType(Object obj, Class<T> cls){
    return cls.cast(obj);
}

isInstance/cast描述的都是对象和类之间的关系，Class还有一个方法，可以判断Class之间的关系：

//检查参数类型cls能否赋给当前Class类型的变量
public native boolean isAssignableFrom(Class<? > cls);

比如，如下表达式的结果都为true：

Object.class.isAssignableFrom(String.class)
String.class.isAssignableFrom(String.class)
List.class.isAssignableFrom(ArrayList.class)

1.6、Class的类型信息

Class代表的类型既可以是普通的类，也可以是内部类，还可以是基本类型、数组等，对于一个给定的Class对象，它到底是什么类型呢？可以通过以下方法进行检查：

public native boolean isArray()  //是否是数组
public native boolean isPrimitive()  //是否是基本类型
public native boolean isInterface()  //是否是接口
public boolean isEnum()  //是否是枚举
public boolean isAnnotation()  //是否是注解
public boolean isAnonymousClass()  //是否是匿名内部类
public boolean isMemberClass()  //是否是成员类，成员类定义在方法外，不是匿名类
public boolean isLocalClass()  //是否是本地类，本地类定义在方法内，不是匿名类

1.7、类的声明信息

Class还有很多方法，可以获取类的声明信息，如修饰符、父类、接口、注解等，如下所示：

//获取修饰符，返回值可通过Modifier类进行解读
public native int getModifiers()
//获取父类，如果为Object，父类为null
public native Class<? super T> getSuperclass()
//对于类，为自己声明实现的所有接口，对于接口，为直接扩展的接口，不包括通过父类继承的
public native Class<? >[] getInterfaces();
//自己声明的注解
public Annotation[] getDeclaredAnnotations()
//所有的注解，包括继承得到的
public Annotation[] getAnnotations()
//获取或检查指定类型的注解，包括继承得到的
public <A extends Annotation> A getAnnotation(Class<A> annotationClass)
public boolean isAnnotationPresent(
                Class<? extends Annotation> annotationClass)

1.8、类的加载

Class有两个静态方法，可以根据类名加载类：

public static Class<? > forName(String className)
public static Class<? > forName(String name, boolean initialize,
   ClassLoader loader)

ClassLoader表示类加载器，第24章会进一步介绍，initialize表示加载后，是否执行类的初始化代码（如static语句块）​。第一个方法中没有传这些参数，相当于调用：

Class.forName(className, true, currentLoader)

currentLoader表示加载当前类的ClassLoader。

这里className与Class.getName的返回值是一致的。比如，对于String数组：

String name = "[Ljava.lang.String;";
Class cls = Class.forName(name);
System.out.println(cls == String[].class);

需要注意的是，基本类型不支持forName方法，也就是说，如下写法：

Class.forName("int");

会抛出异常ClassNotFoundException。那如何根据原始类型的字符串构造Class对象呢？可以对Class.forName进行一下包装，比如：

public static Class<? > forName(String className)
        throws ClassNotFoundException{
    if("int".equals(className)){
        return int.class;
    }
    //其他基本类型略
    return Class.forName(className);
}

需要说明的是，Java 9还有一个forName方法，用于加载指定模块中指定名称的类：

public static Class<? > forName(Module module, String name)

参数module表示模块，这是Java 9引入的类，当找不到类的时候，它不会抛出异常，而是返回null，它也不会执行类的初始化。

1.9、反射与数组

对于数组类型，有一个专门的方法，可以获取它的元素类型：

public native Class<? > getComponentType()

比如：

String[] arr = new String[]{};
System.out.println(arr.getClass().getComponentType());

输出为：

class java.lang.String

java.lang.reflect包中有一个针对数组的专门的类Array（注意不是java.util中的Arrays)，提供了对于数组的一些反射支持，以便于统一处理多种类型的数组，主要方法有：

//创建指定元素类型、指定长度的数组
public static Object newInstance(Class<? > componentType, int length)
//创建多维数组
public static Object newInstance(Class<? > componentType, int... dimensions)
//获取数组array指定的索引位置index处的值
public static native Object get(Object array, int index)
//修改数组array指定的索引位置index处的值为value
public static native void set(Object array, int index, Object value)
//返回数组的长度
public static native int getLength(Object array)

需要注意的是，在Array类中，数组是用Object而非Object[​]表示的，这是为什么呢？这是为了方便处理多种类型的数组。int[​]​、String[​]都不能与Object[​]相互转换，但可以与Object相互转换，比如：

int[] intArr = (int[])Array.newInstance(int.class, 10);
String[] strArr = (String[])Array.newInstance(String.class, 10);

除了以Object类型操作数组元素外，Array也支持以各种基本类型操作数组元素，如：

public static native double getDouble(Object array, int index)
public static native void setDouble(Object array, int index, double d)
public static native void setLong(Object array, int index, long l)
public static native long getLong(Object array, int index)

1.10、反射与枚举

枚举类型也有一个专门方法，可以获取所有的枚举常量：

public T[] getEnumConstants()

2、应用示例

介绍了Class的这么多方法，有什么用呢？我们看个简单的示例，利用反射实现一个简单的通用序列化/反序列化类SimpleMapper ，它提供两个静态方法：

public static String toString(Object obj)
public static Object fromString(String str)

toString将对象obj转换为字符串，fromString将字符串转换为对象。为简单起见，我们只支持最简单的类，即有默认构造方法，成员类型只有基本类型、包装类或String。另外，序列化的格式也很简单，第一行为类的名称，后面每行表示一个字段，用字符'='分隔，表示字段名称和字符串形式的值。我们先看SimpleMapper的用法，如代码所示。

public class SimpleMapperDemo {
    static class Student {
        String name;
        int age;
        Double score;

		//省略了构造方法，getter/setter和toString方法

        
    }

    public static void main(String[] args) {
        Student student = new Student("tom", 18, 89d);
        String str = SimpleMapper.toString(student);
        Student student2 = (Student)SimpleMapper.fromString(str);
        System.out.println(student2);
    }
}

代码先调用toString方法将对象转换为了String，然后调用fromString方法将字符串转换为了Student，新对象的值与原对象是一样的，输出如下所示：

Student [name=张三， age=18, score=89.0]

我们来看SimpleMapper的示例实现（主要用于演示原理）, toString的代码为：

public static String toString(Object obj) {
    try {
        Class<?> cls = obj.getClass();
        StringBuilder sb = new StringBuilder();
        sb.append(cls.getName() + "\n");
        for (Field f : cls.getDeclaredFields()) {
            if (!f.isAccessible()) {
                f.setAccessible(true);
            }
            sb.append(f.getName() + "=" + f.get(obj).toString() + "\n");
        }
        return sb.toString();
    } catch (IllegalAccessException e) {
        throw new RuntimeException(e);
    }
}

代码比较简单，我们就不赘述了。fromString的代码为：

public static Object fromString(String str) {
    try {
        String[] lines = str.split("\n");
        if (lines.length < 1) {
            throw new IllegalArgumentException(str);
        }
        Class<?> cls = Class.forName(lines[0]);
        Object obj = cls.newInstance();
        if (lines.length > 1) {
            for (int i = 1; i < lines.length; i++) {
                String[] fv = lines[i].split("=");
                if(fv.length != 2) {
                    throw new IllegalArgumentException(lines[i]);
                }
                Field f = cls.getDeclaredField(fv[0]);
                if(!f.isAccessible()) {
                    f.setAccessible(true);
                }
                setFieldValue(f, obj, fv[1]);
            }
        }
        return obj;
    } catch (Exception e) {
        throw new RuntimeException(e);
    }
}

它调用了setFieldValue方法对字段设置值，其代码为：

private static void setFieldValue(Field f, Object obj, String value)
        throws Exception {
          Class<? > type = f.getType();
          if(type == int.class) {
              f.setInt(obj, Integer.parseInt(value));
          } else if(type == byte.class) {
              f.setByte(obj, Byte.parseByte(value));
          } else if(type == short.class) {
              f.setShort(obj, Short.parseShort(value));
          } else if(type == long.class) {
              f.setLong(obj, Long.parseLong(value));
          } else if(type == float.class) {
              f.setFloat(obj, Float.parseFloat(value));
          } else if(type == double.class) {
              f.setDouble(obj, Double.parseDouble(value));
          } else if(type == char.class) {
              f.setChar(obj, value.charAt(0));
          } else if(type == boolean.class) {
              f.setBoolean(obj, Boolean.parseBoolean(value));
          } else if(type == String.class) {
              f.set(obj, value);
          } else {
              Constructor<? > ctor = type.getConstructor(
                      new Class[] { String.class });
              f.set(obj, ctor.newInstance(value));
          }
      }

setFieldValue根据字段的类型，将字符串形式的值转换为了对应类型的值，对于基本类型和String以外的类型，它假定该类型有一个以String类型为参数的构造方法。

3、反射与泛型

Class有如下方法，可以获取类的泛型参数信息：

public TypeVariable<Class<T>>[] getTypeParameters()

Field有如下方法：

public Type getGenericType()

Method有如下方法：

public Type getGenericReturnType()
public Type[] getGenericParameterTypes()
public Type[] getGenericExceptionTypes()

Constructor有如下方法：

public Type[] getGenericParameterTypes()

Type是一个接口，Class实现了Type, Type的其他子接口还有：

• TypeVariable：类型参数，可以有上界，比如Textends Number；
• ParameterizedType：参数化的类型，有原始类型和具体的类型参数，比如List；
• WildcardType：通配符类型，比如？、?extends Number、? super Integer。

public class GenericDemo {
    static class GenericTest<U extends Comparable<U>, V> {
        U u;
        V v;
        List<String> list;
        public U test(List<? extends  Number> numbers) {
            return null;
        }
    }

    public static void main(String[] args) throws NoSuchMethodException, NoSuchFieldException {
        Class<?> cls = GenericTest.class;
        //类的类型参数，即泛型形参的声明
        for (TypeVariable t : cls.getTypeParameters()) {
            System.out.println(t.getName() + " extends " + Arrays.toString(t.getBounds()));
            //U extends [java.lang.Comparable<U>]
            //V extends [class java.lang.Object]
        }
        //字段：泛型类型
        Field fu = cls.getDeclaredField("u");
        //U
        System.out.println(fu.getGenericType());
        //字段：参数化的类型
        Field flist = cls.getDeclaredField("list");
        Type listType = flist.getGenericType();
        if(listType instanceof ParameterizedType) {
            ParameterizedType pType = (ParameterizedType) listType;
            System.out.println("raw type: " + pType.getRawType()
                + ", type arguments:"
                + Arrays.toString(pType.getActualTypeArguments()));
        }
        //方法的泛型参数
        Method m = cls.getMethod("test", new Class[]{List.class});
        for (Type t : m.getGenericParameterTypes()) {
            System.out.println(t);
            //java.util.List<? extends java.lang.Number>
        }
    }
}

程序的输出为：

U extends [java.lang.Comparable<U>]
V extends [class java.lang.Object]
U
raw type: interface java.util.List, type arguments:[class java.lang.String]
java.util.List<? extends java.lang.Number>