1. 概述
Java 反射是可以让我们在运行时获取类的方法、属性、父类、接口等类的内部信息的机制。也就是说,反射本质上是一个“反着来”的过程。我们通过new创建一个类的实例时,实际上是由Java虚拟机根据这个类的Class对象在运行时构建出来的,而反射是通过一个类的Class对象来获取它的定义信息,从而我们可以访问到它的属性、方法,知道这个类的父类、实现了哪些接口等信息。
2. Class类
我们知道使用javac能够将.java文件编译为.class文件,这个.class文件包含了我们对类的原始定义信息(父类、接口、构造器、属性、方法等)。.class文件在运行时会被ClassLoader加载到Java虚拟机(JVM)中,当一个.class文件被加载后,JVM会为之生成一个Class对象,我们在程序中通过new实例化的对象实际上是在运行时根据相应的Class对象构造出来的。确切的说,这个Class对象实际上是java.lang.Class<T>泛型类的一个实例,比如Class<MyClass>对象即为一个封装了MyClass类的定义信息的Class<T>实例。由于java.lang.Class<T>类不存在公有构造器,因此我们不能直接实例化这个类,我们可以通过以下方法获取一个Class对象。
在下面的讲解中,我们将以People类和Student类为例:
1 public class People { 2 private String name; 3 private int age; 4 5 public People(String name, int age) { 6 this.name = name; 7 this.age = age; 8 } 9 10 public int getAge() { 11 return age; 12 } 13 14 public String getName() { 15 return name; 16 } 17 18 public void setAge(int age) { 19 this.age = age; 20 } 21 22 public void setName(String name) { 23 this.name = name; 24 } 25 26 public void speak() { 27 System.out.println(getName() + " " + getAge()); 28 } 29 }
1 public class Student extends People { 2 private int grade; 3 4 public Student(String name, int age) { 5 super(name, age); 6 } 7 8 public Student(String name, int age, int grade) { 9 super(name, age); 10 this.grade = grade; 11 } 12 13 public int getGrade() { 14 return grade; 15 } 16 17 public void setGrade(int grade) { 18 this.grade = grade; 19 } 20 21 private void learn(String course) { 22 System.out.println(name + " learn " + course); 23 } 24 }
(1) 通过类名获取Class对象:
若在编译期知道一个类的名字,我们可以这样获取它的Class对象:
1 Class<People> peopleClass = People.class;
还有一种根据类的完整路径名获取Class对象的方法如下所示:
1 Class<People> peopleClass = Class.forName("com.test.People"); //假设People类在com.test包中
注意,Class.forName()方法的参数必须是一个类的全路径名。实际上,只要我们“import com.test.People",就可以直接通过”People.class"获取他的Class对象,而不用写出全路径这么麻烦。
(若在调用 Class.forName()方法时,没有在classpath找到对应的类,会抛出 ClassNotFoundException。)
(2) 通过对象本身获取其Class对象:
1 People people = new People("Bill", 18); 2 Class<People> peopleClass = people.getClass();
3. 通过反射获取类的构造器
一旦我们获得了People的Class 对象,我们便可以通过这个Class 对象获取到People类的原始定义信息。 首先,我们来获取People类的构造器对象,有了这个构造器对象,我们便能够构造出一个People对象出来。比如,我们可以在Student.java中添加以下代码:
1 public static void main(String[] args) { 2 Class<People> pClass = People.class; 3 System.out.println(pClass); 4 try { 5 Constructor<People> constructor = pClass.getConstructor(String.class, int.class); 6 People people = constructor.newInstance("Bill", 18); 7 obj.speak(); 8 } catch (Exception e) { 9 e.printStackTrace(); 10 } 11 }
在第4行,我们调用getConstructor方法来获取一个People类的构造器对象,由于我们想要获取的构造器的形参类型为String和int,所以我们传入String.class和int.class。有了构造器对象,我们便可以调用newInstance方法来创建一个people对象,如上面代码的第6行所示。
注意,当通过反射获取到类的 Constructor、Method、Field对象后,在调用这些对象的方法之前,先将此对象的 accessible 标志设置为 true,以取消 Java 语言访问检查,可以提升反射速度。如以下代码所示:
1 Constructor<People> constructor = peopleClass.getConstructor(String.class, int.class); 2 // 设置 constructor 的 Accessible属性为ture以取消Java的访问检查 3 constructor.setAccessible(true);
4. 通过反射获取类中定义的方法
(1) 获取当前类中定义的方法(不包括从父类继承来的)
要获取当前类中定义的所有方法可以通过 Class 中的 getDeclaredMethods 函数,它会获取到当前类中定义的所有方法(包括private、public、static等各种方法),它会返回一个Method对象数组,其中的每个Method对象即表示了一个类中定义的方法。要想获得指定的方法,可以调用getDeclaredMethod(String name, Class...<T> parameterTypes)。如以下代码所示 :
1 private static void showDeclaredMethods() { 2 Student student = new Student("Bill", 18); 3 Method[] methods = student.getClass().getDeclaredMethods(); 4 for (Method method : methods) { 5 System.out.println("declared method name : " + method.getName()); 6 } 7 8 try { 9 //获取learnMethod对象(封装了learn方法) 10 Method learnMethod = student.getClass().getDeclaredMethod("learn", String.class); 11 //获取learn方法的参数列表并打印出来 12 Class<?>[] paramClasses = learnMethod.getParameterTypes() ; 13 for (Class<?> class : paramClasses) { 14 System.out.println("learn方法的参数: " + class.getName()); 15 } 16 //判断learn方法是否为private 17 System.out.println(learnMethod.getName() + " is private " 18 + Modifier.isPrivate(learnMethod.getModifiers())); 19 learnMethod.invoke(student, "Java Reflection"); 20 } catch (Exception e) { 21 e.printStackTrace(); 22 } 23 }
第12行,通过调用Method对象的getParameterTypes方法来获取一个方法的形参的类型列表,这个方法会返回一个Class<T>数组。比如由于learn方法只有一个String类型的参数,所以调用此方法会返回一个只包含String.class一个元素的Class<T>数组。(由于返回的Class对象分别对应了不同类型,所以我们在上面的代码中用了Class<?>。)
第14行,我们调用了Class对象的getName方法,这个方法会返回这个Class对象所封装的类的全名(本例中会返回java.lang.String)。
第19行,通过调用Method对象的invoke方法可以调用相应Method对象所封装的方法。
(2) 获取当前类和父类中定义的公有方法
要获取当前类以及父类中的所有 public 方法可以调用getMethods 函数,而要获取某个指定的public方法,可以调用getMethod方法。请看以下代码:
1 private static void showMethods() { 2 Student student = new Student("mr.simple"); 3 // 获取所有public方法(包括Student本身的和从父类继承来的) 4 Method[] methods = student.getClass().getMethods(); 5 for (Method method : methods) { 6 System.out.println("method name : " + method.getName()); 7 } 8 try { 9 //注意,通过 getMethod只能获取public方法,若尝试获取private方法则会抛出异常 10 Method learnMethod = student.getClass().getMethod("learn", String.class); 11 12 } catch (Exception e) { 13 e.printStackTrace(); 14 } 15 }
5. 通过反射获取类中定义的属性
获取属性与获取方法是类似的,只不过 getMethod 函数换成了 getField,getDeclaredMethod 换成了 getDeclaredField 。
(1) 获取当前类中定义的属性(不包括从父类继承来的属性)
要获取当前类中定义的所有属性(包括private、public、static等各种属性)可以调用 Class对象的getDeclaredFields函数;要想获得指定的属性,可以调用getDeclaredField。如以下代码所示
1 private static void showDeclaredFields() { 2 Student student = new Student("Bill", 18); 3 // 获取当前类中定义的所有属性并显示出来 4 Field[] fields = student.getClass().getDeclaredFields(); 5 for (Field field : publicFields) { 6 System.out.println("declared field name : " + field.getName()); 7 } 8 9 try { 10 // 获取指定的属性 11 Field gradeField = student.getClass().getDeclaredField("grade"); 12 // 获取属性值 13 System.out.println("The grade is : " + gradeField.getInt(student)); 14 // 设置属性值 15 gradeField.set(student, 10); 16 System.out.println("The grade is : " + gradeField.getInt(student)); 17 } catch (Exception e) { 18 e.printStackTrace(); 19 } 20 }
(2)获取当前类和父类中定义的public属性
要获取当前类和父类中定义的所有public 属性可以调用Class对象的getFields 函数,而要获取某个指定的public属性,可以调用getField方法,如以下代码所示:
private static void showFields() { Student student = new Student("Bill", 18); // 获取当前类和父类的所有public属性并显示 Field[] publicFields = student.getClass().getFields(); for (Field field : publicFields) { System.out.println("field name : " + field.getName()); } }
6. 通过反射获取类的父类及类所实现的接口
(1)获取父类
调用Class对象的getSuperClass方法即可,如以下代码所示:
1 Student student = new Student("Bill", 18); 2 Class<?> superClass = student.getClass().getSuperclass(); 3 System.out.println("Student's super class is : " + superClass.getName());
(2) 获取接口
要知道一个类实现了哪些接口,只需调用Class对象的getInterfaces方法,如以下代码所示:
1 private static void showInterfaces() { 2 Student student = new Student("Bill", 19); 3 Class<?>[] interfaces = student.getClass().getInterfaces(); 4 for (Class<?> interface : interfaces) { 5 System.out.println("Implements interface: " + interface.getName()); 6 } 7 }
由于Student类未显式实现任何接口,所以以上代码什么也不会输出。