Java字节码2-instrument初体验

一、概述
在上一节中Java字节码1-Agent简单上手中，我们了解了通过一个Agent可以在main方法前执行。 
本节中，我们将介绍java.lang.instrument，通过instrument可以实现一个Agent来修改类的字节码。下面我们会借助javassist实现一个简单的性能检测工具。目的是检测函数的调用耗时，这里仅仅抛砖引玉，instrument提供的更松耦合的AOP不止于此。

二、实现一个函数检测耗时Agent
1、修改pom.xml
这里与上一节不同的是，我们需要额外引入javassist包来增强Agent。

<dependency>
    <groupId>javassist</groupId>
    <artifactId>javassist</artifactId>              
    <version>3.12.1.GA</version>
    <type>jar</type>
 </dependency>

除此之外，我们还需要将此Jar包打包到Agent中，见如下配置：

<plugin> 
  <groupId>org.apache.maven.plugins</groupId>  
  <artifactId>maven-shade-plugin</artifactId>  
  <executions> 
    <execution> 
      <phase>package</phase>  
      <goals> 
        <goal>shade</goal> 
      </goals> 
    </execution> 
  </executions>  
  <configuration> 
    <artifactSet> 
      <includes> 
        <include>javassist:javassist:jar:</include> 
      </includes> 
    </artifactSet> 
  </configuration> 
</plugin>

2、实现一个Agent
public class MyAgent {

    public static void premain(String agentArgs, Instrumentation inst) {
        System.out.println("this is an perform monitor agent.");
        // 添加 Transformer
        ClassFileTransformer transformer = new PerformMonitorTransformer();
        inst.addTransformer(transformer);
    }
}

与上一节不同的是，这里添加了一个Transformer。

3、实现一个Transformer类
public class PerformMonitorTransformer implements ClassFileTransformer {

    private static final Set<String> classNameSet = new HashSet<>();
    static {
        classNameSet.add("com.example.demo.AgentTest");
    }

    @Override
    public byte[] transform(ClassLoader loader,
                            String className,
                            Class<?> classBeingRedefined,
                            ProtectionDomain protectionDomain,
                            byte[] classfileBuffer) throws IllegalClassFormatException {
        try {
            String currentClassName = className.replaceAll("/", ".");
            if (!classNameSet.contains(currentClassName)) { // 仅仅提升Set中含有的类
                return null;
            }
            System.out.println("transform: [" + currentClassName + "]");

            CtClass ctClass = ClassPool.getDefault().get(currentClassName);
            CtBehavior[] methods = ctClass.getDeclaredBehaviors();
            for (CtBehavior method : methods) {
                enhanceMethod(method);
            }
            return ctClass.toBytecode();
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }

    private void enhanceMethod(CtBehavior method) throws Exception {
        if (method.isEmpty()) {
            return;
        }
        String methodName = method.getName();
        if (methodName.equalsIgnoreCase("main")) { // 不提升main方法
            return;
        }

        final StringBuilder source = new StringBuilder();
        source.append("{")
                    .append("long start = System.nanoTime();\n") // 前置增强: 打入时间戳
                    .append("$_ = $proceed($$);\n") // 保留原有的代码处理逻辑
                    .append("System.out.print(\"method:[" + methodName + "]\");").append("\n")
                    .append("System.out.println(\" cost:[\" +(System.nanoTime() -start)+ \"ns]\");") // 后置增强
                .append("}");

        ExprEditor editor = new ExprEditor() {
          @Override
          public void edit(MethodCall methodCall) throws CannotCompileException {
              methodCall.replace(source.toString());
          }
        };
        method.instrument(editor);
    }
}

上面的代码中，我们增强了Set中保存的类的方法，这里是“com.example.demo.AgentTest”，如果是其他类需重新设置或将此处配置到文件中。

通过enhanceMethod方法， 重新写了其方法的字节码，即对原有的方法体进行了环绕增强。

三、运行
与上一节中的运行方式相同，为了体现本节的内容，我们修改了Test类增加了两个方法：

public class AgentTest {

    private void fun1() {
        System.out.println("this is fun 1.");
    }

    private void fun2() {
        System.out.println("this is fun 2.");
    }

    public static void main(String[] args) {
        AgentTest test = new AgentTest();
        test.fun1();
        test.fun2();
    }
}

运行结果如下：

this is an perform monitor agent.
transform: [com.example.demo.AgentTest]
this is fun 1.
method:[fun1] cost:[79024ns]
this is fun 2.
method:[fun2] cost:[41164ns]

Process finished with exit code 0

从上面的运行结果可以看到，我们对调用的两个方法进行了增强，得到了其调用耗时。