Java Agent與字節(jié)碼注入（模擬 arthas trace)

基于jdk1.8

Java Agent 有兩個(gè)重要方法，或者說是兩個(gè)重要的切入點(diǎn)

  1. premain 方法
  2. agentmain 方法

之前項(xiàng)目中用到了 Java Agent ，因?yàn)?jar 包內(nèi)代碼無法修改，所以采用 premain 切入，首次加載類字節(jié)碼時(shí)候修改了字節(jié)碼常量表，實(shí)現(xiàn)了方法替換。但是一直沒有好好總結(jié)，下邊分享下個(gè)人經(jīng)驗(yàn)。

1. premain 方法

1.1 讓 java 虛擬機(jī)能識(shí)別 agent premain 方法

1.必須打成jar包并添加 MANIFEST.MF文件 需要指定 Premain-class
2.必須存在包含 premain 方法的類
3.必須以（java -javaagent:agent_jar_path[=options] 含有main方法的類）命令行中指定 Java agent jar包啟動(dòng)jvm進(jìn)程

1.2 首先舉個(gè)hello world 的例子
public class MyAgent {
   /** initializes agent  在main 方法之前執(zhí)行*/
    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

執(zhí)行

java -javaagent:tjvm.jar com.boost.tjvm.agent.MyAgent
premain
hello world
1.3 premain 方法介紹
  1. agentArgs即命令中的options，類型為String，因此如果需要多個(gè)參數(shù)，需要在方法中自己處理；Instrumentation 是運(yùn)行時(shí)由VM自動(dòng)傳入的，此參數(shù)非常有用。
  2. 有兩種類型，同時(shí)存在時(shí)，優(yōu)先使用前者。
    public static void premain(String args, Instrumentation inst)
    public static void premain(String args)

2. agentmain 方法

2.1 讓 java 虛擬機(jī)能識(shí)別 agent agentmain 方法
  1. 必須打成jar包并添加 MANIFEST.MF文件 需要指定 Agent-Class
  2. 必須存在包含 agentmain 方法的類
  3. 可以使用 Attach API 遠(yuǎn)程加載的 Java agent
2.2 首先舉個(gè)監(jiān)控方法調(diào)用耗時(shí)的例子（模擬 arthas trace）

實(shí)現(xiàn)步驟:

  1. 需要獲取被監(jiān)控jvm的進(jìn)程id
  2. 修改字節(jié)碼，加入計(jì)算執(zhí)行耗時(shí)且打印的邏輯
  3. 程序執(zhí)行完成恢復(fù)字節(jié)碼

被監(jiān)控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]);
        //對(duì)應(yīng)agentmain 方法的第一個(gè)參數(shù)
        vm.loadAgent(args[1],"com.boost.tjvm.agent.Test");
    }
}
package com.boost.tjvm.agent;
public class MyAgent {
    //使用 Attach API 遠(yuǎn)程加載的 Java agent 不會(huì)再先于main方法執(zhí)行，這取決于另一虛擬機(jī)調(diào)用 Attach API 的時(shí)機(jī)。并且，它運(yùn)行的也不再是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);
        //在定義了多個(gè) Java agent，多個(gè)注入的情況下，我們可能需要移除其中的部分注入。當(dāng)調(diào)用Instrumentation.removeTransformer去除某個(gè)注入類后，我們可以調(diào)用retransform功能，重新從原始 byte 數(shù)組開始進(jìn)行注入。
        inst.removeTransformer(transformer);
        inst.retransformClasses(Class.forName(args)); // 修改Task類
    }

    private static class Transformer implements ClassFileTransformer {
        //在執(zhí)行premain或者agentmain方法前，Java 虛擬機(jī)早已加載了不少類，而這些類的加載事件并沒有被攔截，因此也沒有被注入。使用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")) {
                        // 修改字節(jié)碼
                        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() + "耗時(shí)\"+ (end - begin) +\"ms\");");
                    }
                }
                ctClass.detach();
                return ctClass.toBytecode();
            } catch (Exception e) {
                e.printStackTrace();
            }
            return classfileBuffer;
        }
    }

}

驗(yàn)證步驟:

  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 是修改字節(jié)碼工具類三方的。
  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 指的是舍棄原本的字節(jié)碼，并替換成由用戶提供的 byte 數(shù)組。
//Can-Retransform-Classes 重新調(diào)用所有已注冊(cè)的ClassFileTransformer的transform方法。
  1. idea 啟動(dòng)Tast
  2. 執(zhí)行
java -cp tjvm.jar com.boost.tjvm.agent.AttachTest 7764 ./tjvm.jar
Tast 類后臺(tái)會(huì)打印方法執(zhí)行耗時(shí)：

3. 參數(shù) Instrumentation 介紹

  1. 提供的主要功能是修改jvm中類的行為
//添加Transformer 修改或查看字節(jié)碼
addTransformer
//retransform則將針對(duì)所傳入的類，重新調(diào)用所有已注冊(cè)的ClassFileTransformer的transform方法
retransformClasses(Class.forName(args)); 
//當(dāng)調(diào)用Instrumentation.removeTransformer去除某個(gè)注入類后，我們可以調(diào)用retransformClasses功能，重新從原始 byte 數(shù)組開始進(jìn)行注入。
removeTransformer(transformer);
//獲取jvm中對(duì)象占用的空間，此方法也非常有用
getObjectSize(o);

4 總結(jié)

1. premain 方法 agentmain 方法區(qū)別

premain ：以命令行中指定 Java agent jar包啟動(dòng)jvm進(jìn)程，執(zhí)行在mian方法之前
agentmain ：使用 Attach API 遠(yuǎn)程加載的 Java agent 不會(huì)再先于main方法執(zhí)行，這取決于另一虛擬機(jī)調(diào)用 Attach API 的時(shí)機(jī)。

2. Java 虛擬機(jī)并不限制 Java agent 的數(shù)量。

你可以在 java 命令后附上多個(gè)-javaagent參數(shù)，或者遠(yuǎn)程 attach 多個(gè) Java agent，Java 虛擬機(jī)會(huì)按照定義順序，或者 attach 的順序逐個(gè)執(zhí)行這些 Java agent。

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容