JVM插码之四：Java动态代理机制的对比（JDK 和CGLIB，Javassist，ASM）

一、class文件简介及加载

     Java编译器编译好Java文件之后，产生.class 文件在磁盘中。这种class文件是二进制文件，内容是只有JVM虚拟机能够识别的机器码。JVM虚拟机读取字节码文件，取出二进制数据，加载到内存中，解析.class 文件内的信息，生成对应的 Class对象:

class字节码文件是根据JVM虚拟机规范中规定的字节码组织规则生成的、具体class文件是怎样组织类信息的，可以参考 此博文：深入理解Java Class文件格式系列。或者是Java虚拟机规范。

下面通过一段代码演示手动加载 class文件字节码到系统内，转换成class对象，然后再实例化的过程：

   a. 定义一个 Programmer类：

package com.dxz.chama.sample;

public class Programmer {
    public void code() {
        System.out.println("I'm a Programmer,Just Coding.....");
    }
}

b. 自定义一个类加载器：

package com.dxz.chama.sample;

public class MyClassLoader extends ClassLoader {

    public Class<?> defineMyClass(byte[] b, int off, int len) {
        return super.defineClass(b, off, len);
    }

}

c. 然后编译成Programmer.class文件，在程序中读取字节码，然后转换成相应的class对象，再实例化：

package com.dxz.chama.sample;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.InvocationTargetException;

public class MyTest {

    public static void main(String[] args) throws IOException {
        // 读取本地的class文件内的字节码，转换成字节码数组
        File file = new File(".");
        InputStream input = new FileInputStream(file.getCanonicalPath() + "\target\classes\com\dxz\chama\sample\Programmer.class");
        byte[] result = new byte[1024];

        int count = input.read(result);
        // 使用自定义的类加载器将 byte字节码数组转换为对应的class对象
        MyClassLoader loader = new MyClassLoader();
        Class clazz = loader.defineMyClass(result, 0, count);
        // 测试加载是否成功，打印class 对象的名称
        System.out.println(clazz.getCanonicalName());

        
        try {
            // 实例化一个Programmer对象
            Object o = clazz.newInstance();
            // 调用Programmer的code方法
            clazz.getMethod("code", null).invoke(o, null);
        } catch (IllegalAccessException | InstantiationException | IllegalArgumentException | InvocationTargetException | NoSuchMethodException | SecurityException e) {
            e.printStackTrace();
        }
    }
}

运行结果：

以上代码演示了，通过字节码加载成class 对象的能力，下面看一下在代码中如何生成class文件的字节码。

二、在运行期的代码中生成二进制字节码

   由于JVM通过字节码的二进制信息加载类的，那么，如果我们在运行期系统中，遵循Java编译系统组织.class文件的格式和结构，生成相应的二进制数据，然后再把这个二进制数据加载转换成对应的类，这样，就完成了在代码中，动态创建一个类的能力了。

在运行时期可以按照Java虚拟机规范对class文件的组织规则生成对应的二进制字节码。当前有很多开源框架可以完成这些功能，如ASM，Javassist（Java Programming Assistant）。

ASM、Javassist（Java Programming Assistant）比较

Javassist：

Javassist（Java编程助手）使Java字节码操作变得简单。它是一个用于在Java中编辑字节码的类库；它允许Java程序在运行时定义一个新类，并在JVM加载时修改类文件。不同于其他类似的字节码编辑器。

Javassist提供两个级别的API：源代码级别和字节码级别。如果用户使用源级API，他们可以编辑一个类文件而不知道Java字节码的规范。整个API只设计了Java语言的词汇表。您甚至可以以源文本的形式指定插入的字节码；Javassist可以动态编译它。另一方面，字节码级API允许用户像其他编辑器一样直接编辑类文件。

Javassist允许检查、编辑和创建Java二进制类。

Javassist并不是唯一使用字节码的库，但它确实有一个特性，特别是它使它成为一个很好的用于实验类工作的起点：您可以使用Javassist来修改Java类的字节码，而不必学习字节码或Java虚拟机（JVM）架构的任何内容。

面向方面的编程：Javassist可以是一个很好的工具，用于向类中添加新方法，以及在调用者和被调用者端插入前后切面。

反射：Javassist的一个应用是运行时反射；Javassist使Java程序能够使用一个Meta对象来控制基类对象上的方法调用。不需要专门的编译器或虚拟机。

Javassist还提供了用于直接编辑类文件的底层API。要使用这个API级别，需要了解Java字节码和类文件格式的详细知识，同时这种API级别允许您对类文件进行任何类型的修改。

ASM： 

ASM是一个通用的Java字节码操作和分析框架。它可以直接以二进制形式修改现有类或动态生成类。提供了通用的转换和分析算法，可以方便地组装自定义的复杂转换和代码分析工具。

ASM提供与其他字节码框架类似的功能，但它的重点是简单的使用和性能。因为它的设计和实现是尽可能小和快，所以它非常有吸引力用于动态系统*。

ASM是一种Java类操作工具，用于动态生成和操作Java类，这是实现可适应系统的有用技术。与现有的等效工具相比，ASM基于一种新的方法，即使用“访问者”设计模式，而不显式地用对象表示被访问的树。对于大多数实际需要，这种新方法比现有工具的性能要好得多。

Javassist和ASM之间的比较：

•与ASM中的实际字节码操作相比，Javassist源代码级API更易于使用。

•Javassist在复杂的字节码级操作上提供了更高级别的抽象层。Javassist源代码级API需要的实际字节码知识很少或根本不需要，因此实现起来更容易、更快。

•Javassist使用反射机制，这使得它比运行时使用类工作技术的ASM慢。

•总体上，ASM比Javassist更快，性能更好。Javassist使用Java源代码的简化版本，然后将其编译成字节码。这使得javassist非常容易使用，但是它也将字节码的使用限制在javassist源代码的限制范围内。

总之，如果有人需要更简单的方法来动态地操纵或创建Java类，则应该使用Javassist API，而性能是关键问题的ASM库应该被使用。

Table 1. Class构建时间

Framework   First time     Later times
Javassist      257              5.2
BCEL           473               5.5
ASM            62.4              1.1
表1的结果表明，ASM确实比其他框架更快地实现了它的消耗时间，而且这一优势既适用于启动时间，也适用于重复使用。

　　几种动态编程方法相比较，在性能上Javassist高于反射，但低于ASM，因为Javassist增加了一层抽象。在实现成本上Javassist和反射都很低，而ASM由于直接操作字节码，相比Javassist源码级别的api实现成本高很多。几个方法有自己的应用场景，比如Kryo使用的是ASM，追求性能的最大化。而NBeanCopyUtil采用的是Javassist，在对象拷贝的性能上也已经明显高于其他的库，并保持高易用性。实际项目中推荐先用Javassist实现原型，若在性能测试中发现Javassist成为了性能瓶颈，再考虑使用其他字节码操作方法做优化。

Java字节码生成开源框架介绍--ASM：

ASM 是一个 Java 字节码操控框架。它能够以二进制形式修改已有类或者动态生成类。ASM 可以直接产生二进制 class 文件，也可以在类被加载入 Java 虚拟机之前动态改变类行为。ASM 从类文件中读入信息后，能够改变类行为，分析类信息，甚至能够根据用户要求生成新类。

不过ASM在创建class字节码的过程中，操纵的级别是底层JVM的汇编指令级别，这要求ASM使用者要对class组织结构和JVM汇编指令有一定的了解。

下面通过ASM 生成下面类Programmer的class字节码：同上

 使用ASM框架提供了ClassWriter 接口，通过访问者模式进行动态创建class字节码，看下面的例子：

package com.dxz.chama.sample;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;

import org.objectweb.asm.ClassWriter;
import org.objectweb.asm.MethodVisitor;
import org.objectweb.asm.Opcodes;

public class MyGenerator {

    public static void main(String[] args) throws IOException {

        System.out.println();
        ClassWriter classWriter = new ClassWriter(0);
        // 通过visit方法确定类的头部信息
        classWriter.visit(Opcodes.V1_7, // java版本
                Opcodes.ACC_PUBLIC, // 类修饰符
                "Programmer", // 类的全限定名
                null, "java/lang/Object", null);

        // 创建构造函数
        MethodVisitor mv = classWriter.visitMethod(Opcodes.ACC_PUBLIC, "<init>", "()V", null, null);
        mv.visitCode();
        mv.visitVarInsn(Opcodes.ALOAD, 0);
        mv.visitMethodInsn(Opcodes.INVOKESPECIAL, "java/lang/Object", "<init>", "()V");
        mv.visitInsn(Opcodes.RETURN);
        mv.visitMaxs(1, 1);
        mv.visitEnd();

        // 定义code方法
        MethodVisitor methodVisitor = classWriter.visitMethod(Opcodes.ACC_PUBLIC, "code", "()V", null, null);
        methodVisitor.visitCode();
        methodVisitor.visitFieldInsn(Opcodes.GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;");
        methodVisitor.visitLdcInsn("I'm a Programmer,Just Coding.....");
        methodVisitor.visitMethodInsn(Opcodes.INVOKEVIRTUAL, "java/io/PrintStream", "println", "(Ljava/lang/String;)V");
        methodVisitor.visitInsn(Opcodes.RETURN);
        methodVisitor.visitMaxs(2, 2);
        methodVisitor.visitEnd();
        classWriter.visitEnd();
        // 使classWriter类已经完成
        // 将classWriter转换成字节数组写到文件里面去
        byte[] data = classWriter.toByteArray();
        File file = new File("D://Programmer.class");
        FileOutputStream fout = new FileOutputStream(file);
        fout.write(data);
        fout.close();
    }
}

 运行下，     上述的代码执行过后，用Java反编译工具（如JD_GUI）打开D盘下生成的Programmer.class，可以看到以下信息：

再用上面我们定义的类加载器将这个class文件加载到内存中，然后 创建class对象，并且实例化一个对象，调用code方法，会看到下面的结果：

以上表明：在代码里生成字节码，并动态地加载成class对象、创建实例是完全可以实现的。

三、Java字节码生成开源框架介绍--Javassist：

Javassist是一个开源的分析、编辑和创建Java字节码的类库。是由东京工业大学的数学和计算机科学系的 Shigeru Chiba （千叶 滋）所创建的。它已加入了开放源代码JBoss 应用服务器项目,通过使用Javassist对字节码操作为JBoss实现动态AOP框架。javassist是jboss的一个子项目，其主要的优点，在于简单，而且快速。直接使用java编码的形式，而不需要了解虚拟机指令，就能动态改变类的结构，或者动态生成类。

下面通过Javassist创建上述的Programmer类：

package com.dxz.chama.sample.javassist;

import javassist.ClassPool;
import javassist.CtClass;
import javassist.CtMethod;
import javassist.CtNewMethod;

public class MyGenerator {
    public static void main(String[] args) throws Exception {
        ClassPool pool = ClassPool.getDefault();
        // 创建Programmer类
        CtClass cc = pool.makeClass("com.dxz.chama.sample.Programmer");
        // 定义code方法
        CtMethod method = CtNewMethod.make("public void code(){}", cc);
        // 插入方法代码
        method.insertBefore("System.out.println("I'm a Programmer,Just Coding by javassist.....");");
        cc.addMethod(method);
        // 保存生成的字节码
        cc.writeFile("d://temp");
    }
}

通过JD-gui反编译工具打开Programmer.class 可以看到以下代码：

 

四、jdk的静态代理的基本构成：

        代理模式上，基本上有Subject角色，RealSubject角色，Proxy角色。其中：Subject角色负责定义RealSubject和Proxy角色应该实现的接口；RealSubject角色用来真正完成业务服务功能；Proxy角色负责将自身的Request请求，调用realsubject 对应的request功能来实现业务功能，自己不真正做业务。

      

上面的这幅代理结构图是典型的静态的代理模式：

当在代码阶段规定这种代理关系，Proxy类通过编译器编译成class文件，当系统运行时，此class已经存在了。这种静态的代理模式固然在访问无法访问的资源，增强现有的接口业务功能方面有很大的优点，但是大量使用这种静态代理，会使我们系统内的类的规模增大，并且不易维护；并且由于Proxy和RealSubject的功能 本质上是相同的，Proxy只是起到了中介的作用，这种代理在系统中的存在，导致系统结构比较臃肿和松散。

       为了解决这个问题，就有了动态地创建Proxy的想法：在运行状态中，需要代理的地方，根据Subject 和RealSubject，动态地创建一个Proxy，用完之后，就会销毁，这样就可以避免了Proxy 角色的class在系统中冗杂的问题了。

下面以一个代理模式实例阐述这一问题：

   将车站的售票服务抽象出一个接口TicketService,包含问询，卖票，退票功能，车站类Station实现了TicketService接口，车票代售点StationProxy则实现了代理角色的功能，类图如下所示。

通过上面动态生成的代码，我们发现，其实现相当地麻烦在创造的过程中，含有太多的业务代码。我们使用上述创建Proxy代理类的方式的初衷是减少系统代码的冗杂度，但是上述做法却增加了在动态创建代理类过程中的复杂度：手动地创建了太多的业务代码，并且封装性也不够，完全不具有可拓展性和通用性。如果某个代理类的一些业务逻辑非常复杂，上述的动态创建代理的方式是非常不可取的！

五、jdk的动态InvocationHandler角色的由来

仔细思考代理模式中的代理Proxy角色。Proxy角色在执行代理业务的时候，无非是在调用真正业务之前或者之后做一些“额外”业务。

六、cglib 生成动态代理类的机制----通过类继承：

       JDK中提供的生成动态代理类的机制有个鲜明的特点是： 某个类必须有实现的接口，而生成的代理类也只能代理某个类接口定义的方法，比如：如果上面例子的ElectricCar实现了继承自两个接口的方法外，另外实现了方法bee() ,则在产生的动态代理类中不会有这个方法了！更极端的情况是：如果某个类没有实现接口，那么这个类就不能同JDK产生动态代理了！

      幸好我们有cglib。“CGLIB（Code Generation Library），是一个强大的，高性能，高质量的Code生成类库，它可以在运行期扩展Java类与实现Java接口。”

cglib 创建某个类A的动态代理类的模式是：

1.   查找A上的所有非final 的public类型的方法定义；
2.    将这些方法的定义转换成字节码；
3.    将组成的字节码转换成相应的代理的class对象；
4.    实现 MethodInterceptor接口，用来处理 对代理类上所有方法的请求（这个接口和JDK动态代理InvocationHandler的功能和角色是一样的）

一个有趣的例子：定义一个Programmer类，一个Hacker类

package com.dxz.chama.sample.cglib;
public class Programmer {  
public void code()  
    {  
        System.out.println("I'm a Programmer,Just Coding by cglib.....");  
    }  
}  

 Hacker类：

package com.dxz.chama.sample.cglib;

import java.lang.reflect.Method;

import net.sf.cglib.proxy.MethodInterceptor;
import net.sf.cglib.proxy.MethodProxy;

/* 
 * 实现了方法拦截器接口 
 */
public class Hacker implements MethodInterceptor {
    @Override
    public Object intercept(Object obj, Method method, Object[] args, MethodProxy proxy) throws Throwable {
        System.out.println("**** I am a hacker,Let's see what the poor programmer is doing Now...");
        proxy.invokeSuper(obj, args);
        System.out.println("****  Oh,what a poor programmer.....");
        return null;
    }

}

test类

package com.dxz.chama.sample.cglib;

import net.sf.cglib.proxy.Enhancer;

public class Test {

    public static void main(String[] args) {
        Programmer progammer = new Programmer();

        Hacker hacker = new Hacker();
        // cglib 中加强器，用来创建动态代理
        Enhancer enhancer = new Enhancer();
        // 设置要创建动态代理的类
        enhancer.setSuperclass(progammer.getClass());
        // 设置回调，这里相当于是对于代理类上所有方法的调用，都会调用CallBack，而Callback则需要实行intercept()方法进行拦截
        enhancer.setCallback(hacker);
        Programmer proxy = (Programmer) enhancer.create();
        proxy.code();

    }
}

程序执行结果：

让我们看看通过cglib生成的class文件内容：

import java.lang.reflect.Method;  
import net.sf.cglib.core.ReflectUtils;  
import net.sf.cglib.core.Signature;  
import net.sf.cglib.proxy.Callback;  
import net.sf.cglib.proxy.Factory;  
import net.sf.cglib.proxy.MethodInterceptor;  
import net.sf.cglib.proxy.MethodProxy;  
  
public class Programmer
fa7aa2cd extends Programmer  
  implements Factory  
{  
   //......省略  
  private MethodInterceptor CGLIB$CALLBACK_0;  // Enchaner传入的methodInterceptor  
   // ....省略  
  public final void code()  
  {  
    MethodInterceptor tmp4_1 = this.CGLIB$CALLBACK_0;  
    if (tmp4_1 == null)  
    {  
      tmp4_1;  
      CGLIB$BIND_CALLBACKS(this);//若callback 不为空，则调用methodInterceptor 的intercept()方法  
    }  
    if (this.CGLIB$CALLBACK_0 != null)  
      return;  
      //如果没有设置callback回调函数，则默认执行父类的方法  
      super.code();  
  }  
   //....后续省略  
}