JDK的动态代理

场景

在数据保存前后加入日志

实例

先定义数据保存接口

interface DataSave{
    void save();
}

然后定义一个sql拦截器，在数据保存前后打印日志

class SqlInterceptor implements InvocationHandler{
    private DataSave dataSave;

    public SqlInterceptor(DataSave dataSave){
        this.dataSave = dataSave;
    }

    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        System.out.println("before.....");
        Object result = method.invoke(dataSave,args);
        System.out.println("after.....");
        return result;
    }
}

最后在运行期间生成代理类，执行数据保存

public class ProxyPattern {

    public static void main(String[] args){
        System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");
        System.out.println("$Proxy0.class全名: "+Proxy.getProxyClass(DataSave.class.getClassLoader(), DataSave.class).toString());
        DataSave sqlProxy = (DataSave) Proxy.newProxyInstance(SqlInterceptor.class.getClassLoader(),
                new Class[]{DataSave.class},new SqlInterceptor(new DataSaveImpl()));
        sqlProxy.save();
    }
}   }
}

其中，System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");用于设置将生成的代理类输出到文件(字节码)，文件会放在项目的根目录下。

代理类执行数据保存结果

$Proxy0.class全名: class meituan.$Proxy0
before.....
DataSaveImpl save...
after.....

这里我们其实想看下代理类长什么样子，知道了代理类的逻辑，基本也知道动态代理的原理了。

因为代理类文件是class字节码文件，如下的样子

需要对其进行反编译，方便查看代码逻辑，使用?jd-gui 反编译，下载地址：Releases · java-decompiler/jd-gui · GitHubhttps://github.com/java-decompiler/jd-gui/releases

也可以直接用idea反编译看。

反编译后，如下：

package meituan;

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

final class $Proxy0 extends Proxy implements DataSave {
  private static Method m1;
  
  private static Method m3;
  
  private static Method m2;
  
  private static Method m0;
  
  public $Proxy0(InvocationHandler paramInvocationHandler) {
    super(paramInvocationHandler);
  }
  
  public final boolean equals(Object paramObject) {
    try {
      return ((Boolean)this.h.invoke(this, m1, new Object[] { paramObject })).booleanValue();
    } catch (Error|RuntimeException error) {
      throw null;
    } catch (Throwable throwable) {
      throw new UndeclaredThrowableException(throwable);
    } 
  }
  
  public final void save() {
    try {
      this.h.invoke(this, m3, null);
      return;
    } catch (Error|RuntimeException error) {
      throw null;
    } catch (Throwable throwable) {
      throw new UndeclaredThrowableException(throwable);
    } 
  }
  
  public final String toString() {
    try {
      return (String)this.h.invoke(this, m2, null);
    } catch (Error|RuntimeException error) {
      throw null;
    } catch (Throwable throwable) {
      throw new UndeclaredThrowableException(throwable);
    } 
  }
  
  public final int hashCode() {
    try {
      return ((Integer)this.h.invoke(this, m0, null)).intValue();
    } catch (Error|RuntimeException error) {
      throw null;
    } catch (Throwable throwable) {
      throw new UndeclaredThrowableException(throwable);
    } 
  }
  
  static {
    try {
      m1 = Class.forName("java.lang.Object").getMethod("equals", new Class[] { Class.forName("java.lang.Object") });
      m3 = Class.forName("meituan.DataSave").getMethod("save", new Class[0]);
      m2 = Class.forName("java.lang.Object").getMethod("toString", new Class[0]);
      m0 = Class.forName("java.lang.Object").getMethod("hashCode", new Class[0]);
      return;
    } catch (NoSuchMethodException noSuchMethodException) {
      throw new NoSuchMethodError(noSuchMethodException.getMessage());
    } catch (ClassNotFoundException classNotFoundException) {
      throw new NoClassDefFoundError(classNotFoundException.getMessage());
    } 
  }
}

和静态代理原理是一样的，只是JDK提供了一个运行期间生成代理类的工具，不需要手写这些代理类了。

CGLIB动态代理

Cglib动态代理是基于类的方式，创建一个数据保存的类。

class UserDao{
    public void save(){
        System.out.println("user save.....");
    }
}

创建一个sql拦截器

class CglibSqlInterceptor implements MethodInterceptor{
    private UserDao userDao;

    public CglibSqlInterceptor(UserDao userDao){
        this.userDao = userDao;
    }

    @Override
    public Object intercept(Object o, Method method, Object[] args, MethodProxy methodProxy) throws Throwable {
        System.out.println("before.....");
        Object result = methodProxy.invoke(userDao,args);
        System.out.println("after.....");
        return result;
    }
}

在运行期间生成代理类，执行数据保存

public class ProxyPattern {

    public static void main(String[] args){
        // 获取当前项目的根目录
        String userDir = System.getProperty("user.dir");
        //System.setProperty("cglib.debugLocation", userDir);
        System.setProperty(DebuggingClassWriter.DEBUG_LOCATION_PROPERTY, userDir);
        Enhancer enhancer = new Enhancer();
        enhancer.setSuperclass(UserDao.class);
        enhancer.setCallback(new CglibSqlInterceptor(new UserDao()));
        UserDao userDaoProxy = (UserDao) enhancer.create();
        userDaoProxy.save();
    }
}

其中，System.setProperty(DebuggingClassWriter.DEBUG_LOCATION_PROPERTY, userDir);用于设置将生成的代理类输出到文件，userDir这里为项目根目录。

?可以看到生成了三个类，这里先了解下FastClass机制：

FastClass 的原理简单来说就是：为不需要反射 invoke 调用的原类型生成一个 FastClass 类，然后给原类型的方法分配一个 index，在生成的 FastClass 中的 invoke 方法中，先直接把 Object 强制转换为原类型，然后根据这个 index，就可以直接定位要调用的方法直接进行调用，这样省去了反射调用，所以调用效率比 JDK 动态代理通过反射调用高。

UserDao$$EnhancerByCGLIB$$a83b86bb：代理类
UserDao$$EnhancerByCGLIB$$a83b86bb$$FastClassByCGLIB$$62b3dfd2：代理类的FastClass
UserDao$$FastClassByCGLIB$$5d3d478：被代理类的FastClass

这三个类就在根目录下，可以在idea里直接看到反编译后的代码。