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

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() 的调用拒绝访问该类的包 

API-Class-getMethod

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 - 如果由此方法引起的初始化失败。

API-Method-invoke

用反射实现获得运行时对象的拷贝的方法（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 - 如果由此方法引起的初始化失败。

API-Method-invoke

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对象的回调功能，使用接口进行回调不仅会使代码的运行速度更快，还更易于维护