Java 反射 Method的invoke回調調用任意方法

@author ixenos

 關鍵子：Method、Field、invoke方法指針/函數指針、回調函數

 

 

 

invoke回調流程示例

---

0.由Class對象動態構造對應類型對象

1.Class對象的getMethod方法，由方法名和形參構造Method對象

2.Method對象的invoke方法來委托動態構造的對應類型對象，使其執行對應形參的add方法，這是回調函數（方法）的功能

“回調函數就是一個通過函數指針調用的函數。如果你把函數的指針（地址）作為參數傳遞給另一個函數，當這個指針被用來調用其所指向的函數時，我們就說這是回調函數。回調函數不是由該函數的實現方直接調用，而是在特定的事件或條件發生時由另外的一方調用的，用於對該事件或條件進行響應。”

//動態構造InvokeTest類的實例
Class<?> classType = InvokeTest.class;
Object invokeTest = classType.newInstance();

//動態構造InvokeTest類的add(int num1, int num2)方法，標記為addMethod的Method對象
Method addMethod = classType.getMethod("add", new Class[]{int.class, int.class});

//動態構造的Method對象invoke委托動態構造的InvokeTest對象，執行對應形參的add方法
Object result = addMethod.invoke(invokeTest, new Object[]{1, 2});

//測試輸出
System.out.println((Integer)result);

public Method getMethod(String name,
                        Class<?>... parameterTypes)
                 throws NoSuchMethodException,
                        SecurityException返回一個 Method 對象，它反映此 Class 對象所表示的類或接口的指定公共成員方法。name 參數是一個 String，用於指定所需方法的簡稱。parameterTypes 參數是按聲明順序標識該方法形參類型的 Class 對象的一個數組。如果 parameterTypes 為 null，則按空數組處理。 
如果 name 是 "<init>;" 或 "<clinit>"，則將引發 NoSuchMethodException。否則，要反映的方法由下面的算法確定（設 C 為此對象所表示的類）： 

在 C 中搜索任一匹配的方法。如果找不到匹配的方法，則將在 C 的超類上遞歸調用第 1 步算法。 
如果在第 1 步中沒有找到任何方法，則在 C 的超接口中搜索匹配的方法。如果找到了這樣的方法，則反映該方法。 
在 C 類中查找匹配的方法：如果 C 正好聲明了一個具有指定名稱的公共方法並且恰恰有相同的形參類型，則它就是反映的方法。如果在 C 中找到了多個這樣的方法，並且其中有一個方法的返回類型比其他方法的返回類型都特殊，則反映該方法；否則將從中任選一個方法。 
注意，類中可以有多個匹配方法，因為盡管 Java 語言禁止類聲明帶有相同簽名但不同返回類型的多個方法，但 Java 虛擬機並不禁止。這增加了虛擬機的靈活性，可以用來實現各種語言特性。例如，可以使用橋方法 (brige method)實現協變返回；橋方法以及將被重寫的方法將具有相同的簽名，不同的返回類型。 

請參閱Java 語言規范 第 8.2 和 8.4 節。 


參數：
name - 方法名
parameterTypes - 參數列表 
返回：
與指定的 name 和 parameterTypes 匹配的 Method 對象 
拋出： 
NoSuchMethodException - 如果找不到匹配的方法，或者方法名為 "<init>" 或 "<clinit>" 
NullPointerException - 如果 name 為 null 
SecurityException - 如果存在安全管理器 s，並滿足下列任一條件： 
調用 s.checkMemberAccess(this, Member.PUBLIC) 拒絕訪問方法 
調用者的類加載器不同於也不是當前類的類加載器的一個祖先，並且對 s.checkPackageAccess() 的調用拒絕訪問該類的包 

public Object invoke(Object obj,
                     Object... args)
              throws IllegalAccessException,
                     IllegalArgumentException,
                     InvocationTargetException對帶有指定參數的指定對象調用由此 Method 對象表示的底層方法。個別參數被自動解包，以便與基本形參相匹配，基本參數和引用參數都隨需服從方法調用轉換。 
如果底層方法是靜態的，那么可以忽略指定的 obj 參數。該參數可以為 null。 

如果底層方法所需的形參數為 0，則所提供的 args 數組長度可以為 0 或 null。 

如果底層方法是實例方法，則使用動態方法查找來調用它，這一點記錄在 Java Language Specification, Second Edition 的第 15.12.4.4 節中；在發生基於目標對象的運行時類型的重寫時更應該這樣做。 

如果底層方法是靜態的，並且尚未初始化聲明此方法的類，則會將其初始化。 

如果方法正常完成，則將該方法返回的值返回給調用者；如果該值為基本類型，則首先適當地將其包裝在對象中。但是，如果該值的類型為一組基本類型，則數組元素不 被包裝在對象中；換句話說，將返回基本類型的數組。如果底層方法返回類型為 void，則該調用返回 null。 


參數：
obj - 從中調用底層方法的對象
args - 用於方法調用的參數 
返回：
使用參數 args 在 obj 上指派該對象所表示方法的結果 
拋出： 
IllegalAccessException - 如果此 Method 對象強制執行 Java 語言訪問控制，並且底層方法是不可訪問的。 
IllegalArgumentException - 如果該方法是實例方法，且指定對象參數不是聲明底層方法的類或接口（或其中的子類或實現程序）的實例；如果實參和形參的數量不相同；如果基本參數的解包轉換失敗；如果在解包后，無法通過方法調用轉換將參數值轉換為相應的形參類型。 
InvocationTargetException - 如果底層方法拋出異常。 
NullPointerException - 如果指定對象為 null，且該方法是一個實例方法。 
ExceptionInInitializerError - 如果由此方法引起的初始化失敗。

 

 

用反射實現獲得運行時對象的拷貝的方法（Field類）

---

import java.lang.class;
import java.lang.reflect;

 public class ReflectTester
{
　　public Object copy(Object object) throws Exception
　　{
　　　　Class<?> classType = object.getClass();
　　　　Object objectCopy = classType.getConstructor(new Class[]{}).newInstance(new Object[]{});
　　　　//獲得對象的所有成員變量
　　　　Field[] fields = classType.getDeclaredFields();
　　　　for(Field field : fields)
　　　　{
　　　　　　String name = field.getName();
　　　　　　//將屬性的首字母轉換為大寫
　　　　　　String firstLetter = name.substring(0,1).toUpperCase(); 
　　　　　　//substring(1)表示從index=1開始到最后的子字符串
　　　　　　String getMethodName = "get" + firstLetter + name.substring(1);
　　　　　　String setMethodName = "set" + firstLetter + name.substring(1);
　　　　　　Method getMethod = classType.getMethod(getMethodName, new Class[] {});
　　　　　　Method setMethod = classType.setMethod(getMethodName, new Class[] { field.getType() });
　　　　　　Object value = getMethod.invoke(object, new Object[] {});
　　　　　　setMethod.invoke(objectCopy, new Object[] { value });
　　　　}
　　　　return objectCopy;
　　}
　　public static void main(String[] args)
　　{
　　　　Customer customer = new Customer("Tom", 20);
　　　　customer.setId(1L);

　　　　ReflectTester test = new ReflectTester();
　　　　Customer customer2 = (Customer) test.copy(customer);
　　　　System.out.println(customer2.getId() + "," + customer2.getName() + "," + customer2.getAge());
　　}
}

Class Customer
{
　　private float ID;
　　private String name;
　　private int age;
　　public Customer()
　　{
　　　　this.ID = 1L;
　　　　this.name = A;
　　　　this.age = 1;
　　}
　　public Customer(String name, int age)
　　{
　　　　this();
　　　　this.name = name;
　　　　this.age = age;
　　}
　　public void setID(float ID)
　　{
　　　　this.ID = ID;
　　}
}

0.利用Class對象得到對應類型對象 

1.利用Class對象的getDeclaredFields方法，得Field[]數組

2.遍歷Field[]數組，構造每一個屬性名的字符串，使首字母大寫，再連接get字符串，組成setter和getter的命名

3.遍歷的同時，getMethod，參數便是要構建的方法名和形參類型，得到各屬性的setter和getter方法的Method對象

4.同時，得到方法后，調用各Method對象的invoke委托對應類型對象執行方法（有實參傳入，或返回值）

 

 

Method的invoke方法能調用任意方法

---

Method類中的invoke方法，允許調用包裝在Method對象中的方法

Object invoke(Object obj, Object... args) //對應隱式參數和顯式參數

public Object invoke(Object obj,
                     Object... args)
              throws IllegalAccessException,
                     IllegalArgumentException,
                     InvocationTargetException對帶有指定參數的指定對象調用由此 Method 對象表示的底層方法。個別參數被自動解包，以便與基本形參相匹配，基本參數和引用參數都隨需服從方法調用轉換。 
如果底層方法是靜態的，那么可以忽略指定的 obj 參數。該參數可以為 null。 

如果底層方法所需的形參數為 0，則所提供的 args 數組長度可以為 0 或 null。 

如果底層方法是實例方法，則使用動態方法查找來調用它，這一點記錄在 Java Language Specification, Second Edition 的第 15.12.4.4 節中；在發生基於目標對象的運行時類型的重寫時更應該這樣做。 

如果底層方法是靜態的，並且尚未初始化聲明此方法的類，則會將其初始化。 

如果方法正常完成，則將該方法返回的值返回給調用者；如果該值為基本類型，則首先適當地將其包裝在對象中。但是，如果該值的類型為一組基本類型，則數組元素不 被包裝在對象中；換句話說，將返回基本類型的數組。如果底層方法返回類型為 void，則該調用返回 null。 


參數：
obj - 從中調用底層方法的對象
args - 用於方法調用的參數 
返回：
使用參數 args 在 obj 上指派該對象所表示方法的結果 
拋出： 
IllegalAccessException - 如果此 Method 對象強制執行 Java 語言訪問控制，並且底層方法是不可訪問的。 
IllegalArgumentException - 如果該方法是實例方法，且指定對象參數不是聲明底層方法的類或接口（或其中的子類或實現程序）的實例；如果實參和形參的數量不相同；如果基本參數的解包轉換失敗；如果在解包后，無法通過方法調用轉換將參數值轉換為相應的形參類型。 
InvocationTargetException - 如果底層方法拋出異常。 
NullPointerException - 如果指定對象為 null，且該方法是一個實例方法。 
ExceptionInInitializerError - 如果由此方法引起的初始化失敗。

 

0.如果底層方法是靜態的，那么可以忽略指定的 obj 參數。該參數可以為 null;如果底層方法所需的形參數為 0，則所提供的 args 數組長度可以為 0 或 null

1.第一個參數是隱式參數(比如this，傳進你要委托的對象)；其余的可變參數提供了顯式參數(Java SE 5.0以前沒有可變參數，必須傳遞對象數組或者null)

對於靜態方法（屬於類），第一個參數設置為null，作為隱式參數來傳遞

2.如果有返回類型，invoke方法將返回一個名義上的Object類型，實際類型由方法內部決定，所以還要進行強制類型轉換；

而因此如果返回類型是基本類型，為了統一返回類型，將會返回其包裝器類型：

double s = (Double)m2.invoke(harry) //省略顯式參數，因為沒有形參，不需要實參傳入

 "個別參數被自動解包，以便與基本形參相匹配，基本參數和引用參數都隨需服從方法調用轉換。"  --JDK API 1.6 中文版

 

 

invoke的缺點

---

1.invoke的參數和返回值必需時Object類型的，這意味着必須進行多次的類型轉換（特別是基本數據類型），而這將導致編譯器錯過檢查代碼的機會，有類型安全的風險，只有到了測試階段才會發現這些錯誤，此時找到並改正他們將會更加困難

2.使用反射獲得方法指針的代碼要比僅僅直接調用方法明顯慢一些

3.因此僅在必要時才使用Method對象，而最好使用接口和內部類，不建議Java開發者使用Method對象的回調功能，使用接口進行回調不僅會使代碼的運行速度更快，還更易於維護