十分钟理解 Java 之反射

2,040 阅读6分钟

概述

Java 反射是可以让我们在运行时获取类的方法、属性、父类、接口等类的内部信息的机制。也就是说,反射本质上是一个“反着来”的过程。我们通过new创建一个类的实例时,实际上是由Java虚拟机根据这个类的Class对象在运行时构建出来的,而反射是通过一个类的Class对象来获取它的定义信息,从而我们可以访问到它的属性、方法,知道这个类的父类、实现了哪些接口等信息。

Class类

我们知道使用javac能够将.java文件编译为.class文件,这个.class文件包含了我们对类的原始定义信息(父类、接口、构造器、属性、方法等)。.class文件在运行时会被ClassLoader加载到Java虚拟机(JVM)中,当一个.class文件被加载后,JVM会为之生成一个Class对象,我们在程序中通过new实例化的对象实际上是在运行时根据相应的Class对象构造出来的。确切的说,这个Class对象实际上是java.lang.Class泛型类的一个实例,比如Class对象即为一个封装了MyClass类的定义信息的Class实例。由于java.lang.Class类不存在公有构造器,因此我们不能直接实例化这个类,我们可以通过以下方法获取一个Class对象。
在下面的讲解中,我们将以People类和Student类为例:

public class People {
      private String name;
      private int age;
      public People(String name, int age) {
          this.name = name;
              this.age = age;
      }
      public int getAge() {
          return age;
      } 
      public String getName() {
          return name;
      } 
      public void setAge(int age) {
          this.age = age;
      } 
      public void setName(String name) {
          this.name = name;
      }
      public void speak() {
        System.out.println(getName() + " " + getAge());
     }
}

public class Student extends People {
  private int grade;
  public Student(String name, int age) {    
    super(name, age);  
  }
  public Student(String name, int age, int grade) {
    super(name, age);            
    this.grade = grade;  
  }      
  public int getGrade() {   
    return grade;  
  }     
  public void setGrade(int grade) {   
    this.grade = grade;  
  }    
  private void learn(String course) {    
    System.out.println(name + " learn " + course);  
  }
}
通过类名获取Class对象

若在编译期知道一个类的名字,我们可以这样获取它的Class对象:

Class peopleClass = People.class;

还有一种根据类的完整路径名获取Class对象的方法如下所示:

//假设People类在com.test包中
Class peopleClass = Class.forName("com.test.People");

注意,Class.forName()方法的参数必须是一个类的全路径名。实际上,只要我们“import com.test.People",就可以直接通过”People.class"获取他的Class对象,而不用写出全路径这么麻烦。 (若在调用 Class.forName()方法时,没有在classpath找到对应的类,会抛出 ClassNotFoundException。)

通过对象本身获取其Class对象
People people = new People("Bill", 18);
Class peopleClass = people.getClass();

通过反射获取类的构造器

一旦我们获得了People的Class 对象,我们便可以通过这个Class 对象获取到People类的原始定义信息。 首先,我们来获取People类的构造器对象,有了这个构造器对象,我们便能够构造出一个People对象出来。比如,我们可以在Student.java中添加以下代码:

public static void main(String[] args) {   
  Class pClass = People.class;   
  try {   
    Constructor constructor = pClass.getConstructor(String.class, int.class);     
    People people = constructor.newInstance("Bill", 18);                 
    obj.speak();  
  } catch (Exception e) {  
  } 
}

在上面,我们调用getConstructor方法来获取一个People类的构造器对象,由于我们想要获取的构造器的形参类型为String和int,所以我们传入String.class和int.class。有了构造器对象,我们便可以调用newInstance方法来创建一个people对象。
注意,当通过反射获取到类的 Constructor、Method、Field对象后,在调用这些对象的方法之前,先将此对象的 accessible 标志设置为 true,以取消 Java 语言访问检查,可以提升反射速度。如以下代码所示:

Constructor constructor = peopleClass.getConstructor(String.class, 
    int.class);
// 设置 constructor 的 Accessible属性为ture以取消Java的访问检查
constructor.setAccessible(true);

通过反射获取类中声明的方法

获取当前类中声明的方法(不包括从父类继承来的)

要获取当前类中声明的所有方法可以通过 Class 中的 getDeclaredMethods 函数,它会获取到当前类中声明的所有方法(包括private、public、static等各种方法),它会返回一个Method对象数组,其中的每个Method对象即表示了一个类中声明的方法。要想获得指定的方法,可以调用getDeclaredMethod(String name, Class... parameterTypes)。如以下代码所示 :

private static void showDeclaredMethods() {  
  Student student = new Student("Bill", 18);   
  //获取Student类声明的所有方法 
  Method[] methods = student.getClass().getDeclaredMethods();       
   try {      
      //获取learnMethod对象(封装了learn方法) 
      Method learnMethod = student.getClass().getDeclaredMethod("learn", 
          String.class);                
      //获取learn方法的参数列表并打印出来 
      Class[] paramClasses = learnMethod.getParameterTypes() ;        
      for (Class class : paramClasses) {      
        System.out.println("learn方法的参数: " + class.getName());    
      }                
      //判断learn方法是否为private 
      System.out.println(learnMethod.getName() + " is private " 
          + Modifier.isPrivate(learnMethod.getModifiers()));   
      //调用learn方法    
      learnMethod.invoke(student, "Java Reflection");  
    } catch (Exception e) {  
  }
}
获取当前类和父类中声明的公有方法

要获取当前类以及父类中声明的所有 public 方法可以调用getMethods 函数,而要获取某个指定的public方法,可以调用getMethod方法。请看以下代码:

private static void showMethods() { 
  Student student = new Student("mr.simple");    
  // 获取所有public方法(包括Student本身的和从父类继承来的)  
  Method[] methods = student.getClass().getMethods();   
  try {    
    //注意,通过 getMethod只能获取public方法,若尝试获取private方法则会抛出异常 
    Method learnMethod = student.getClass().getMethod("learn", String.class);
  } catch (Exception e) {  
  }
}

通过反射获取类中定义的属性

获取属性与获取方法是类似的,只不过把对getMethods() / getDeclaredMethods()方法的调用换成了对getFields() / getDeclaredFields()方法的调用。

获取当前类中定义的属性(不包括从父类继承来的属性)

要获取当前类中定义的所有属性(包括private、public、static等各种属性)可以调用 Class对象的getDeclaredFields函数;要想获得指定的属性,可以调用getDeclaredField。如以下代码所示:

private static void showDeclaredFields() {   
  Student student = new Student("Bill", 18);    
  // 获取当前类中定义的所有属性  
  Field[] fields = student.getClass().getDeclaredFields();   
  try {    
    // 获取指定的属性 
    Field gradeField = student.getClass().getDeclaredField("grade"); 
    // 获取属性值 
    System.out.println("The grade is : " + gradeField.getInt(student));    
    // 设置属性值    
    gradeField.set(student, 10); 
   } catch (Exception e) { 
  } 
}
获取当前类和父类中定义的public属性

要获取当前类和父类中定义的所有public 属性可以调用Class对象的getFields 函数,而要获取某个指定的public属性,可以调用getField方法,如以下代码所示:

private static void showFields() {  
  Student student = new Student("Bill", 18);            
  // 获取当前类和父类的所有public属性 
  Field[] publicFields = student.getClass().getFields();        
}

通过反射获取类的父类及类所实现的接口

获取父类

调用Class对象的getSuperClass方法即可,如以下代码所示:

Student student = new Student("Bill", 18);
Class superClass = student.getClass().getSuperclass();
获取所实现的接口

要知道一个类实现了哪些接口,只需调用Class对象的getInterfaces方法,如以下代码所示:

private static void showInterfaces() { 
  Student student = new Student("Bill", 19); 
  Class[] interfaces = student.getClass().getInterfaces();
}

长按或扫描二维码关注我们,让您利用每天等地铁的时间就能学会怎样写出优质app。