Java Proxy和CGLIB动态代理原理

167 阅读6分钟

文章来源:www.cnblogs.com/CarpenterLe…

一、简介

动态代理在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 "HelloImpl: " + str;
	}
}

这是Java种再常见不过的场景,使用接口制定协议,然后用不同的实现来实现具体行为。假设你已经拿到上述类库,如果我们想通过日志记录对sayHello()的调用,使用静态代理可以这样做:

public class StaticProxiedHello implements Hello {
    private Hello hello = new HelloImpl();
    @Override
    public String sayHello(String str) {
        System.out.println("You said: " + str);
        return hello.sayHello(str);
    }
}

上例中静态代理类StaticProxiedHello作为HelloImpl的代理,实现了相同的Hello接口。用Java动态代理可以这样做:

  • 首先实现一个InvocationHandler,方法调用会被转发到该类的invoke()方法。
  • 然后在需要使用Hello的时候,通过JDK动态代理获取Hello的代理对象。
// 1. 首先实现一个InvocationHandler,方法调用会被转发到该类的invoke()方法。
public 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())) {
            System.out.println("You said: " + Arrays.toString(args));
        }
        return method.invoke(hello, args);
    }

    public static void main(String[] args) {
        HelloImpl hello = new HelloImpl();
        // 2. 然后在需要使用Hello的时候,通过JDK动态代理获取Hello的代理对象。
        Hello helloPro = (Hello)Proxy.newProxyInstance(
                // 1. 类加载器
                hello.getClass().getClassLoader(),
                // 2. 代理需要实现的接口,可以有多个
                new Class<?>[] {Hello.class},
                // 3. 方法调用的实际处理者
                new LogInvocationHandler(hello));
        System.out.println(helloPro.sayHello("Hello!"));
    }

运行上述代码输出结果:

上述代码的关键是Proxy.newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler handler)方法,该方法会根据指定的参数动态创建代理对象。三个参数的意义如下:

    1. loader,指定代理对象的类加载器;
    1. interfaces,代理对象需要实现的接口,可以同时指定多个接口;
    1. handler,方法调用的实际处理者,代理对象的方法调用都会转发到这里(对于从Object中继承的方法,JDK Proxy会把hashCode()、equals()、toString()这三个非接口方法转发给InvocationHandler,其余的Object方法则不会转发。)。

newProxyInstance()会返回一个实现了指定接口的代理对象,对该对象的所有方法调用都会转发给InvocationHandler.invoke()方法。动态代理神奇的地方就是:

    1. 代理对象是在程序运行时产生的,而不是编译期;
    1. 对代理对象的所有接口方法调用都会转发到InvocationHandler.invoke()方法,在invoke()方法里我们可以加入任何逻辑,比如修改方法参数,加入日志功能、安全检查功能等;之后我们通过某种方式执行真正的方法体,示例中通过反射调用了Hello对象的相应方法,还可以通过RPC调用远程方法。

如果对JDK代理后的对象类型进行深挖,可以看到如下信息:

代理对象的类型是jdkproxy.Proxy0,这是个动态生成的类型,类名是形如ProxyN的形式;父类是java.lang.reflect.Proxy,所有的JDK动态代理都会继承这个类;同时实现了Hello接口,也就是我们接口列表中指定的那些接口。

Java动态代理为我们提供了非常灵活的代理机制,但Java动态代理是基于接口的,如果对象没有实现接口我们该如何代理呢?CGLIB登场。

三、CGLIB动态代理

CGLIB(Code Generation Library)是一个基于ASM的字节码生成库,它允许我们在运行时对字节码进行修改和动态生成。CGLIB通过继承方式实现代理。假设我们有一个没有实现任何接口的类HelloConcrete:

public class HelloConcrete {
    public String sayHello(String str) {
        return "HelloConcrete: " + str;
    }
}

因为没有实现接口该类无法使用JDK代理,通过CGLIB代理实现如下:

    1. 首先实现一个MethodInterceptor,方法调用会被转发到该类的intercept()方法。
    1. 然后在需要使用HelloConcrete的时候,通过CGLIB动态代理获取代理对象。
import org.springframework.cglib.proxy.Enhancer;
import org.springframework.cglib.proxy.MethodInterceptor;
import org.springframework.cglib.proxy.MethodProxy;

import java.lang.reflect.Method;
import java.util.Arrays;

// CGLIB动态代理
// 1. 首先实现一个MethodInterceptor,方法调用会被转发到该类的intercept()方法。
public class MyMethodInterceptor implements MethodInterceptor {
    @Override
    public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {

        System.out.println("You said: " + Arrays.toString(objects));
        return methodProxy.invokeSuper(o, objects);
    }


    public static void main(String[] args) {
        // 2. 然后在需要使用HelloConcrete的时候,通过CGLIB动态代理获取代理对象。
        Enhancer enhancer = new Enhancer();
        enhancer.setSuperclass(HelloConcrete.class);
        enhancer.setCallback(new MyMethodInterceptor());

        HelloConcrete helloPro = (HelloConcrete)enhancer.create();
        System.out.println(helloPro.sayHello("hello!"));
    }
}

运行上述代码输出结果:

上述代码中,我们通过CGLIB的Enhancer来指定要代理的目标对象、实际处理代理逻辑的对象,最终通过调用create()方法得到代理对象,对这个对象所有非final方法的调用都会转发给MethodInterceptor.intercept()方法,在intercept()方法里我们可以加入任何逻辑,比如修改方法参数,加入日志功能、安全检查功能等;通过调用MethodProxy.invokeSuper()方法,我们将调用转发给原始对象,具体到本例,就是HelloConcrete的具体方法。CGLIG中MethodInterceptor的作用跟JDK代理中的InvocationHandler很类似,都是方法调用的中转站。

如果对CGLIB代理之后的对象类型进行深挖,可以看到如下信息:

我们看到使用CGLIB代理之后的对象类型是HelloConcrete?EnhancerByCGLIB?13f3c69d,这是CGLIB动态生成的类型;父类是HelloConcrete,印证了CGLIB是通过继承实现代理;同时实现了net.sf.cglib.proxy.Factory接口,这个接口是CGLIB自己加入的,包含一些工具方法。

注意,既然是继承就不得不考虑final的问题。我们知道final类型不能有子类,所以CGLIB不能代理final类型. 同样的,final方法是不能重载的,所以也不能通过CGLIB代理,遇到这种情况不会抛异常,而是会跳过final方法只代理其他方法。

四、结语:

本文介绍了Java两种常见动态代理机制的用法和原理,JDK原生动态代理是Java原生支持的,不需要任何外部依赖,但是它只能基于接口进行代理;CGLIB通过继承的方式进行代理,无论目标对象有没有实现接口都可以代理,但是无法处理final的情况。