Java字节码增强技术Bytebuddy探路篇

￡神魔★判官ぃ 2023-10-01 22:32 32阅读 0赞

*  2. Java字节码增强支持
 *  4. Java字节码增强类库 - ASM
 *  5. Java字节码增强类库 - Javassist
 *  6. Java字节码增强工具/类库 - ByteBuddy
 *  7. Java字节码增强工具对比和关系图
    
     *  7.1 Java字节码增强工具对比
     *  7.2 Java字节码增强工具关系图

最近为了实现Java应用RPC调用的录制和Mock回放，需要以无侵入方式获取到RPC方法的出入参数和返回响应消息等数据，于是踏上了Java字节码增强技术的道路摸索，这个非常类似Trace所使用的相关技术，不过需要深入到RPC方法级别，对指定方法进行无侵入方式切面处理。先后对ASM/Javaassist/Bytebuddy等技术进行了调研等，本文是对所做摸索探路工作的总结，若读者有类似Trace场景需求，可以进行借鉴参考。

在众多比较之后最后选择的是Bytebuddy技术。

### 1. Java字节码简介 ###

Java字节码是众多字节码增强技术的知识基础。Java语言写出的源代码首先需要编译成class文件，即字节码文件，然后被JVM加载并运行，每个 [class文件][class] 具有如下固定的数据格式，

ClassFile {
        u4             magic;           // 魔数，固定为0xCAFEBABE
        u2             minor_version;   // 次版本
        u2             major_version;   // 主版本，常见版本：52对应1.8，51对应1.7，其他依次类推
        u2             constant_pool_count;                     // 常量池个数
        cp_info        constant_pool[constant_pool_count-1];    // 常量池定义
        u2             access_flags;    // 访问标志：ACC_PUBLIC, ACC_INTERFACE, ACC_ABSTRACT等
        u2             this_class;      // 类索引
        u2             super_class;     // 父类索引
        u2             interfaces_count;
        u2             interfaces[interfaces_count];
        u2             fields_count;
        field_info     fields[fields_count];
        u2             methods_count;
        method_info    methods[methods_count];
        u2             attributes_count;
        attribute_info attributes[attributes_count];
    }

可以看到，class文件总是一个魔数开头，后面跟着版本号，然后就是常量定义、访问标志、类索引、父类索引、接口个数和索引表、字段个数和索引表、方法个数和索引表、属性个数和索引表。

class文件本质上是一个字节码流，每个字节码所处的位置代表着一定的指令和含义。如何对class文件中定义的指令和字节码进行解读、增强定义、编排，这是字节码增强技术所要完成的事情。

了解Java字节码有助于字节码增强的开发，但并不是实现字节码增强开发的必要条件，最新主流的众多字节码增强工具框架类库都将字节码的编排进行了不同程度封装，在可读性、易编排性、排错性上提供开发便利性，学习曲线和开发难度得到了较好的改善。

### 2. Java字节码增强支持 ###

对于字节码增强的开发来说，JVMTI是一个在实践中应该被熟悉的工具技术。JVM从1.5版本开始提供 [JVM Tool Interface][] ，这是JVM对外的、用于Java应用监控和调试的一系列工具接口，是JVM平台调试架构的重要组成部分。

下图是 [JVM平台调试架构图][JVM] ，

The Java™ Platform Debugger Architecture is structured as follows:
               Components                          Debugger Interfaces
    
                    /    |--------------|
                   /     |     VM       |
     debuggee ----(      |--------------|  <------- JVM TI - Java VM Tool Interface（Jvm服务端调试接口）
                   \     |   back-end   |
                    \    |--------------|
                    /           |
     comm channel -(            |  <--------------- JDWP - Java Debug Wire Protocol （Java调试通信协议）
                    \           |
                         |--------------|
                         | front-end    |
                         |--------------|  <------- JDI - Java Debug Interface （客户端调试接口和调试应用）
                         |      UI      |
                         |--------------|

JVM启动支持加载agent代理，而agent代理本身就是一个JVM TI的客户端，其通过监听事件的方式获取Java应用运行状态，调用JVM TI提供的接口对应用进行控制。

我们可以看下Java agent代理的两个入口函数定义，

// 用于JVM刚启动时调用，其执行时应用类文件还未加载到JVM
    public static void premain(String agentArgs, Instrumentation inst);
    
    // 用于JVM启动后，在运行时刻加载
    public static void agentmain(String agentArgs, Instrumentation inst);

这两个入口函数定义分别对应于JVM TI专门提供了执行 [字节码增强（bytecode instrumentation）][bytecode instrumentation] 的两个接口。

*  加载时刻增强，类字节码文件在JVM加载的时候进行增强，。
 *  动态增强，已经被JVM加载的class字节码文件，当被修改或更新时进行增强，从JDK 1.6开始支持。

这两个接口都是从JDK 1.6开始支持。

我们无需对上面JVM TI提供的两个接口规范了解太多，Java Agent和 [Java Instrument类包][Java Instrument] 封装好了字节码增强的上述接口通信。我们需要了解的是，上述入口函数传入的第二个参数Instrumentation实例，即Java Instrument类 [java.lang.instrument.Instrumentation][] ，查看其类定义，可以看到其提供的核心方法只有一个addTransformer，用于添加多个ClassFileTransformer，

// 说明：添加ClassFileTransformer
    // 第一个参数：transformer，类转换器
    // 第二个参数：canRetransform，经过transformer转换过的类是否允许再次转换
    void Instrumentation.addTransformer(ClassFileTransformer transformer, boolean canRetransform)

而 [ClassFileTransformer][] 则提供了tranform()方法，用于对加载的类进行增强重定义，返回新的类字节码流。需要特别注意的是，若不进行任何增强，当前方法返回null即可，若需要增强转换，则需要先拷贝一份classfileBuffer，在拷贝上进行增强转换，然后返回拷贝。

// 说明：对类字节码进行增强，返回新的类字节码定义
    // 第一个参数：loader，类加载器
    // 第二个参数：className，内部定义的类全路径
    // 第三个参数：classBeingRedefined，待重定义/转换的类
    // 第四个参数：protectionDomain，保护域
    // 第五个参数：classfileBuffer，待重定义/转换的类字节码（不要直接在这个classfileBuffer对象上修改，需拷贝后进行）
    // 注：若不进行任何增强，当前方法返回null即可，若需要增强转换，则需要先拷贝一份classfileBuffer，在拷贝上进行增强转换，然后返回拷贝。
    byte[] ClassFileTransformer.transform(ClassLoader loader, String className, Class classBeingRedefined, ProtectionDomain protectionDomain, byte classfileBuffer)

下面简单的演示样例，通过Java agent打印出JVM加载的类列表，

1.  下载演示代码，见 [这里][Link 1] 。
2.  编译项目 mvn clean package
3.  运行命令

java -javaagent:./demo-agent/target/agent-agent.jar -jar ./demo-app/target/demo-app.jar

1.  可以通过控制台查看所有JVM加载的类列表。

loading agent..
    agent has been loaded.
    transforming class = java/lang/invoke/MethodHandleImpl
    transforming class = java/lang/invoke/MethodHandleImpl$1
    transforming class = java/lang/invoke/MethodHandleImpl$2
    transforming class = java/util/function/Function
    transforming class = java/lang/invoke/MethodHandleImpl$3
    transforming class = java/lang/invoke/MethodHandleImpl$4
    transforming class = java/lang/ClassValue

### 3. 演示类 ###

为了方便展示不同字节码增强技术，下面将以Greeting类为例，对sayHello()方法进行加强。

public class Greeting {
    
        public String sayHello() {
            String hello = "hello,world";
            System.out.println(hello);
            return hello;
        }
    
    }

分别在sayHello函数执行前后添加打印语句，输出如下类似信息。

begin of sayhello().
    hello,world
    end of sayhello().

为了能够检查增强后的类，建议使用 [arthas][] 调试工具，

jad  com.pphh.demo.api.Greeting

通过jad命令，对Greeting类进行反编译，以了解字节码增强后的类定义。

### 4. Java字节码增强类库 - ASM ###

[ASM][] 是一个Java字节码解析和操作框架，整个类包非常小，还不到120KB，但其非常注重对类字节码的操作速度，这种高性能来自于它的设计模式 - 访问者模式，即通

过Reader、Visitor和Writer模式。

ASM是直接操作类字节码数据，因此其读写的是字节码指令，比如，

mv.visitFieldInsn(GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;");
    mv.visitLdcInsn("begin of sayhello().");
    mv.visitMethodInsn(INVOKEVIRTUAL, "java/io/PrintStream", "println", "(Ljava/lang/String;)V", false);

这种指令比较晦涩难懂，在实际操作过程中，会先将期望的类源码文件写好，编译后查看字节码文件，然后复制相关字节码指令。

演示代码

1. 下载演示代码，见 [这里][Link 1] 。

2. 编译项目 mvn clean package

3. 运行命令

java -javaagent:./demo-asm/target/agent-asm.jar -jar ./demo-app/target/demo-app.jar

1.  可以通过控制台查看日志。

### 5. Java字节码增强类库 - Javassist ###

[Javassist][] 是一个非常早的字节码操作类库，开始于1999年，它能够支持两种编辑方式：源码级别和字节码指令级别，相比于晦涩的字节码级别，源码级别更加人性化，代码编写起来更加易懂。

以上面的ASM字节码指令编辑为例，换成对应的Javassist源码级别编辑方式，如下所示，

CtMethod m = cc.getDeclaredMethod("sayHello");
    m.insertBefore("{ System.out.println(\"begin of sayhello()\"); }");

相信大多数程序员更愿意接受源码级别编辑方式，翻译成直接码指令的工作就交给Javassist完成，目前源码级别方式Javassist只支持Java语言语法。

演示代码

1. 下载演示代码，见 [这里][Link 1] 。

2. 编译项目 mvn clean package

3. 运行命令

java -javaagent:./demo-javaassist/target/agent-jassist.jar -jar ./demo-app/target/demo-app.jar

1.  可以通过控制台查看日志。

### 6. Java字节码增强工具/类库 - ByteBuddy ###

[ByteBuddy][] 是一个基于ASM的字节码增强框架，开始于2014年，相比其它字节码操作类库而言，其诞生的时间则年轻得多，所以ButeBuddy API在设计之初上就吸收了业界其它字节码工具类库的优点，提供了丰富灵活的API接口，可以快速创建新类、继承已有类、动态重构类。

如下是几个简单代码样例如下，

// 创建一个com.pphh.demo.Sample类，继承于Object.class
    DynamicType.Unloaded dynamicType = new ByteBuddy()
      .subclass(Object.class)
      .name("com.pphh.demo.Sample")
      .make();
    
    // 创建一个新类，继承于Foo.class
    new ByteBuddy().subclass(Foo.class)
    
    // 重构类Foo.class
    new ByteBuddy().redefine(Foo.class)
    
    // 重设定Foo.class（保留原先类的方法定义，基于原先定义进行扩展）
    new ByteBuddy().rebase(Foo.class)

和Javassist比起来，它不再是一个Java源码的文本填充工具，而是让开发能够以代码开发的方式增强类，能够有编译级别的纠错。在下面的例子中，

public Object intercept(@This Object obj,
                                @AllArguments Object[] allArguments,
                                @SuperCall Callable zuper,
                                @Origin Method method) throws Throwable {
            System.out.println("begin of sayHello()");
            Object result = zuper.call();
            System.out.println("end of sayHello()");
            return result;
        }

同样地写System.out.println，若不小心写错了，如上方式是可以在编译时刻得到提醒的，这个和Javassist比起来好很多。

演示代码

1. 下载演示代码，见 [这里][Link 1] 。

2. 编译项目 mvn clean package

3. 运行命令

java -javaagent:./demo-bytebuddy/target/agent-buddy.jar -jar ./demo-app/target/demo-app.jar

1.  可以通过控制台查看日志。

### 7. Java字节码增强工具对比和关系图 ###

#### 7.1 Java字节码增强工具对比 ####

<table> 
 <thead> 
  <tr> 
   <th>对比</th> 
   <th>ASM</th> 
   <th>Javassist</th> 
   <th>JDK Proxy</th> 
   <th>Cglib</th> 
   <th>ByteBuddy</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>起源时间</td> 
   <td>2002</td> 
   <td>1999</td> 
   <td>2000</td> 
   <td>2011</td> 
   <td>2014</td> 
  </tr> 
  <tr> 
   <td>包大小</td> 
   <td>130KB<br> （版本9.3）</td> 
   <td>788KB<br> （版本3.28.0-GA）</td> 
   <td></td> 
   <td></td> 
   <td>3.7MB<br> （版本1.10.19）</td> 
  </tr> 
  <tr> 
   <td>增强方式</td> 
   <td>字节码指令</td> 
   <td>字节码指令和源码（注：源码文本）</td> 
   <td>源码</td> 
   <td>源码</td> 
   <td>源码</td> 
  </tr> 
  <tr> 
   <td>源码编译</td> 
   <td>NA</td> 
   <td>不支持</td> 
   <td>支持</td> 
   <td>支持</td> 
   <td>支持</td> 
  </tr> 
  <tr> 
   <td>agent支持</td> 
   <td>支持</td> 
   <td>支持</td> 
   <td>不支持，依赖框架</td> 
   <td>不支持，依赖框架</td> 
   <td>支持</td> 
  </tr> 
  <tr> 
   <td>性能</td> 
   <td>高</td> 
   <td>中</td> 
   <td>低</td> 
   <td>中</td> 
   <td>中</td> 
  </tr> 
  <tr> 
   <td>维护状态</td> 
   <td>是</td> 
   <td>是</td> 
   <td>停止升级</td> 
   <td><a href="https://github.com/cglib/cglib" title="停止维护" rel="nofollow">停止维护</a></td> 
   <td>活跃</td> 
  </tr> 
  <tr> 
   <td>优点</td> 
   <td>超高性能，应用场景广泛</td> 
   <td>同时支持字节码指令和源码两种增强方式</td> 
   <td>JDK原生类库支持</td> 
   <td></td> 
   <td>零侵入，提供良好的API扩展编程</td> 
  </tr> 
  <tr> 
   <td>缺点</td> 
   <td>字节码指令对应用开发者不友好</td> 
   <td></td> 
   <td>场景非常局限，只适用于Java接口</td> 
   <td>已经不再维护，对于新版JDK17+支持不好，官网建议切换到ByteBuddy</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>应用场景</td> 
   <td>小，高性能，广泛用于语言级别</td> 
   <td></td> 
   <td></td> 
   <td>广泛用于框架场景</td> 
   <td>广泛用于Trace场景</td> 
  </tr> 
 </tbody> 
</table>

注：相关性能数据来自 [这里][Link 2]

综合了上述的字节码增强工具对比，比较了开发便利性和需求目标，我们最后选择了ByteBuddy来实现Trace跟踪技术。

#### 7.2 Java字节码增强工具关系图 ####

![3975ae6f69657a6f6ae6077f3a9bd216.png][]

需要提一下，JDK Proxy和Cglib也是以代码方式进行类方法的切面增强，但它们都是以框架的方式实现了Java类的动态扩展，主要应用在框架级别的字节码增强，在某种程度上JDK Proxy和Cglib技术对应用是有代码侵入的，这里的侵入不仅仅是框架代码侵入，而且包括增强的类中依赖JDK Proxy和Cglib类。与此相比，ButeBuddy API是以无侵入方式加强类代码，设计理念更优。

![c4833e38fde94566935be3ae62309913.jpeg][]

[class]: https://docs.oracle.com/javase/specs/jvms/se8/html/jvms-4.html
[JVM Tool Interface]: https://docs.oracle.com/javase/8/docs/platform/jvmti/jvmti.html#whatIs
[JVM]: https://docs.oracle.com/javase/7/docs/technotes/guides/jpda/architecture.html
[bytecode instrumentation]: https://docs.oracle.com/javase/6/docs/platform/jvmti/jvmti.html#bci
[Java Instrument]: https://docs.oracle.com/javase/8/docs/api/java/lang/instrument/package-summary.html
[java.lang.instrument.Instrumentation]: https://docs.oracle.com/javase/8/docs/api/java/lang/instrument/Instrumentation.html
[ClassFileTransformer]: https://docs.oracle.com/javase/8/docs/api/java/lang/instrument/ClassFileTransformer.html
[Link 1]: https://gitee.com/pphh/simple-demo/tree/master/demo-bytecode-instrument
[arthas]: https://arthas.aliyun.com/
[ASM]: https://asm.ow2.io/index.html
[Javassist]: https://www.javassist.org/
[ByteBuddy]: https://bytebuddy.net/#/
[Link 2]: https://bytebuddy.net/#/tutorial
[3975ae6f69657a6f6ae6077f3a9bd216.png]: https://img-blog.csdnimg.cn/img_convert/3975ae6f69657a6f6ae6077f3a9bd216.png
[c4833e38fde94566935be3ae62309913.jpeg]: https://img-blog.csdnimg.cn/c4833e38fde94566935be3ae62309913.jpeg