200316-手把手教你实现一个方法耗时统计的java agent

文章目录

1. 基本姿势点
II. 其他

前面有两篇铺垫博文，在博文《200303-如何优雅的在java中统计代码块耗时》，其最后提到了根据利用java agent来统计方法耗时

博文《200316-IDEA + maven零基础构建java agent项目中则详细描述了搭建一个java agent开发测试项目的全过程

本篇博文将进入java agent的实战，手把手教你如何是实现一个统计方法耗时的java agent

1. 基本姿势点

上面两节虽然手把手教你实现了一个hello world版agent，然而实际上对java agent依然是一脸茫然，所以我们得先补齐一下基础知识

首先来看agent的两个方法中的参数 Instrumentation，我们先看一下它的接口定义

/**
 * 注册一个Transformer，从此之后的类加载都会被Transformer拦截。
 * Transformer可以直接对类的字节码byte[]进行修改
 */
void addTransformer(ClassFileTransformer transformer);

/**
 * 对JVM已经加载的类重新触发类加载。使用的就是上面注册的Transformer。
 * retransformation可以修改方法体，但是不能变更方法签名、增加和删除方法/类的成员属性
 */
void retransformClasses(Class<?>... classes) throws UnmodifiableClassException;

/**
 * 获取一个对象的大小
 */
long getObjectSize(Object objectToSize);

/**
 * 将一个jar加入到bootstrap classloader的 classpath里
 */
void appendToBootstrapClassLoaderSearch(JarFile jarfile);

/**
 * 获取当前被JVM加载的所有类对象
 */
Class[] getAllLoadedClasses();

前面两个方法比较重要，addTransformer方法配置之后，后续的类加载都会被Transformer拦截。对于已经加载过的类，可以执行retransformClasses来重新触发这个Transformer的拦截。类加载的字节码被修改后，除非再次被retransform，否则不会恢复。

通过上面的描述，可知

可以通过Transformer修改类
类加载时，会被触发Transformer拦截

2. 实现

我们需要统计方法耗时，所以想到的就是在方法的执行前，记录一个时间，执行完之后统计一下时间差，即为耗时

直接修改字节码有点麻烦，因此我们借助神器javaassist来修改字节码

实现自定义的ClassFileTransformer，代码如下

public class CostTransformer implements ClassFileTransformer {
    @Override
    public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined,
            ProtectionDomain protectionDomain, byte[] classfileBuffer) {
        // 这里我们限制下，只针对目标包下进行耗时统计
        if (!className.startsWith("com/git/hui/java/")) {
            return classfileBuffer;
        }

        CtClass cl = null;
        try {
            ClassPool classPool = ClassPool.getDefault();
            cl = classPool.makeClass(new ByteArrayInputStream(classfileBuffer));

            for (CtMethod method : cl.getDeclaredMethods()) {
                // 所有方法，统计耗时；请注意，需要通过`addLocalVariable`来声明局部变量
                method.addLocalVariable("start", CtClass.longType);
                method.insertBefore("start = System.currentTimeMillis();");
                String methodName = method.getLongName();
                method.insertAfter("System.out.println(\"" + methodName + " cost: \" + (System" +
                        ".currentTimeMillis() - start));");
            }

            byte[] transformed = cl.toBytecode();
            return transformed;
        } catch (Exception e) {
            e.printStackTrace();
        }
        return classfileBuffer;
    }
}

然后稍微改一下agent

/**
 * Created by @author yihui in 16:39 20/3/15.
 */
public class SimpleAgent {

    /**
     * jvm 参数形式启动，运行此方法
     *
     * manifest需要配置属性Premain-Class
     *
     * @param agentArgs
     * @param inst
     */
    public static void premain(String agentArgs, Instrumentation inst) {
        System.out.println("premain");
        customLogic(inst);
    }

    /**
     * 动态 attach 方式启动，运行此方法
     *
     * manifest需要配置属性Agent-Class
     *
     * @param agentArgs
     * @param inst
     */
    public static void agentmain(String agentArgs, Instrumentation inst) {
        System.out.println("agentmain");
        customLogic(inst);
    }

    /**
     * 统计方法耗时
     *
     * @param inst
     */
    private static void customLogic(Instrumentation inst) {
        inst.addTransformer(new CostTransformer(), true);
    }
}

到此agent完毕，打包和上面的过程一样，接下来进入测试环节

创建一个DemoClz，里面两个方法

public class DemoClz {

    public int print(int i) {
        System.out.println("i: " + i);
        try {
            Thread.sleep(1000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        return i + 2;
    }

    public int count(int i) {
        System.out.println("cnt: " + i);
        try {
            Thread.sleep(50);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        return i + 1;
    }
}

然后对应的main方法如下

public class BaseMain {
    public static void main(String[] args) throws InterruptedException {
        DemoClz demoClz = new DemoClz();
        int cnt = 0;
        for (int i = 0; i < 20; i++) {
            if (++cnt % 2 == 0) {
                i = demoClz.print(i);
            } else {
                i = demoClz.count(i);
            }
        }
    }
}

选择jvm参数指定agent方式运行（具体操作和上面一样），输出如下

虽然我们的应用程序中并没有方法的耗时统计，但是最终的输出却完美的打印了每个方法的调用耗时，实现了无侵入的耗时统计功能

到这里本文的java agent的扫盲 + 实战（开发一个方法耗时统计）都已经完成了，是否就宣告着可以小结了，并不是，下面介绍一下在实现上面的demo过程中遇到的一个问题

3. Exception in thread “main” java.lang.VerifyError: Expecting a stack map frame

在演示方法耗时的agent的示例中，并没有借助最开始的测试用例，而是新建了一个DemoClz来做的，那么为什么这样选择呢，如果直接用第二节的测试用例会怎样呢？

public class BaseMain {
    public int print(int i) {
        System.out.println("i: " + i);
        try {
            Thread.sleep(1000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        return i + 2;
    }

    public void run() {
        int i = 1;
        while (true) {
            i = print(i);
        }
    }

    public static void main(String[] args) {
        BaseMain main = new BaseMain();
        main.run();
}