Java Agent怎麼用-java教程-PHP中文網

首頁

Java

java教程

Java Agent怎麼用

PHPz

May 22, 2023 pm 08:52 PM

javaagent

Java Agent 技術簡介

Java Agent 直譯為 Java 代理，也常被稱為 Java 探針技術。

Java Agent 這種技術是在 JDK1.5 引入的，可以在執行時間動態修改 Java 字節碼。 Java 中的類別編譯後形成字節碼被JVM 執行，在JVM 在執行這些字節碼之前獲取這些字節碼的信息，並且透過字節碼轉換器對這些字節碼進行修改，以此來完成一些額外的功能。

Java Agent 是一個無法獨立執行 jar 套件，它透過依附於目標程式的 JVM 進程，進行工作。啟動時只需要在目標程式的啟動參數中加入-javaagent 參數新增 ClassFileTransformer 字節碼轉換器，相當於在main方法前加了一個攔截器。

Java Agent 功能介紹

Java Agent 主要有下列功能：

##Java Agent 能夠在載入Java 字節碼之前攔截並對字節碼進行修改;
Java Agent 能夠在Jvm 運行期間修改已經載入的字節碼;

##Java Agent 的應用場景：

在了解

Java Agent

的實作原理之前，需要對Java類別載入機制有一個較為清晰的認知。一種是在man方法執行之前，透過premain來執行，另一種是程式運行中修改，需透過JVM中的Attach實現，Attach的實作原理是基於JVMTI。主要是在類別載入之前，進行攔截，對字節碼修改

下面我們分別介紹一下這些關鍵術語：

#JVMTI
就是JVM Tool Interface，是JVM 揭露出來給使用者擴充功能使用的介面集合，JVMTI 是基於事件驅動的，JVM每執行一定的邏輯就會觸發一些事件的回調接口，透過這些回呼接口，使用者可以自行擴展

JVMTIAgent
是一個動態函式庫，利用JVMTI暴露出來的一些介面來幹一些我們想做、但是正常情況下又做不到的事情，不過為了和普通的動態庫進行區分，它一般會實現如下的一個或多個函數：

Agent_OnLoad
函數，如果agent是在啟動時載入的，透過JVM參數設定
Agent_OnAttach
函數，如果agent不是在啟動時載入的，而是我們先attach到目標進程上，然後給對應的目標進程發送load命令來加載，則在加載過程中會調用Agent_OnAttach函數
Agent_OnUnload
函數，在agent卸載時呼叫

javaagent
依賴instrument的JVMTIAgent（Linux下對應的動態函式庫是libinstrument.so），還有個別名叫JPLISAgent(Java Programming Language Instrumentation Services Agent)，專門為Java語言編寫的插樁服務提供支援的
instrument
實作了Agent_OnLoad和Agent_OnAttach兩方法，也就是說在使用時，agent既可以在啟動時加載，也可以在運行時動態加載。其中啟動時載入也可以透過類似-javaagent:jar包路徑的方式來間接載入instrument agent，運行時動態載入依賴的是JVM的attach機制，透過發送load指令來載入agent
JVM Attach
是指JVM 提供的一種進程間通訊的功能，能讓一個進程傳命令給另一個進程，並進行一些內部的操作，例如進行線程dump，那麼就需要執行jstack 進行，然後把pid 等參數傳遞給需要dump 的線程來執行

我們就以打印方法的執行時間為例，透過

Java Agent

來實作。首先我們需要建立一個精簡的

Maven

項目，在其中建立兩個Maven的子項目，一個用於實作外掛的Agent，一個用於實作測試目標程式。

Java Agent怎麼用

我們在父應用程式中導入兩個專案公共依賴的套件

    <dependencies>
        <dependency>
            <groupId>org.javassist</groupId>
            <artifactId>javassist</artifactId>
            <version>3.28.0-GA</version>
        </dependency>
    </dependencies>

首先我們去建構測試的目標程序

// 启动类
public class APPMain {
    public static void main(String[] args) {
        System.out.println("APP 启动！！！");
        AppInit.init();
    }
}
// 模拟的应用初始化的类
public class AppInit {
    public static void init() {
        try {
            System.out.println("APP初始化中...");
            Thread.sleep(1000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

然后我们启动程序，测试是否能正常执行，程序正常执行之后，我们开始构建探针程序

探针程序中我们需要编写，改变原有class的Transformer，通过自定义的Transformer类完成输出方法执行时间的功能，

首先构检Agent程序的入口
public class RunTimeAgent { public static void premain(String arg, Instrumentation instrumentation) { System.out.println("探针启动！！！"); System.out.println("探针传入参数：" + arg); instrumentation.addTransformer(new RunTimeTransformer()); } }
这里每个类加载的时候都会走这个方法，我们可以通过className进行指定类的拦截，然后借助javassist这个工具，进行对Class的处理，这里的思想和反射类似，但是要比反射功能更加强大，可以动态修改字节码。

javassist是一个开源的分析、编辑和创建Java字节码的类库。
import javassist.ClassPool; import javassist.CtClass; import javassist.CtMethod; import java.lang.instrument.ClassFileTransformer; import java.lang.instrument.IllegalClassFormatException; import java.security.ProtectionDomain; public class RunTimeTransformer implements ClassFileTransformer { private static final String INJECTED_CLASS = "com.zhj.test.init.AppInit"; @Override public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer) throws IllegalClassFormatException { String realClassName = className.replace("/", "."); if (realClassName.equals(INJECTED_CLASS)) { System.out.println("拦截到的类名：" + realClassName); CtClass ctClass; try { // 使用javassist,获取字节码类 ClassPool classPool = ClassPool.getDefault(); ctClass = classPool.get(realClassName); // 得到该类所有的方法实例，也可选择方法，进行增强 CtMethod[] declaredMethods = ctClass.getDeclaredMethods(); for (CtMethod method : declaredMethods) { System.out.println(method.getName() + "方法被拦截"); method.addLocalVariable("time", CtClass.longType); method.insertBefore("System.out.println(\"---开始执行---\");"); method.insertBefore("time = System.currentTimeMillis();"); method.insertAfter("System.out.println(\"---结束执行---\");"); method.insertAfter("System.out.println(\"运行耗时: \" + (System.currentTimeMillis() - time));"); } return ctClass.toBytecode(); } catch (Throwable e) { //这里要用Throwable，不要用Exception System.out.println(e.getMessage()); e.printStackTrace(); } } return classfileBuffer; } }
我们需要在Maven中配置，编译打包的插件，这样我们就可以很轻松的借助Maven生成Agent的jar包
<build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <version>3.5.1</version>  <configuration> <source>8</source> <target>8</target> </configuration> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-jar-plugin</artifactId> <version>3.2.0</version> <configuration> <archive>  <manifest> <addClasspath>true</addClasspath> </manifest> <manifestEntries> <Menifest-Version>1.0</Menifest-Version> <Premain-Class>com.zhj.agent.RunTimeAgent</Premain-Class> <Can-Redefine-Classes>true</Can-Redefine-Classes> <Can-Retransform-Classes>true</Can-Retransform-Classes> </manifestEntries> </archive> </configuration> </plugin> </plugins> </build>
否则我们需要在resources下创建META-INF/MANIFEST.MF文件，文件内容如下，我们可以看出这个与Maven中的配置是一致的，然后通过配置编译器，借助编译器打包成jar包，需指定该文件
Manifest-Version: 1.0 Premain-Class: com.zhj.agent.RunTimeAgent Can-Redefine-Classes: true Can-Retransform-Classes: true
告示文件MANIFEST.MF参数说明：

Manifest-Version

文件版本

Premain-Class

包含 premain 方法的类（类的全路径名）main方法运行前代理

Agent-Class

包含 agentmain 方法的类（类的全路径名）main开始后可以修改类结构

Boot-Class-Path

设置引导类加载器搜索的路径列表。查找类的特定于平台的机制失败后，引导类加载器会搜索这些路径。按列出的顺序搜索路径。列表中的路径由一个或多个空格分开。（可选）

Can-Redefine-Classes true

表示能重定义此代理所需的类，默认值为 false（可选）

Can-Retransform-Classes true

表示能重转换此代理所需的类，默认值为 false （可选）

Can-Set-Native-Method-Prefix true

表示能设置此代理所需的本机方法前缀，默认值为 false（可选）

最后通过Maven生成Agent的jar包，然后修改测试目标程序的启动器，添加JVM参数即可

参数示例：-javaagent:F:\code\myCode\agent-test\runtime-agent\target\runtime-agent-1.0-SNAPSHOT.jar=hello

最终效果：

以上是Java Agent怎麼用的詳細內容。更多資訊請關注PHP中文網其他相關文章！

陳述

本文轉載於：亿速云。如有侵權，請聯絡admin@php.cn刪除