Java代理：静态代理、JDK动态代理和CGLIB动态代理

代理模式（英语：Proxy Pattern）是程序设计中的一种设计模式。所谓的代理者是指一个类别可以作为其它东西的接口。代理者可以作任何东西的接口：网络连接、存储器中的大对象、文件或其它昂贵或无法复制的资源。

代理模式分为静态代理、动态代理（JDK、CGLIB）。

静态代理

静态代理是由程序员创建或工具生成代理类的源码，再编译代理类。所谓静态也就是在程序运行前就已经存在代理类的字节码文件，代理类和委托类的关系在运行前就确定了。

上面的静态代理UML图的一个例子，代理类和目标类都实现相同的接口。

创建一个Animal接口。

package com.proxy.example;

/**
 *  an animation interface
 */
public interface Animal {
    void call();
    void hobby();
}

创建目标类Cat并实现Animal接口。

package com.proxy.example;

public class Cat implements Animal {
    @Override
    public void call() {
        System.out.println("meow meow meow ~");
    }

    @Override
    public void hobby(){
        System.out.println("eating fish ~");
    }
}

所以我们需要在目标对象Cat调用方法之前指出它已经饿了，该方法是使用静态代理来实现Cat的叫声，然后再进行调用。

package com.proxy.example.staticproxy;

import com.proxy.example.Animal;

/**
 * 静态代理类, 实现了Animal接口
 */
public class StaticProxyAnimal implements Animal {
    private Animal impl;    // 在代理对象中保存目标对象, 使代理类中持有目标对象

    /**
     * 传入目标对象
     *
     * @param impl 目标对象
     */
    public StaticProxyAnimal(Animal impl) {
        this.impl = impl;
    }

    /**
     * 调用代理对象中Cat#call的实现
     */
    @Override
    public void call() {
        System.out.println("Cat is hungry");
        impl.call();
    }

    @Override
    public void hobby() {
        // 接口每添加新方法，旧的在这里实现这个方法，灵活性不够，在大型的项目不易于维护
    }
}

猫的饥饿和喵喵叫的行为是通过调用静态代理来实现的。

package com.proxy.example.staticproxy;

import com.proxy.example.Animal;
import com.proxy.example.Cat;
import org.junit.Test;

public class Main {
    @Test
    public void staticProxy(){
        Animal staticProxy = new StaticProxyAnimal(new Cat());
        staticProxy.call(); // 猫的饥饿和喵喵叫行为是通过调用静态代理来实现的。
    }
}

可以看到，通过保留目标类对象然后调用目标类的方法来实现静态代理。

但在某些情况下它还有明显的缺点：

• 当我们将新方法添加到Animal接口时，不仅需要添加此方法的实现来实现Cat类，而且因为代理类实现了Animal接口，所以代理类还必须实现Animal的新方法，这在项目规模较大时不利于维护。
• Animal调用的代理类实现是为Cat目标类的对象设置的。如果需要添加Dog目标类的代理，则必须为Dog类实现一个相应的代理类，这会使代理类的重用性变得不友好，并且太多的代理类难以维护。

在JDK动态代理中友好地解决了以上问题。

动态代理

JDK动态代理

动态代理类和静态代理类之间的主要区别在于，代理类的字节码不是在程序运行之前生成的，而是在程序运行时在虚拟机中自动创建的。

实现InvocationHandler接口

JDK动态代理类必须在反射包中实现java.lang.reflect.InvocationHandler接口，它负责实现接口的方法调用，它的实现类相当于一个切面。

package com.proxy.example.jdkdynamicproxy;

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;

public class TargetInvoker implements InvocationHandler {
    // 代理中的目标对象
    private Object target;

    public TargetInvoker(Object target) {
        this.target = target;
    }

    /**
     *
     * @param proxy 代理目标对象的代理对象，它是真实的代理对象。
     * @param method 方法执行目标类的方法
     * @param args 执行目标类的方法的args参数
     * @return
     * @throws Throwable
     */
    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        System.out.println("jdk agent before invocation");　　// 执行切入的逻辑
        Object result = method.invoke(target, args);　　// 执行原有的逻辑
        System.out.println("jdk agent after invocation");
        return result;
    }
}

创建JDK动态代理类

创建JDK动态代理类的实例还使用反射包中的java.lang.reflect.Proxy类。通过调用代理Proxy#newproxyinstance静态方法创建，它是织入器，织入代码并生成代理类。

package com.proxy.example.jdkdynamicproxy;

import java.lang.reflect.Proxy;

public class DynamicProxyAnimal {
    public static Object getProxy(Object target) throws Exception {
        Object proxy = Proxy.newProxyInstance(
                target.getClass().getClassLoader(), // 目标类的类加载器, 生成代理类的字节码加载器
                target.getClass().getInterfaces(),  // 需要代理的接口, 被代理类实现的接口可以在这里实现，可以是一个数组
                new TargetInvoker(target)   // 构建AOP的advice, 这里需要传入业务类的实例
        );
        return proxy;
    }
}

通过Proxy.newProxyInstance()创建interface实例，它需要3个参数：

1. 使用的ClassLoader，通常就是接口类的ClassLoader；

2. 需要实现的接口数组，至少需要传入一个接口进去；

3. 用来处理接口方法调用的实例InvocationHandler 。

最后，实现动态代理。

package com.proxy.example.jdkdynamicproxy;

import com.proxy.example.Animal;
import com.proxy.example.Cat;
import org.junit.Test;

public class Main {
    @Test
    public void jdkDynamicProxy() throws Exception {
        Cat cat = new Cat();
        Animal proxy = (Animal) DynamicProxyAnimal.getProxy(cat);   // 将返回的Object强制转型为接口
        proxy.call();
    }
}

JDK在运行期动态创建class字节码并加载的过程。动态代理是通过Proxy创建代理对象，然后将接口方法“代理”给 InvocationHandler 完成的。保存动态生成的代理的方法：

System.setProperty(DebuggingClassWriter.DEBUG_LOCATION_PROPERTY, "./");

动态代理原理：

    @CallerSensitive
    public static Object newProxyInstance(ClassLoader loader,
                                          Class<?>[] interfaces,
                                          InvocationHandler h)
        throws IllegalArgumentException
    {
        Objects.requireNonNull(h);

        final Class<?>[] intfs = interfaces.clone();
        final SecurityManager sm = System.getSecurityManager();
        if (sm != null) {
            checkProxyAccess(Reflection.getCallerClass(), loader, intfs);
        }

        /*
         * 获取代理类
         */
        Class<?> cl = getProxyClass0(loader, intfs);

        /*
         * Invoke its constructor with the designated invocation handler.
         */
        try {
            if (sm != null) {
                checkNewProxyPermission(Reflection.getCallerClass(), cl);
            }

            final Constructor<?> cons = cl.getConstructor(constructorParams);　　// 获取带有InvocationHandler参数的构造方法
            final InvocationHandler ih = h;
            if (!Modifier.isPublic(cl.getModifiers())) {
                AccessController.doPrivileged(new PrivilegedAction<Void>() {
                    public Void run() {
                        cons.setAccessible(true);
                        return null;
                    }
                });
            }
            return cons.newInstance(new Object[]{h});　　// 把handler传入构造方法生成实例
        } catch (IllegalAccessException|InstantiationException e) {
            throw new InternalError(e.toString(), e);
        } catch (InvocationTargetException e) {
            Throwable t = e.getCause();
            if (t instanceof RuntimeException) {
                throw (RuntimeException) t;
            } else {
                throw new InternalError(t.toString(), t);
            }
        } catch (NoSuchMethodException e) {
            throw new InternalError(e.toString(), e);
        }
    }

其中 getProxyClass(loader, interfaces) 方法用于获取代理类，它主要做了三件事情：在当前类加载器的缓存里搜索是否有代理类，没有则生成代理类并缓存在本地JVM里。

    /**
     * 生成代理类。在调用此方法之前, 必须调用checkProxyAccess方法执行权限检查。
     */
    private static Class<?> getProxyClass0(ClassLoader loader,
                                           Class<?>... interfaces) {
        if (interfaces.length > 65535) {
            throw new IllegalArgumentException("interface limit exceeded");
        }

        // 如果由实现了给定接口的给定加载器定义的代理类存在, 则将简单地返回缓存的副本;
        // 否则, 它将通过ProxyClassFactory创建代理类
        return proxyClassCache.get(loader, interfaces);
    }

其中，代理类的生成主要是以下这两行代码。

　　byte[] proxyClassFile = ProxyGenerator.generateProxyClass(
                proxyName, interfaces, accessFlags);　　// 生成代理类的字节码文件并保存

　　defineClass0(loader, proxyName, proxyClassFile, 0, proxyClassFile.length);　　// 使用类加载器将字节码加载到内存中

动态代理在运行期通过接口动态生成代理类，这为其带来了一定的灵活性，但这个灵活性却带来了两个问题，第一代理类必须实现一个接口，如果没实现接口会抛出一个异常。第二性能影响，因为动态代理使用反射的机制实现的，首先反射肯定比直接调用要慢。其次，使用反射大量生成类文件可能引起 Full GC 造成性能影响，因为字节码文件加载后会存放在 JVM 运行时区的方法区（或者叫持久代）中，当方法区满的时候，会引起 Full GC，所以当你大量使用动态代理时，可以将持久代设置大一些，减少 Full GC 次数。

CGLIB动态代理

CGLIB (Code Generation Library)，一个强大的，高性能，高质量的Code生成类库，它可以在运行期扩展Java类与实现Java接口。它广泛的被许多AOP的框架使用，例如Spring AOP等。CGLIB包的底层是通过使用一个小而快的字节码处理框架ASM，来转换字节码并生成新的类，将切面逻辑加入到子类中，所以使用 CGLIB 实现 AOP 不需要基于接口。

CGLIB动态代理的实现机制是生成目标类的子类（Enhancer#create），该目标类是通过调用父类（目标类）的方法来实现的，然后在调用父类的方法时在代理中进行增强。

实现MethodInterceptor接口

与JDK动态代理的实现相比，CGLIB动态代理不需要实现与目标类相同的接口，而是通过方法拦截来实现代理。

package com.proxy.example.cglibproxy;

import org.springframework.cglib.proxy.MethodInterceptor;
import org.springframework.cglib.proxy.MethodProxy;

import java.lang.reflect.Method;

/**
 * 方法拦截器——通过方法拦截接口调用目标类的方法, 然后增强被拦截的方法. 方法拦截器接口的拦截方法中有四个参数
 */
public class TargetInterceptor implements MethodInterceptor {

    /**
     * 拦截方法
     *
     * @param obj obj代理类对象
     * @param method 代理当前拦截的方法
     * @param args 拦截方法参数
     * @param methodProxy 与目标类相对应的代理类的代理方法
     * @return result
     * @throws Throwable 抛出的异常
     */
    @Override
    public Object intercept(Object obj, Method method, Object[] args, MethodProxy methodProxy) throws Throwable {
        System.out.println("CGLIB Before Calling");　　// 执行织入的操作
        Object result = methodProxy.invokeSuper(obj, args);　　// 执行原有逻辑，注意这里是invokeSuper
        System.out.println("CGLIB After Calling");
        return result;
    }
}

创建CGLIB动态代理类

使用 Enhancer 类创建CGLIB动态代理类。它是一个织入器，CGLIB动态代理中的核心类。

package com.proxy.example.cglibproxy;

import org.springframework.cglib.proxy.Enhancer;

/**
 * 使用Enhancer类创建CGLIB动态代理类. 它是CGLIB动态代理中的核心类.
 */
public class CglibProxy {
    public static Object getProxy(Class<?> clazz) {
        Enhancer enhancer = new Enhancer();
        enhancer.setClassLoader(clazz.getClassLoader());　　// 设置类加载器
        enhancer.setSuperclass(clazz);　　// 设置父类
        enhancer.setCallback(new TargetInterceptor());　　// 使用织入器创建子类
        return enhancer.create();　　// 使用织入器创建子类
    }
}

可以通过设置代理类的信息以及代理类所拦截的方法的回调执行逻辑来实现代理类。

CGLIB动态代理调用：

package com.proxy.example.cglibproxy;

import com.proxy.example.Animal;
import com.proxy.example.Cat;
import org.junit.Test;
import org.springframework.cglib.core.DebuggingClassWriter;

public class Main {
    @Test
    public void cglibDynamicProxy() throws Exception {
        System.setProperty(DebuggingClassWriter.DEBUG_LOCATION_PROPERTY, "./");
        Animal cat = (Animal) CglibProxy.getProxy(Cat.class);
        cat.call();
    }
}

上面是在简单应用程序中实现CGLIB动态代理的方式。但是， Enhancer是常用的，并且在回调过滤器的使用中具有特色。当它拦截目标对象的方法时，它可以有选择地执行方法拦截，即选择代理方法的增强处理。现在再添加一个方法拦截实现：

package com.proxy.example.cglibproxy;

import org.springframework.cglib.proxy.MethodInterceptor;
import org.springframework.cglib.proxy.MethodProxy;

import java.lang.reflect.Method;

/**
 * 方法拦截器2
 */
public class TargetInterceptor2 implements MethodInterceptor {
    @Override
    public Object intercept(Object obj, Method method, Object[] args, MethodProxy methodProxy) throws Throwable {
        System.out.println("CGLIB Before calling TargetInterceptor2");
        Object result = methodProxy.invokeSuper(obj, args);
        System.out.println("CGLIB After calling TargetInterceptor2");
        return result;
    }
}

实现回调过滤器 CallbackFilter。

package com.proxy.example.cglibproxy;

import org.springframework.cglib.proxy.CallbackFilter;

import java.lang.reflect.Method;

/**
 * 回调过滤器
 */
public class TargetCallbackFilter implements CallbackFilter {
    /**
     * 使用Enhancer#setcallbacks设置多个方法拦截器的数组中的方法拦截器
     *
     * @param method 方法
     * @return 返回的数字是数组的索引
     */
    @Override
    public int accept(Method method) {
        if ("hobby".equals(method.getName())) {
            return 1;
        } else {
            return 0;
        }
    }
}

要演示如何调用不同的方法拦截器，需要在Enhancer设置中，使用 Enhancer#setcallbacks 设置多个方法拦截器。该参数是一个数组。 Targetcallbackfilter#accept返回的数字是数组的索引，它确定要回调哪个方法拦截器。

package com.proxy.example.cglibproxy;

import org.springframework.cglib.proxy.Callback;
import org.springframework.cglib.proxy.Enhancer;

public class CglibProxy2 {
    public static Object getProxy(Class<?> clazz) {
        Enhancer enhancer = new Enhancer();
        enhancer.setClassLoader(clazz.getClassLoader());
        enhancer.setSuperclass(clazz);
        enhancer.setCallbacks(new Callback[]{new TargetInterceptor(), new TargetInterceptor2()});   // 设置回调数组
        enhancer.setCallbackFilter(new TargetCallbackFilter()); // 设置回调过滤器
        return enhancer.create();
    }
}

根据代码实现逻辑，调用喵喵加的方法将调用 TargetInterceptor 类，而兴趣方法将调用 TargetInterceptor2 类。

    @Test
    public void dynamicProxy() throws Exception {
        System.setProperty(DebuggingClassWriter.DEBUG_LOCATION_PROPERTY, "./");
        Animal cat = (Animal) CglibProxy2.getProxy(Cat.class);
        cat.call();
        cat.hobby();
    }

执行结果如下：

总结：JDK动态代理实现目标类的接口，然后在构造动态代理时将目标类作为参数传递，因此代理对象保存目标对象，然后通过代理对象的 InvocationHandler 实现动态代理的操作。

CGLIB动态代理将通过配置目标类信息并使用ASM字节码框架来生成目标类的子类。调用代理方法时，代理的操作是通过拦截该方法来实现的。

通常，JDK动态代理使用接口来实现代理，而CGLIB动态代理使用继承来实现代理。

参考：参考一、参考二