动态代理在Java中有着广泛的应用,比如Spring AOP,Hibernate数据查询、测试框架的后端mock、RPC,Java注解对象获取等。静态代理的代理关系在编译时就确定了,而动态代理的代理关系是在编译期确定的。静态代理实现简单,适合于代理类较少且确定的情况,而动态代理则给我们提供了更大的灵活性。今天我们来探讨Java中两种常见的动态代理方式:JDK原生动态代理和CGLIB动态代理。
JDK原生动态代理
先从直观的示例说起,假设我们有一个接口Hello
和一个简单实现HelloImp
:
// 接口 interface Hello{ String sayHello(String str); } // 实现 class HelloImp implements Hello{ @Override public String sayHello(String str) { return "HelloImp: " + str; } }
这是Java种再常见不过的场景,使用接口制定协议,然后用不同的实现来实现具体行为。假设你已经拿到上述类库,如果我们想通过日志记录对sayHello()
的调用,使用静态代理可以这样做:
// 静态代理方式 class StaticProxiedHello implements Hello{ ... private Hello hello = new HelloImp(); @Override public String sayHello(String str) { logger.info("You said: " + str); return hello.sayHello(str); } }
上例中静态代理类StaticProxiedHello
作为HelloImp
的代理,实现了相同的Hello
接口。用Java动态代理可以这样做:
- 首先实现一个InvocationHandler,方法调用会被转发到该类的invoke()方法。
- 然后在需要使用Hello的时候,通过JDK动态代理获取Hello的代理对象。
// Java Proxy // 1. 首先实现一个InvocationHandler,方法调用会被转发到该类的invoke()方法。 class LogInvocationHandler implements InvocationHandler{ ... private Hello hello; public LogInvocationHandler(Hello hello) { this.hello = hello; } @Override public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { if("sayHello".equals(method.getName())) { logger.info("You said: " + Arrays.toString(args)); } return method.invoke(hello, args); } } // 2. 然后在需要使用Hello的时候,通过JDK动态代理获取Hello的代理对象。 Hello hello = (Hello)Proxy.newProxyInstance( getClass().getClassLoader(), // 1. 类加载器 new Class<?>[] {Hello.class}, // 2. 代理需要实现的接口,可以有多个 new LogInvocationHandler(new HelloImp()));// 3. 方法调用的实际处理者 System.out.println(hello.sayHello("I love you!"));
运行上述代码输出结果:
日志信息: You said: [I love you!] HelloImp: I love you!
上述代码的关键是Proxy.newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler handler)
方法,该方法会根据指定的参数动态创建代理对象。三个参数的意义如下:
loader
,指定代理对象的类加载器;interfaces
,代理对象需要实现的接口,可以同时指定多个接口;handler
,方法调用的实际处理者,代理对象的方法调用都会转发到这里(*注意1)。
newProxyInstance()
会返回一个实现了指定接口的代理对象,对该对象的所有方法调用都会转发给InvocationHandler.invoke()
方法。理解上述代码需要对Java反射机制有一定了解。动态代理神奇的地方就是:
- 代理对象是在程序运行时产生的,而不是编译期;
- 对代理对象的所有接口方法调用都会转发到
InvocationHandler.invoke()
方法,在invoke()
方法里我们可以加入任何逻辑,比如修改方法参数,加入日志功能、安全检查功能等;之后我们通过某种方式执行真正的方法体,示例中通过反射调用了Hello对象的相应方法,还可以通过RPC调用远程方法。
注意1:对于从Object中继承的方法,JDK Proxy会把
hashCode()
、equals()
、toString()
这三个非接口方法转发给InvocationHandler
,其余的Object方法则不会转发。详见JDK Proxy官方文档。
如果对JDK代理后的对象类型进行深挖,可以看到如下信息:
# Hello代理对象的类型信息 class=class jdkproxy.$Proxy0 superClass=class java.lang.reflect.Proxy interfaces: interface jdkproxy.Hello invocationHandler=jdkproxy.LogInvocationHandler@a09ee92
代理对象的类型是jdkproxy.$Proxy0
,这是个动态生成的类型,类名是形如$ProxyN的形式;父类是java.lang.reflect.Proxy
,所有的JDK动态代理都会继承这个类;同时实现了Hello
接口,也就是我们接口列表中指定的那些接口。
如果你还对jdkproxy.$Proxy0
具体实现感兴趣,它大致长这个样子:
// JDK代理类具体实现 public final class $Proxy0 extends Proxy implements Hello { ... public $Proxy0(InvocationHandler invocationhandler) { super(invocationhandler); } ... @Override public final String sayHello(String str){ ... return super.h.invoke(this, m3, new Object[] {str});