Java Agent与字节码注入（模拟 arthas trace

基于jdk1.8

Java Agent 有两个重要方法，或者说是两个重要的切入点

1. premain 方法
2. agentmain 方法

之前项目中用到了 Java Agent ，因为 jar 包内代码无法修改，所以采用 premain 切入，首次加载类字节码时候修改了字节码常量表，实现了方法替换。但是一直没有好好总结，下边分享下个人经验。

1. premain 方法

1.1 让 java 虚拟机能识别 agent premain 方法

1.必须打成jar包并添加 MANIFEST.MF文件 需要指定 Premain-class
2.必须存在包含 premain 方法的类
3.必须以（java -javaagent:agent_jar_path[=options] 含有main方法的类）命令行中指定 Java agent jar包启动jvm进程

1.2 首先举个hello world 的例子

public class MyAgent {
   /** initializes agent  在main 方法之前执行*/
    public static void premain(String agentArgs, Instrumentation instP) 
    {
        System.out.println("premain");
    }
    public static void main(String[] args) throws Exception
    {
        System.out.println("hello world");
   }
}

MANIFEST.MF文件

Premain-Class: com.boost.tjvm.agent.MyAgent

执行

java -javaagent:tjvm.jar com.boost.tjvm.agent.MyAgent
premain
hello world

1.3 premain 方法介绍

1. agentArgs即命令中的options，类型为String，因此如果需要多个参数，需要在方法中自己处理；Instrumentation 是运行时由VM自动传入的，此参数非常有用。
2. 有两种类型，同时存在时，优先使用前者。
   public static void premain(String args, Instrumentation inst)
   public static void premain(String args)

2. agentmain 方法

2.1 让 java 虚拟机能识别 agent agentmain 方法

1. 必须打成jar包并添加 MANIFEST.MF文件 需要指定 Agent-Class
2. 必须存在包含 agentmain 方法的类
3. 可以使用 Attach API 远程加载的 Java agent

2.2 首先举个监控方法调用耗时的例子（模拟 arthas trace）

实现步骤:

1. 需要获取被监控jvm的进程id
2. 修改字节码，加入计算执行耗时且打印的逻辑
3. 程序执行完成恢复字节码

被监控jvm类

package com.boost.tjvm.agent;
public class Test extends Thread {
    @Override
    public void run() {
        System.out.println("111");
    }
    public static void main(String[] args) throws Exception {
        Test task = new Test();
        while (true) {
            TimeUnit.SECONDS.sleep(3);
            task.run();
        }
    }
}

java agent 类

package com.boost.tjvm.agent;
public class AttachTest {
    public static void main(String[] args) throws AttachNotSupportedException, IOException, AgentLoadException, AgentInitializationException {
        if (args.length <= 1) {
            System.out.println("Usage: java AttachTest /PATH/TO/AGENT.jar");
            return;
        }
        VirtualMachine vm = VirtualMachine.attach(args[0]);
        //对应agentmain 方法的第一个参数
        vm.loadAgent(args[1],"com.boost.tjvm.agent.Test");
    }
}
package com.boost.tjvm.agent;
public class MyAgent {
    //使用 Attach API 远程加载的 Java agent 不会再先于main方法执行，这取决于另一虚拟机调用 Attach API 的时机。并且，它运行的也不再是premain方法，而是名为agentmain的方法。
    public static void agentmain(String args, Instrumentation inst) throws Exception {
        System.out.println("agentmain");
        Transformer transformer = new Transformer();
        inst.addTransformer(transformer, true);
        inst.retransformClasses(Class.forName(args)); // 修改Task类
        Thread.sleep(20000);
        //在定义了多个 Java agent，多个注入的情况下，我们可能需要移除其中的部分注入。当调用Instrumentation.removeTransformer去除某个注入类后，我们可以调用retransform功能，重新从原始 byte 数组开始进行注入。
        inst.removeTransformer(transformer);
        inst.retransformClasses(Class.forName(args)); // 修改Task类
    }

    private static class Transformer implements ClassFileTransformer {
        //在执行premain或者agentmain方法前，Java 虚拟机早已加载了不少类，而这些类的加载事件并没有被拦截，因此也没有被注入。使用retransform功能可以注入这些已加载但未注入的类。
        public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer) throws IllegalClassFormatException {
            className = className.replaceAll("/", ".");
            System.out.println("transform: " + className);
            ClassPool classPool = ClassPool.getDefault();
            classPool.appendClassPath(new LoaderClassPath(loader)); // 将要修改的类的classpath加入到ClassPool中，否则找不到该类
            try {
                CtClass ctClass = classPool.get(className);
                for (CtMethod ctMethod : ctClass.getDeclaredMethods()) {
                    //非main方法
                    if (Modifier.isPublic(ctMethod.getModifiers()) && !ctMethod.getName().equals("main")) {
                        // 修改字节码
                        ctMethod.addLocalVariable("begin", CtClass.longType);
                        ctMethod.addLocalVariable("end", CtClass.longType);
                        ctMethod.insertBefore("begin = System.currentTimeMillis();");
                        ctMethod.insertAfter("end = System.currentTimeMillis();");
                        ctMethod.insertAfter("System.out.println(\"方法" + ctMethod.getName() + "耗时\"+ (end - begin) +\"ms\");");
                    }
                }
                ctClass.detach();
                return ctClass.toBytecode();
            } catch (Exception e) {
                e.printStackTrace();
            }
            return classfileBuffer;
        }
    }

}

验证步骤:

1. 打包tjvm.jar ， maven 或者 gradle 都可以
2. copy tools.jar javassist-3.28.0-GA.jar 到 Class-Path 目录下：
   tools.jar 是java的工具包，javassist-3.28.0-GA.jar 是修改字节码工具类三方的。
3. 编辑 MANIFEST.MF

 Manifest-Version: 1.0
 Agent-Class: com.boost.tjvm.agent.MyAgent
 Class-Path: tools.jar javassist-3.28.0-GA.jar
 Can-Redefine-Classes: true
 Can-Retransform-Classes: true

//Can-Redefine-Classes 指的是舍弃原本的字节码，并替换成由用户提供的 byte 数组。
//Can-Retransform-Classes 重新调用所有已注册的ClassFileTransformer的transform方法。

4. idea 启动Tast
5. 执行

java -cp tjvm.jar com.boost.tjvm.agent.AttachTest 7764 ./tjvm.jar
Tast 类后台会打印方法执行耗时：

3. 参数 Instrumentation 介绍

1. 提供的主要功能是修改jvm中类的行为

//添加Transformer 修改或查看字节码
addTransformer
//retransform则将针对所传入的类，重新调用所有已注册的ClassFileTransformer的transform方法
retransformClasses(Class.forName(args)); 
//当调用Instrumentation.removeTransformer去除某个注入类后，我们可以调用retransformClasses功能，重新从原始 byte 数组开始进行注入。
removeTransformer(transformer);
//获取jvm中对象占用的空间，此方法也非常有用
getObjectSize(o);

4 总结

1. premain 方法 agentmain 方法区别

premain ：以命令行中指定 Java agent jar包启动jvm进程，执行在mian方法之前
agentmain ：使用 Attach API 远程加载的 Java agent 不会再先于main方法执行，这取决于另一虚拟机调用 Attach API 的时机。

2. Java 虚拟机并不限制 Java agent 的数量。

你可以在 java 命令后附上多个-javaagent参数，或者远程 attach 多个 Java agent，Java 虚拟机会按照定义顺序，或者 attach 的顺序逐个执行这些 Java agent。