基于Java?Agent的premain方式實(shí)現(xiàn)方法耗時(shí)監(jiān)控問(wèn)題

更新時(shí)間：2022年10月20日 16:10:24 作者：書夢(mèng)一生

javaagent是在JDK5之后提供的新特性，也可以叫java代理，這篇文章主要介紹了基于Java?Agent的premain方式實(shí)現(xiàn)方法耗時(shí)監(jiān)控問(wèn)題,需要的朋友可以參考下

Java Agent是依附于java應(yīng)用程序并能對(duì)其字節(jié)碼做相關(guān)更改的一項(xiàng)技術(shù)，它也是一個(gè)Jar包，但并不能獨(dú)立運(yùn)行，有點(diǎn)像寄生蟲的感覺(jué)。當(dāng)今的許多開源工具尤其是監(jiān)控和診斷工具，很多都是基于Java Agent來(lái)實(shí)現(xiàn)的，如最近阿里剛開源的Arthas。一個(gè)Java Agent既可以在程序運(yùn)行前加載(premain方式), 又可以在程序運(yùn)行后加載(attach方式)。本文通過(guò)實(shí)現(xiàn)一個(gè)對(duì)Java方法耗時(shí)監(jiān)控的Agent來(lái)讓大家了解一下Java Agent的premain方式具體應(yīng)用。

首先給出測(cè)試類，如下所示，該類的代碼很簡(jiǎn)單，最終要達(dá)到的目的就是在不修改這段代碼的情況下，能夠知道運(yùn)行這段程序時(shí)每個(gè)方法的具體耗時(shí)，也就是實(shí)現(xiàn)一個(gè)Java方法耗時(shí)監(jiān)控的Agent。

MyAgentTest.java

public class MyAgentTest {
    public static void main(String[] args) throws InterruptedException {
        MyAgentTest mat = new MyAgentTest();
        mat.test();
        Thread.sleep((long)(Math.random() * 10));//隨機(jī)暫停0-10ms
    }

    public void test() throws InterruptedException {
        System.out.println("I'm TestAgent");
        Thread.sleep((long)(Math.random() * 100));//隨機(jī)暫停0-100ms
    }
}

接下來(lái)就是要?jiǎng)?chuàng)建一個(gè)名為myagent的工程，項(xiàng)目結(jié)構(gòu)如下:

myagent
├── pom.xml
├── src
│   └── main
│       ├── java
│       │   └── test
│       │       ├── MyAgent.java
│       │       └── MyTransformer.java
│       └── resources
│           └── META-INF
│               └── MANIFEST.MF

從上面可以看到，項(xiàng)目中主要文件只有兩個(gè)java類和一個(gè)MANIFEST.MF，所以Java Agent其實(shí)也并沒(méi)有那么神秘。

先看看pom.xml這個(gè)文件，因?yàn)樽止?jié)碼的相關(guān)操作要依賴于javassist這個(gè)包，所以要添加相關(guān)依賴。在默認(rèn)情況下，用maven進(jìn)行打包時(shí)會(huì)覆蓋掉我們自己的MANIFEST.MF，以及不會(huì)引進(jìn)依賴的jar包，所以在build中要引進(jìn)maven-assembly-plugin插件并添加相關(guān)配置。

pom.xml

<?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.hebh.me</groupId>
  <artifactId>demo-myagent</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>jar</packaging>

  <name>demo-myagent Maven Webapp</name>
  <url>http://www.example.com</url>

  <dependencies>
    <dependency>
      <groupId>javassist</groupId>
      <artifactId>javassist</artifactId>
      <version>3.12.1.GA</version>
    </dependency>
  </dependencies>

  <build>
    <finalName>myagent</finalName>
    <plugins>
      <plugin>
        <artifactId>maven-assembly-plugin</artifactId>
        <configuration>
          <archive>
            <!--避免MANIFEST.MF被覆蓋-->
            <manifestFile>src/main/resources/META-INF/MANIFEST.MF</manifestFile>
          </archive>
          <descriptorRefs>
            <!--打包時(shí)加入依賴-->
            <descriptorRef>jar-with-dependencies</descriptorRef>
          </descriptorRefs>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

接下來(lái)就是最重要MyAgent類，而premain(String args, Instrumentation inst)這個(gè)方法是關(guān)鍵，也是Agent的入口, 在方法里我們直接打印"Hi, I'm agent!"文本并添加一個(gè)自己實(shí)現(xiàn)的字節(jié)碼轉(zhuǎn)換器。

MyAgent.java

package test;

import java.lang.instrument.Instrumentation;
public class MyAgent {
    public static void premain(String args, Instrumentation inst){
        System.out.println("Hi, I'm agent!");
        inst.addTransformer(new MyTransformer());
    }
}

然后看看這個(gè)字節(jié)碼轉(zhuǎn)換器的具體實(shí)現(xiàn)，首先是要實(shí)現(xiàn)ClassFileTransformer接口，然后實(shí)現(xiàn)接口中的transform方法，jdk中源碼對(duì)該接口的說(shuō)明如下

An agent provides an implementation of this interface in order to transform class files. The transformation occurs before the class is defined by the JVM

翻譯過(guò)來(lái)也就是我們可以通過(guò)實(shí)現(xiàn)該接口來(lái)在虛擬機(jī)加載類之前對(duì)字節(jié)碼進(jìn)行相關(guān)更改。

對(duì)于該方法的說(shuō)明文字比較多，在這里我們只需要知道該方法傳入類的所有相關(guān)信息，然后返回一個(gè)修改后的類的字節(jié)碼。要達(dá)到對(duì)方法耗時(shí)的監(jiān)控最核心的代碼在在這個(gè)方法里面，如下，首先過(guò)濾我們不關(guān)注的類，復(fù)制關(guān)注類的原方法并在執(zhí)行之前獲取時(shí)間戳，執(zhí)行后再次獲取時(shí)間戳，兩者取差值即為方法耗時(shí)，為一直觀顯示我們直接添加相關(guān)打印代碼。

MyTransformer.java

package test;

import java.lang.instrument.ClassFileTransformer;
import java.security.ProtectionDomain;

import javassist.ClassPool;
import javassist.CtClass;
import javassist.CtMethod;
import javassist.CtNewMethod;

/**
 * 檢測(cè)方法的執(zhí)行時(shí)間
 */
public class MyTransformer implements ClassFileTransformer {

    final static String prefix = "\nlong startTime = System.currentTimeMillis();\n";
    final static String postfix = "\nlong endTime = System.currentTimeMillis();\n";

    @Override
    public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined,
                            ProtectionDomain protectionDomain, byte[] classfileBuffer){
        //java自帶的方法不進(jìn)行處理
        if(className.startsWith("java") || className.startsWith("sun")){
            return null;
        }
        className = className.replace("/", ".");
        CtClass ctclass = null;
        try {
            ctclass = ClassPool.getDefault().get(className);// 使用全稱,用于取得字節(jié)碼類<使用javassist>
            for(CtMethod ctMethod : ctclass.getDeclaredMethods()){
                String methodName = ctMethod.getName();
                String newMethodName = methodName + "$old";// 新定義一個(gè)方法叫做比如sayHello$old
                ctMethod.setName(newMethodName);// 將原來(lái)的方法名字修改

                // 創(chuàng)建新的方法，復(fù)制原來(lái)的方法，名字為原來(lái)的名字
                CtMethod newMethod = CtNewMethod.copy(ctMethod, methodName, ctclass, null);

                // 構(gòu)建新的方法體
                StringBuilder bodyStr = new StringBuilder();
                bodyStr.append("{");
                bodyStr.append("System.out.println(\"==============Enter Method: " + className + "." + methodName + " ==============\");");
                bodyStr.append(prefix);
                bodyStr.append(newMethodName + "($$);\n");// 調(diào)用原有代碼，類似于method();($$)表示所有的參數(shù)
                bodyStr.append(postfix);
                bodyStr.append("System.out.println(\"==============Exit Method: " + className + "." + methodName + " Cost:\" +(endTime - startTime) +\"ms " + "===\");");
                bodyStr.append("}");

                newMethod.setBody(bodyStr.toString());// 替換新方法
                ctclass.addMethod(newMethod);// 增加新方法
            }
            return ctclass.toBytecode();
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }
}

最后也是非常重要并且容易出錯(cuò)的地方就是在resources文件夾下面創(chuàng)建META-INF文件夾，然后定義MANIFEST.MF文件，通過(guò)Premain-Class屬性來(lái)指定Agent的入口，需要注意的是冒號(hào)后面必須要有一個(gè)空格，并且最后要空出一行。

MANIFEST.MF

Manifest-Version: 1.0
Created-By: 0.0.1 (Demo Inc.)
Premain-Class: test.MyAgent

到此為止我們就已經(jīng)完成了myagent工程的所有代碼，為了使用它就必須將其打包為jar文件，用如下命令:

mvn assembly:assembly

執(zhí)行mvn命令后就可以在項(xiàng)目的target目錄下看到生成的myagent-jar-with-dependencies.jar文件。

然后編譯在最開始用來(lái)測(cè)試的類:

javac MyAgentTest.java

編譯后就生成了.class文件，為了方便，我們把.class文件放到和myagent-jar-with-dependencies.jar同一個(gè)目錄。

如果不使用我們的agent直接執(zhí)行java命令，效果如下:

如果在javaagent參數(shù)中加上agent，效果如下:

首先在執(zhí)行所有方法前，會(huì)執(zhí)行MyAgent的premain方法。并且可以直觀看到，MyAgentTest在運(yùn)行時(shí)首先是進(jìn)入main方法，然后再是test方法，執(zhí)行完test方法邏輯后退出test方法，最后退出main方法，不僅能看到每個(gè)方法的最終耗時(shí)也能看到方法執(zhí)行的軌跡。

到此這篇關(guān)于基于Java Agent的premain方式實(shí)現(xiàn)方法耗時(shí)監(jiān)控的文章就介紹到這了,更多相關(guān)Java Agent方法耗時(shí)監(jiān)控內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: