字节码增强技术在java中的应用

挚文研究院

java是怎么运行的

我们都知道java是一门解释型语言，大致执行过程如下图所示，首先需要将.java文件编译成字节码文件，然后再通过jvm解释执行，最终运行在对应的操作系统上。这也是java号称一次编译，到处运行的关键。同时我们也能看到，其中的关键是java通过遵循jvm规范而编译出来的字节码文件，它是实际被解释执行的逻辑。

图1

java 字节码文件结构

那么java字节码文件结构是什么样的呢?我们将下图所示的java文件编译之后，会变成如terminal框中所示的字节码文件：一组以8位字节为基础的二进制流，根据jvm规范定义，其中只有两种类型的数据，类型为u1、u2、u4、u8大小分别为1，2，4，8字节的无符号数和以_info结尾的表。字节码文件中的各个数据严格按照下表所示从上到下的顺序紧凑的排列在class文件之中，中间没有任何分隔符。所以如果我们按照jvm规范，在字节码文件的维度上做些功能的变动或者增减，jvm也是可以解释并执行的。

图2

图3

java字节码增强技术

从上图可以看出，即使这么简单的代码，编译出来的字节码文件依旧非常晦涩。虽然我们可以根据规范查表的方式进行解读，但是这无疑非常麻烦，这个时候我们就要想到，有没有已经做出来的字节码解析编辑工具。当然，这肯定有了。现在主流的字节码增强技术大致有以下几种：ASM，Cglib， Javassist，Java Proxy，AspectJ。

由于本篇文章主要是为了讲下字节码增强技术的应用，出于易用性和功能性的考虑，这里使用Javassist技术对字节码增强技术做些介绍。

Javassist

Javassist提供了两种方式的api修改字节码：java源代码层级和字节码层级。而我们选择它来介绍java字节码增强技术，就是因为他的java源代码层级的api，这可以使读者不需要对字节码有多少了解，也一样可以无障碍的阅读代码。

下边是基于Javassist写的一个对上图所示类的一个简单的字节码增强操作，实现了在调用test方法前后各打印一行数据

package com.tantan.demo;
import javassist.*;

public class DoAop {
    public static void main(String[] args) {        // 获取Ctclass容器        ClassPool pool = ClassPool.getDefault();        try {            // 从容器中根据Demo类的全限定名，获取CtClass对象            CtClass ct = pool.get("com.tantan.demo.Demo");            // 获取Demo的test方法            CtMethod cm = ct.getDeclaredMethod("test");            // 给Demo类加一个int类型的c字段            ct.addField(new CtField(CtClass.intType,"c",ct));           // 在test方法插入一行代码, {}在只有一行代码的时候可以不添加，如果插入多行代码，那么每一行前后都要{}            cm.insertBefore("{ System.out.println(\"method begin\");}");            // 在test方法后边插入一行代码            cm.insertAfter("{ System.out.println(\"method end\");}");            // 把修改后的类写入class文件            ct.writeFile("/Users/demo/projects/java/test/src/main/java/");        } catch (Exception e) {            e.printStackTrace();        }
    }}

上边代码有几个主要的类介绍一下ClassPool，CtClass，CtField

ClassPool：可以简单理解为存放类的pool，所有CtClass都要从pool中获取；
CtClass：表示一个类文件，可以通过一个类的全限定名来获取一个CtClass，并对他做些操作；
CtMethod：对应的类中的方法，可以通过CtClass获取编辑指定方法；
CtField：对应类中的属性，可以通过CtClass获取编辑指定属性；

下面两个图从左到右分别是从字节码查看工具看到的进行字节码增强前后的字节码文件，可以明显看到，修改后的class文件多了一个int类型的字段，并且在test方法开始结束都进行了打印。

图4

图5

字节码增强和jvm的结合-java agent

一般情况下，一个类加载到jvm之后，就不能再修改了，否则就会报class name重复错误。在这种情况下，我们的字节码增强技术就只能在编译前对字节码文件修改，这无疑少了很多使用场景。所以我们需要一个钥匙，也就是 java agent技术，它可以帮我们打开运行时jvm关闭的大门。

agent使用的时候需要打包成jar包，里边必须需要一个META-INF文件夹，里边需要有一个MANIFEST.MF文件，这是agent的入口

Manifest-Version: 1.0Implementation-Title: demoImplementation-Version: 1.0Premain-Class: com.tantan.demo.Agent Agent-Class: com.tantan.demo.Agent

这个文件中最重要的是Premain-Class和Agent-Class这两个属性，它们告诉了jvm premain和agentmain的入口函数在哪

premain：作用于JVM加载的所有类，所有类首次加载并且进入程序main()方法之前，premain方法会被激活，然后所有被加载的类都会执行ClassFileTransformer列表中的回调。
agentmain：采用attach机制，需要借助Instrumentation#retransformClasses(Class< ?>… classes)让对应的类重新转换，激活重新转换的类执行ClassFileTransformer列表中的回调。

这样通过java agent这个通道，我们就可以对jvm做很多事了，比如无侵入的代码监控（如sky working），动态修改正在运行的服务代码（如 Arthas），还有java软件的逆向破解等等，下边我就用一个无侵入代码统计耗时的例子，来将上述功能串起来。

应用示例

目录结构如下图所示

图6

首先是MANIFEST.MF文件，内容如下图所示，指定了Premain-Class入口类com.tantan.agent.TimeAgent

Manifest-Version: 1.0Implementation-Title: demoImplementation-Version: 1.0Premain-Class: com.tantan.agent.TimeAgent

其次是TimeAgent类，

package com.tantan.agent;
import com.tantan.agent.service.TimeAgentService;
import java.lang.instrument.Instrumentation;
public class TimeAgent {


   public static void premain(String args, Instrumentation inst){       // 添加transformer       inst.addTransformer(new TimeAgentService());   }
}

再就是TimeAgentService：

继承ClassFileTransformer实现了transform接口
这里传的className是/拼接的，需要做下转换，转成xx.xx的全限定类名
然后做些自己的逻辑，我这里是做了个判断，使用javassist只对com.tantanapp.demo.controller.WorkController类的testSend方法做一个字节码增强，当然你也可以通过ctClass和获取他的类的所有方法做增强，亦或者对所有类的所有方法做增强，也可以自定义一个规则。
将修改后的ct class返回

package com.tantan.agent.service;
import javassist.ClassPool;import javassist.CtClass;import javassist.CtMethod;
import java.lang.instrument.ClassFileTransformer;import java.lang.instrument.IllegalClassFormatException;import java.security.ProtectionDomain;
public class TimeAgentService implements ClassFileTransformer {



    // 返回修改后的字节码    public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer) throws IllegalClassFormatException {
//        className =  className.replace("/",".");
        if (className.equals("com.tantanapp.demo.controller.WorkController")) {            try {                CtClass ctClass = ClassPool.getDefault().getCtClass(className);                CtMethod ctmethod = ctClass.getDeclaredMethod("testSend");                addTimeAop(ctmethod);                return ctClass.toBytecode();            } catch (Exception e) {                e.printStackTrace();            }
        }
        return null;    }

    private void addTimeAop(CtMethod method) throws Exception {        method.addLocalVariable("start",CtClass.longType);        method.addLocalVariable("name",ClassPool.getDefault().get("java.lang.String"));        method.insertBefore("start = System.currentTimeMillis();");        method.insertBefore("name =\""+method.getLongName()+"\";");        method.insertAfter("System.out.println(name+\"----time cost:\"+(System.currentTimeMillis()-start));");    }

}

pom文件:主要是用了maven-shade-plugin和maven-jar-plugin插件，将项目打包成符合agent规范的jar包

<?xml version="1.0" encoding="UTF-8"?><project xmlns="http://maven.apache.org/POM/4.0.0"         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">    <modelVersion>4.0.0</modelVersion>
    <groupId>com.tantan</groupId>    <artifactId>demo</artifactId>    <version>1.0-SNAPSHOT</version>
    <properties>        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>        <maven.compiler.source>1.8</maven.compiler.source>        <maven.compiler.target>1.8</maven.compiler.target>    </properties>

    <dependencies>        <dependency>            <groupId>org.javassist</groupId>            <artifactId>javassist</artifactId>            <version>3.25.0-GA</version>        </dependency>    </dependencies>
    <build>        <finalName>demo</finalName>        <plugins>            <plugin>                <groupId>org.apache.maven.plugins</groupId>                <artifactId>maven-compiler-plugin</artifactId>                <configuration>                    <source>1.8</source>                    <target>1.8</target>                    <compilerArguments>                        <verbose/>                    </compilerArguments>                </configuration>            </plugin>
            <plugin>                <groupId>org.apache.maven.plugins</groupId>                <artifactId>maven-jar-plugin</artifactId>                <configuration>                    <archive>                        <manifestFile>src/main/resources/META-INF/MANIFEST.MF</manifestFile>                    </archive>                </configuration>            </plugin>
            <plugin>                <groupId>org.apache.maven.plugins</groupId>                <artifactId>maven-shade-plugin</artifactId>                <version>2.3</version>                <executions>                    <execution>                        <phase>package</phase>                        <goals>                            <goal>shade</goal>                        </goals>                    </execution>                </executions>            </plugin>        </plugins>    </build>

</project>

编译打包之后，会生成一个demo.jar
然后我们这边还有一个web服务的一个controller，也就是上边代码中写的com.tantanapp.demo.controller.WorkController这个类

看图可以知道，有一个testSend方法，代码逻辑就是sleep 100ms，那么启动测试下吧

图7

启动命令 java -javaagent:/Users/demo/projects/java/demo/target/demo.jar -jar worker-api.jar

然后curl 几次 localhost:21002/data ,可以看到控制台打印了这么几行日志，也就是我们无侵入的耗时统计实现了！

图8

继续滑动看下一个