基于Java?Agent的premain如何實現方法耗時監控

這篇文章主要介紹“基于Java Agent的premain如何實現方法耗時監控”，在日常操作中，相信很多人在基于Java Agent的premain如何實現方法耗時監控問題上存在疑惑，小編查閱了各式資料，整理出簡單好用的操作方法，希望對大家解答”基于Java Agent的premain如何實現方法耗時監控”的疑惑有所幫助！接下來，請跟著小編一起來學習吧！

首先給出測試類，如下所示，該類的代碼很簡單，最終要達到的目的就是在不修改這段代碼的情況下，能夠知道運行這段程序時每個方法的具體耗時，也就是實現一個Java方法耗時監控的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));//隨機暫停0-10ms
    }

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

接下來就是要創建一個名為myagent的工程，項目結構如下:

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

從上面可以看到，項目中主要文件只有兩個java類和一個MANIFEST.MF，所以Java Agent其實也并沒有那么神秘。

先看看pom.xml這個文件，因為字節碼的相關操作要依賴于javassist這個包，所以要添加相關依賴。在默認情況下，用maven進行打包時會覆蓋掉我們自己的MANIFEST.MF，以及不會引進依賴的jar包，所以在build中要引進maven-assembly-plugin插件并添加相關配置。

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>
            <!--打包時加入依賴-->
            <descriptorRef>jar-with-dependencies</descriptorRef>
          </descriptorRefs>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

接下來就是最重要MyAgent類，而premain(String args, Instrumentation inst)這個方法是關鍵，也是Agent的入口, 在方法里我們直接打印"Hi, I'm agent!"文本并添加一個自己實現的字節碼轉換器。

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());
    }
}

然后看看這個字節碼轉換器的具體實現，首先是要實現ClassFileTransformer接口，然后實現接口中的transform方法，jdk中源碼對該接口的說明如下

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

翻譯過來也就是我們可以通過實現該接口來在虛擬機加載類之前對字節碼進行相關更改。

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

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;

/**
 * 檢測方法的執行時間
 */
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自帶的方法不進行處理
        if(className.startsWith("java") || className.startsWith("sun")){
            return null;
        }
        className = className.replace("/", ".");
        CtClass ctclass = null;
        try {
            ctclass = ClassPool.getDefault().get(className);// 使用全稱,用于取得字節碼類<使用javassist>
            for(CtMethod ctMethod : ctclass.getDeclaredMethods()){
                String methodName = ctMethod.getName();
                String newMethodName = methodName + "$old";// 新定義一個方法叫做比如sayHello$old
                ctMethod.setName(newMethodName);// 將原來的方法名字修改

                // 創建新的方法，復制原來的方法，名字為原來的名字
                CtMethod newMethod = CtNewMethod.copy(ctMethod, methodName, ctclass, null);

                // 構建新的方法體
                StringBuilder bodyStr = new StringBuilder();
                bodyStr.append("{");
                bodyStr.append("System.out.println(\"==============Enter Method: " + className + "." + methodName + " ==============\");");
                bodyStr.append(prefix);
                bodyStr.append(newMethodName + "($$);\n");// 調用原有代碼，類似于method();($$)表示所有的參數
                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;
    }
}

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

MANIFEST.MF

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

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

mvn assembly:assembly

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

然后編譯在最開始用來測試的類:

javac MyAgentTest.java

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

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

如果在javaagent參數中加上agent，效果如下:

首先在執行所有方法前，會執行MyAgent的premain方法。并且可以直觀看到，MyAgentTest在運行時首先是進入main方法，然后再是test方法，執行完test方法邏輯后退出test方法，最后退出main方法，不僅能看到每個方法的最終耗時也能看到方法執行的軌跡。

到此，關于“基于Java Agent的premain如何實現方法耗時監控”的學習就結束了，希望能夠解決大家的疑惑。理論與實踐的搭配能更好的幫助大家學習，快去試試吧！若想繼續學習更多相關知識，請繼續關注億速云網站，小編會繼續努力為大家帶來更多實用的文章！