CGLib InvocationHandler接口

在 CGLib 中，InvocationHandler 接口用来替换 JDK 的 java.lang.reflect.InvocationHandler（注意：在JDK 1.2下不可用）。此回调类型主要由 Proxy 类使用，但也可以与增强器一起使用。

同样，InvocationHandler 接口也继承了 CGLib 的 Callback 接口，因此可以用于 Enhancer 的 setCallback() 方法。

InvocationHandler 是 Proxy 实例的调用处理程序实现的接口，每个代理实例都具有一个关联的调用处理程序。对代理实例调用方法时，将对方法调用进行编码并将其指派到它的调用处理程序的 invoke 方法。

InvocationHandler 接口定义了唯一一个 invoke() 方法，定义如下：

java.lang.Object invoke(java.lang.Object proxy, java.lang.reflect.Method method, java.lang.Object[] args) throws java.lang.Throwable

在代理实例上处理方法调用并返回结果。在与方法关联的代理实例上调用方法时，将在调用处理程序上调用此方法。

参数说明：

• proxy - 在其上调用方法的代理实例

• method - 对应于在代理实例上调用的接口方法的 Method 实例。Method 对象的声明类将是在其中声明方法的接口，该接口可以是代理类赖以继承方法的代理接口的超接口。

• args - 包含传入代理实例上方法调用的参数值的对象数组，如果接口方法不使用参数，则为 null。基本类型的参数被包装在适当基本包装器类（如 java.lang.Integer 或 java.lang.Boolean）的实例中。

返回值说明：

从代理实例的方法调用返回的值。如果接口方法的声明返回类型是基本类型，则此方法返回的值一定是相应基本包装对象类的实例；否则，它一定是可分配到声明返回类型的类型。如果此方法返回的值为 null 并且接口方法的返回类型是基本类型，则代理实例上的方法调用将抛出 NullPointerException。否则，如果此方法返回的值与上述接口方法的声明返回类型不兼容，则代理实例上的方法调用将抛出 ClassCastException。

抛出异常说明：

Throwable - 从代理实例上的方法调用抛出的异常。该异常的类型必须可以分配到在接口方法的 throws 子句中声明的任一异常类型或未经检查的异常类型 java.lang.RuntimeException 或 java.lang.Error。如果此方法抛出经过检查的异常，该异常不可分配到在接口方法的 throws 子句中声明的任一异常类型，代理实例的方法调用将抛出包含此方法曾抛出的异常的 UndeclaredThrowableException。

公共广告位-后端

示例代码

（1）创建被代理的类，代码如下：

/**
 * 被代理的类
 * @author hxstrive.com 2021/12/29
 */
public class HelloWorld {

    public String test(String msg) {
        return msg;
    }

}

（2）创建客户端代码，通过 Enhancer 类的 setCallback() 方法设置 InvocationHandler 类型回调方法。然后在 InvocationHandler 回调的 invoke() 方法中调用目标方法，返回结果。代码如下：

import net.sf.cglib.proxy.Enhancer;
import net.sf.cglib.proxy.InvocationHandler;
import java.lang.reflect.Method;

/**
 * 验证 setCallback() 设置 InvocationHandler 接口
 * @author hxstrive.com 2021/12/31
 */
public class CglibDemo {

    class MyInvocationHandler implements InvocationHandler {
        Object instance;

        private MyInvocationHandler(Object instance) {
            this.instance = instance;
        }

        @Override
        public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
            System.out.println("invoke() start");
            System.out.println("    method: " + method.getName());
            if (args != null) {
                for (int i = 0; i < args.length; i++) {
                    System.out.println("    arg: " + args[i]);
                }
            }
            Object r = method.invoke(instance, args);
            System.out.println("    return: " + r);
            System.out.println("invoke() end");
            return r;
        }
    }

    public CglibDemo() {
        Enhancer enhancer = new Enhancer();
        enhancer.setSuperclass(HelloWorld.class);
        enhancer.setCallback(new MyInvocationHandler(new HelloWorld()));

        HelloWorld sample = (HelloWorld) enhancer.create();
        String result = sample.test("hello world");
        System.out.println("result = " + result);
    }

    public static void main(String[] args) {
        new CglibDemo();
    }

}

运行上面代码，输出结果如下：

invoke() start
    method: test
    arg: hello world
    return: hello world
invoke() end
result = hello world