Java代理（静态代理、JDK动态代理、CGLIB动态代理）

Java中代理有静态代理和动态代理。静态代理的代理关系在编译时就确定了，而动态代理的代理关系是在运行期确定的。静态代理实现简单，适合于代理类较少且确定的情况，而动态代理则给我们提供了更大的灵活性。

Java中动态代理有JDK原生动态代理和CGLIB动态代理两种。前者本质上是根据定好的接口动态生成静态代理类（该接口的实现类）；后者则不需要事先定好接口而是可以直接根据类进行动态代理，其本质是根据指定的类动态生成静态代理类（指定的类的子类）。动态代理中，被代理的对象的所有方法都会被代理，除非在代理逻辑中进行方法筛选。

本质：

JDK原生动态代理：生成被代理对象所实现的接口的实现类；实现类中每个方法调用被代理对象的相应方法，只不过在调用前后加上了额外逻辑；要求被代理对象实现接口

CGLIB动态代理：生成被代理对象的子类；子类中的每个方法调用被代理对象（父类对象）中的相应方法，只不过在调用前后加上了额外处理；要求被代理对象不能被final修饰

动态代理是IOC、AOP等技术的基础。

静态代理和JDK动态代理

Dynamic proxies allow one single class with one single method to service multiple method calls to arbitrary classes with an arbitrary number of methods. A dynamic proxy can be thought of as a kind of Facade, but one that can pretend to be an implementation of any interface. Under the cover, it routes all method invocations to a single handler – the invoke() method.   https://www.baeldung.com/java-dynamic-proxies

示例：

package com.marchon.proxytest;

public interface IUserService {
    public String getUserName();
    public Integer getAge(String userName);
}

package com.marchon.proxytest;

/**
 * 被代理对象
 * 
 * @author zsm
 *
 */
public class UserServiceImpl implements IUserService {

    @Override
    public String getUserName() {
        String res = this.getClass() + ":hello";
        System.out.println(res);
        return res;
    }

    @Override
    public Integer getAge(String userName) {
        Integer age = 20;
        System.out.println(age);
        return age;
    }

}

package com.marchon.proxytest;

/**
 * 代理对象（静态代理）<br>
 * 缺点：<br>
 * 1、代理类和被代理类实现相同的接口，代码重复、得为每个接口都实现相应的实现从而维护成本高 2、代理对象只服务于被代理对象，即每个被代理对象都得实现相应的代理对象
 * 
 * @author zsm
 *
 */
class UserServiceStaticProxy implements IUserService {
    private IUserService proxiedObj;

    public UserServiceStaticProxy(IUserService proxiedObj) {
        if (proxiedObj instanceof UserServiceStaticProxy) {
            throw new RuntimeException("illegal proxiedObj proxied object");
        }

        this.proxiedObj = proxiedObj;
    }

    @Override
    public String getUserName() {
        System.out.println("before");
        String res = proxiedObj.getUserName();
        System.out.println("after");
        return res;

    }

    @Override
    public Integer getAge(String userName) {
        System.out.println("before");
        Integer age = proxiedObj.getAge(userName);
        System.out.println("after");
        return age;
    }

}

public class Main_StaticProxy {
    public static void main(String[] args) {
        IUserService proxiedObj = new UserServiceImpl();

        // UserServiceStaticProxy proxy = new UserServiceStaticProxy(proxiedObj);
        IUserService proxyObject = new UserServiceStaticProxy(proxiedObj);
        proxyObject.getUserName();
        proxyObject.getAge("zhangsan");
    }
}

 

package com.marchon.proxytest;

import java.io.FileOutputStream;
import java.io.IOException;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;

import sun.misc.ProxyGenerator;

/**
 * 代理对象（动态代理）<br>
 * 动态代理：在程序运行期间根据需要动态创建代理类及其实例来完成具体的功能。动态代理主要分为JDK动态代理和cglib动态代理两大类<br>
 * 这里介绍jdk动态代理，其本质上是在运行时动态产生一个实现指定接口的静态代理类，指定接口的所有非final方法（包括继承的非final方法如toString）均会被代理。
 * 
 * @author zsm
 *
 */

class JdkDynamicProxyTemplate implements InvocationHandler {
    private Object proxiedObj;

    public JdkDynamicProxyTemplate(Object proxiedObj) {
        this.proxiedObj = proxiedObj;
    }

    @Override
    public Object invoke(Object proxyObj, Method method, Object[] args) throws Throwable {
        // if (method.getName().equals("getUserName")) {//为避免所有非final方法都被代理，可作此判断
        //
        // }

        // System.out.println(proxyObj);//stack overflow, why?
        // System.out.println(method);// public abstract java.lang.String com.marchon.proxytest.IUserService.getUserName()

        System.out.println("before");
        Object res = method.invoke(proxiedObj, args);
        System.out.println("after");

        return res;
    }

}

public class Main_JdkDynamicProxy {// 参阅:https://www.jianshu.com/p/269afd0a52e6
    public static void main(String[] args) {
        IUserService proxiedObj = new UserServiceImpl();

        JdkDynamicProxyTemplate proxyTemplate = new JdkDynamicProxyTemplate(proxiedObj);

        // 第一个参数是指定代理类的类加载器（我们传入当前测试类的类加载器）
        // 第二个参数是代理类需要实现的接口（我们传入被代理类实现的接口，这样生成的代理类和被代理类就实现了相同的接口）
        // 第三个参数是invocation handler，用来处理方法的调用。这里传入我们自己实现的handler
        IUserService proxyObject = (IUserService) Proxy.newProxyInstance(proxiedObj.getClass().getClassLoader(),
                proxiedObj.getClass().getInterfaces(), proxyTemplate);// 创建包含被代理对象各方法的代理对象，显然可知：该代理对象实现了所传接口中(这里为IUserService)定义的各方法、代理对象的各方法实现为直接调用proxyTemplate相应的各方法实现。可以使用sum.misc下的ProxyGenerator生成动态代理类的字节码文件，再反编译出动态代理类源码

        proxyObject.getUserName();
        proxyObject.getAge("zhangsan");
        proxyObject.toString();// 所有非final方法都会被代理，包括从Object继承的等

        {
            // 获取代理类字节码文件
            String path = "$Proxy0.class";
            byte[] classFile = ProxyGenerator.generateProxyClass("$Proxy0", proxiedObj.getClass().getInterfaces());
            FileOutputStream out = null;

            try {
                out = new FileOutputStream(path);
                out.write(classFile);
                out.flush();
            } catch (Exception e) {
                e.printStackTrace();
            } finally {
                try {
                    out.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }

        // jdk动态代理动态产生的代理类类似于如下静态代理
        System.out.println();
        System.out.println("equivalent static proxy test:");
        new TmpEquivalentStaticProxy(proxyTemplate).getUserName();

    }
}

/**
 * 
 * 上述生成的动态代理生成的代理类实际是类似于本类
 * 
 * @author zsm
 *
 */
class TmpEquivalentStaticProxy implements IUserService {// 真正由jdk动态代理生成的代理类还 extends Proxy
    private InvocationHandler invokeHandler;

    public TmpEquivalentStaticProxy(InvocationHandler invokeHandler) {
        this.invokeHandler = invokeHandler;
    }

    @Override
    public String getUserName() {
        Object[] args = null;
        Method getUserNameMethod = IUserService.class.getMethods()[0];// public abstract java.lang.String
                                                                        // com.marchon.proxytest.IUserService.getUserName()
        try {
            return (String) invokeHandler.invoke(this, getUserNameMethod, args);
        } catch (Throwable e) {
            e.printStackTrace();
            return null;
        }

    }

    @Override
    public Integer getAge(String userName) {
        Object[] args = new Object[] { userName };
        try {
            Method getAgeMethod = IUserService.class.getMethods()[1];// public abstract java.lang.Integer
                                                                        // com.marchon.proxytest.IUserService.getAge(java.lang.String)
            return (Integer) invokeHandler.invoke(this, getAgeMethod, args);
        } catch (Throwable e) {
            e.printStackTrace();
            return null;
        }

    }

}

springframework中的一个jdk动态代理示例：

由上可见，静态代理的各个方法具有共性：每个方法内的前后都做额外其他处理、中间调用被代理对象的相应方法。既然有共性，那就可以抽取共性以减少重复，也即将静态代理的方法抽象出一个”模板“，这样就不需要在代理对象中针对被代理对象的每个方法写额外逻辑，这其实就变成了动态代理。

JDK动态代理实际上是自动生成一个静态代理类并创建相应实例。代理类默认继承Porxy类，因为Java中只支持单继承，所以JDK动态代理只能去实现接口；代理类的方法都会去调用InvocationHandler的invoke()方法，故此需重写InvocationHandler的invoke()方法。

JDK动态代理为我们提供了非常灵活的代理机制，但也有不足：

被代理对象的所有非final方法（如从Object继承的toString、equals等）都会被代理（即都会在方法前后做与InvocationHandler的invoke()方法前后同样的处理，当然我们可以通过在invoke里对method name加以判断避免此情况），然而有时候我们并不希望这些方法被代理。

JDK动态代理是基于接口的（生成的动态代理类实际上extends Proxy implements IUserService）。如果要被代理的对象没有实现接口，该如何实现代理呢？可用下面要介绍的CGLIB动态代理。

从上面讨论可得知，静态代理和动态代理在运行时是一样的（都是静态代理了），其差异在运行时之前（即编译期）才存在，差异体现在开发者是否需要分别在每个与被代理方法对应的代理方法的前后写额外的处理逻辑：静态代理需要而动态代理不需要（后者不需要是因为该任务从由开发者负责转交由JVM来负责了）。因此，动态代理相比于静态代理的主要优势是为开发者提供便利，不用像静态代理那写重复的代理方法逻辑。

CGLIB动态代理（springframework）

与JDK动态代理不同，CGLIB（Code Generation Library）动态代理不需要事先定义接口，而是可以直接对类进行动态代理。CGLIB动态代理中被代理对象的所有非final方法默认也会被代理。

示例：

package com.marchon.proxytest;

import java.lang.reflect.Method;

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

/**
 * 代理对象（动态代理）<br>
 * 动态代理：在程序运行期间根据需要动态创建代理类及其实例来完成具体的功能。动态代理主要分为JDK动态代理和cglib动态代理两大类<br>
 * 这里介绍cglib动态代理，其本质上是在运行时动态产生一个实现继承指定类的的静态代理类，指定类的所有非final方法（包括继承的非final方法如toString）均会被代理。
 * 
 * @author zsm
 *
 */

class CglibDynamicProxyTemplate implements MethodInterceptor {

    @Override
    public Object intercept(Object proxyObj, Method proxiedMethod, Object[] args, MethodProxy proxyMethod) throws Throwable {
        // if (method.getName().equals("sayHello")) {//为避免所有非final方法都被代理，可作此判断
        //
        // }

        // System.out.println(proxyObj);//stack overflow, why?
        // System.out.println(proxiedMethod);// public java.lang.String
        // com.marchon.proxytest.HelloConcrete.sayHello(java.lang.String)
        // System.out.println(proxyMethod);// org.springframework.cglib.proxy.MethodProxy@108c4c35

        System.out.println("before");
        Object res = proxyMethod.invokeSuper(proxyObj, args);
        System.out.println("after");
        return res;
    }

}

class HelloConcrete {
    public String sayHello(String username) {
        return "hello " + username;
    }

    public final String getAddress() {
        return "beijing";
    }
}

public class Main_CglibDynamicProxy {
    public static void main(String[] args) {
        CglibDynamicProxyTemplate proxyTemplate = new CglibDynamicProxyTemplate();

        Enhancer enhancer = new Enhancer();
        enhancer.setSuperclass(HelloConcrete.class);
        enhancer.setCallback(proxyTemplate);

        HelloConcrete proxyObject = (HelloConcrete) enhancer.create();
        System.out.println(proxyObject.sayHello("zhangsan"));// 会创建包含被代理对象所有非final方法的代理类，实际上代理类是被代理类的子类，故不会代理final方法；代理对象的各方法实现为直接调用proxyTemplate相应的各方法实现
        proxyObject.hashCode();// 所有非final方法都会被代理，包括从Object继承的等
        proxyObject.getAddress();// final方法不会被代理

        // jdk动态代理动态产生的代理类类似于如下静态代理
        System.out.println();
        System.out.println("equivalent static proxy test:");
        new TmpEquivalentStaticProxyOfCglib(proxyTemplate).sayHello("zhangsan");
    }
}

class TmpEquivalentStaticProxyOfCglib extends HelloConcrete {// 真正由cglib动态代理生成的代理类还 implements Factory
    private MethodInterceptor methodInterceptor;

    public TmpEquivalentStaticProxyOfCglib(MethodInterceptor methodInterceptor) {
        this.methodInterceptor = methodInterceptor;
    }

    @Override
    public String sayHello(String username) {
        Object[] args = null;
        Method proxiedMethod = super.getClass().getMethods()[0];
        MethodProxy proxyMethod = null;// this.getClass().getMethods()[0];//不造如何获取MethodProxy对象，故此方法实际上跑不了

        try {
            return (String) methodInterceptor.intercept(this, proxiedMethod, args, proxyMethod);
        } catch (Throwable e) {
            e.printStackTrace();
            return null;
        }

    }

    // 无法override getAddress方法
}

由上可见，此动态代理本质上是在运行时动态根据指定的类继承实现一个子类（故指定的类不能是final的），在子类中重写方法，方法的实现为调用MethodInterceptor中的intercept方法。

参考资料

https://www.jianshu.com/p/269afd0a52e6

https://www.cnblogs.com/liuyun1995/p/8144628.html

https://www.cnblogs.com/CarpenterLee/p/8241042.html JDK动态代理和CGLIB动态代理

https://blog.csdn.net/difffate/article/details/70552056 CGLIB动态代理