Java核心技術點之反射

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 }

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);
    }
 } 

 

（1） 通過類名獲取Class對象：

    若在編譯期知道一個類的名字，我們可以這樣獲取它的Class對象：

Class<People> peopleClass = People.class;

 

    還有一種根據類的完整路徑名獲取Class對象的方法如下所示：

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對象：

People people = new People("Bill"， 18);
Class<People> peopleClass = people.getClass();

3. 通過反射獲取類的構造器

      一旦我們獲得了People的Class 對象，我們便可以通過這個Class 對象獲取到People類的原始定義信息。 首先，我們來獲取People類的構造器對象，有了這個構造器對象，我們便能夠構造出一個People對象出來。比如，我們可以在Student.java中添加以下代碼：

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

  在第4行，我們調用getConstructor方法來獲取一個People類的構造器對象，由於我們想要獲取的構造器的形參類型為String和int，所以我們傳入String.class和int.class。有了構造器對象，我們便可以調用newInstance方法來創建一個people對象，如上面代碼的第6行所示。

   注意，當通過反射獲取到類的 Constructor、Method、Field對象后，在調用這些對象的方法之前，先將此對象的 accessible 標志設置為 true，以取消 Java 語言訪問檢查，可以提升反射速度。如以下代碼所示：

Constructor<People> constructor = peopleClass.getConstructor(String.class， int.class);
// 設置 constructor 的 Accessible屬性為ture以取消Java的訪問檢查
constructor.setAccessible(true);

 

4. 通過反射獲取類中定義的方法

（1） 獲取當前類中定義的方法（不包括從父類繼承來的）

要獲取當前類中定義的所有方法可以通過 Class 中的 getDeclaredMethods 函數，它會獲取到當前類中定義的所有方法（包括private、public、static等各種方法），它會返回一個Method對象數組，其中的每個Method對象即表示了一個類中定義的方法。要想獲得指定的方法，可以調用getDeclaredMethod(String name, Class...<T> parameterTypes)。如以下代碼所示 :

private static void showDeclaredMethods() {
        Student student = new Student("Bill", 18);
        Method[] methods = student.getClass().getDeclaredMethods();
        for (Method method : methods) {
            System.out.println("declared method name : " + method.getName());
        }

        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()));
            learnMethod.invoke(student, "Java Reflection");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

第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方法。請看以下代碼：

private static void showMethods() {
        Student student = new Student("mr.simple");
        // 獲取所有public方法(包括Student本身的和從父類繼承來的）
        Method[] methods = student.getClass().getMethods();
        for (Method method : methods) {
            System.out.println("method name : " + method.getName());
        }
        try {
            //注意，通過 getMethod只能獲取public方法，若嘗試獲取private方法則會拋出異常
            Method learnMethod = student.getClass().getMethod("learn", String.class);
          
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

 

5. 通過反射獲取類中定義的屬性

獲取屬性與獲取方法是類似的，只不過 getMethod 函數換成了 getField，getDeclaredMethod 換成了 getDeclaredField 。

（1） 獲取當前類中定義的屬性（不包括從父類繼承來的屬性）

要獲取當前類中定義的所有屬性（包括private、public、static等各種屬性）可以調用 Class對象的getDeclaredFields函數；要想獲得指定的屬性，可以調用getDeclaredField。如以下代碼所示

 private static void showDeclaredFields() {
        Student student = new Student("Bill", 18);
        // 獲取當前類中定義的所有屬性並顯示出來
        Field[] fields = student.getClass().getDeclaredFields();
        for (Field field : publicFields) {
            System.out.println("declared field name : " + field.getName());
        }

        try {
            // 獲取指定的屬性
            Field gradeField = student.getClass().getDeclaredField("grade");
            // 獲取屬性值
            System.out.println("The grade is : " + gradeField.getInt(student));
            // 設置屬性值
            gradeField.set(student, 10);
            System.out.println("The grade is : " + gradeField.getInt(student));
        } catch (Exception e) {
            e.printStackTrace();
        }
}

 

 

（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方法即可，如以下代碼所示：

Student student = new Student("Bill", 18);
Class<?> superClass = student.getClass().getSuperclass();
System.out.println("Student's super class is : " + superClass.getName());

 

(2) 獲取接口

要知道一個類實現了哪些接口，只需調用Class對象的getInterfaces方法，如以下代碼所示：

private static void showInterfaces() {
        Student student = new Student("Bill", 19);
        Class<?>[] interfaces = student.getClass().getInterfaces();
        for (Class<?> interface : interfaces) {
                System.out.println("Implements interface: " + interface.getName());
        }
}

由於Student類未顯式實現任何接口，所以以上代碼什么也不會輸出。

 

7. 參考資料

公共技術點之Java反射