Java Agent 開發初探

Java Agent 概況

簡介和功能

Java Agent是一種特殊的Java程式，允許開發者在 Java 應用程式執行時對其進行動態修改和監控的機制。它利用了 Java 虛擬機器（JVM）的 java.lang.instrument 包提供的功能，可以在類載入時或執行時對位元組碼進行修改。這種技術通常用於效能監控、安全檢測、除錯和診斷等場景。

Java Agent 主要功能如下：

• 位元組碼增強：在類載入時或執行時動態修改類的位元組碼，以新增新的功能或改變現有行為。
• 效能監控：收集應用程式執行時的效能資料，如方法呼叫頻率、執行時間等。
• 安全檢查：在類載入時對類進行安全檢查，確保其符合特定的安全策略。
• 除錯和診斷：在不修改應用程式原始碼的情況下，插入除錯和診斷程式碼，以幫助開發和排查問題。

應用場景

Java Agent 的應用場景非常廣泛，以下是一些常見的使用案例：

• 效能監控：透過插入監控程式碼來收集應用程式的效能資料，例如方法呼叫時間、記憶體使用情況等。
• 安全性檢查：在執行時動態地檢查和加固應用程式，防止安全漏洞。
• 除錯與診斷：在不修改原始碼的情況下，為應用程式新增日誌輸出或除錯資訊。
• 動態 AOP（面向切面程式設計）：實現在執行時動態地插入切面邏輯，而無需在編譯時進行程式碼修改。

那麼，我們如何開發一個 Java Agent 呢，下面我們來仔細說說。

開發 Java Agent

Java Agent 透過實現 java.lang.instrument.ClassFileTransformer 介面，並將其註冊到 Instrumentation 物件中，可以在類載入時對類的位元組碼進行修改。Instrumentation 物件是在 JVM 啟動時由 Java Agent 提供的，可以透過 premain 方法獲取。開發 Java Agent 需要遵循一下規範，下面是幾個必備的部分：

實現 premain 方法

premain 方法是 Java Agent 的入口點，類似於主程式的 main 方法。它在 JVM 啟動時被呼叫，並傳遞 Instrumentation 物件。

 import java.lang.instrument.Instrumentation;

 public class MyAgent {
  public static void premain(String agentArgs, Instrumentation inst) {
// 註冊 ClassFileTransformer
inst.addTransformer(new MyClassFileTransformer());
  }
 }

實現 ClassFileTransformer 介面

ClassFileTransformer 介面的 transform 方法在每個類載入時被呼叫，可以在這裡對類的位元組碼進行修改。我們也可以建立一個 Java Agent 而不實現 ClassFileTransformer 介面，而是隻實現兩個方法：premain 和（可選的）agentmain。這樣，你仍然可以使用 Java Agent 的一些基本功能，例如在 JVM 啟動時執行某些初始化程式碼或在執行時載入 Agent。

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

 public class MyClassFileTransformer implements ClassFileTransformer {
  @Override
  public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined,
  ProtectionDomain protectionDomain, byte[] classfileBuffer)
  throws IllegalClassFormatException {
// 這裡可以對 classfileBuffer 進行修改
System.out.println("Loading class: " + className);
return classfileBuffer;
  }
 }

打包 Java Agent

Java Agent 要求 JAR 包的 MANIFEST.MF 檔案中要有 Premain-Class 屬性，不切指定 Agent 類。通常我們使用 Maven 打包工具來完成，下面是個例子（篇幅限制，只展示了 build 不分）：

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>3.2.0</version>
                <configuration>
                    <archive>
                        <manifestEntries>
                            <Premain-Class>com.example.MyAgent</Premain-Class>
                            <Agent-Class>com.example.MyAgent</Agent-Class>
                            <Can-Redefine-Classes>true</Can-Redefine-Classes>
                            <Can-Retransform-Classes>true</Can-Retransform-Classes>
                        </manifestEntries>
                    </archive>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

使用 Java Agent

使用 -javaagent 引數來載入 Java Agent。

java -javaagent:MyAgent.jar -jar YourApp.jar

還有一種動態載入的方式，使用 attack API 來完成。

String pid = ...; // 獲取目標JVM的程序ID
VirtualMachine vm = VirtualMachine.attach(pid);
vm.loadAgent("/path/to/MyAgent.jar");
vm.detach();

程式碼解釋：

1. 獲取目標 JVM 的程序 ID：首先，需要獲取目標 JVM 程序的 PID（程序 ID）。可以透過 JMX、jps 命令或其他方法獲取。
2. 附加到目標 JVM：使用 VirtualMachine.attach(pid) 方法附加到目標 JVM 程序。這個方法返回一個 VirtualMachine 物件，該物件代表目標 JVM。
3. 載入 Java Agent：使用 VirtualMachine 物件的 loadAgent 方法載入 Java Agent。傳遞 Java Agent JAR 檔案的路徑，這會在目標 JVM 中執行該 Agent。
4. 分離：載入完 Agent 後，透過 VirtualMachine 物件的 detach 方法分離當前 JVM 與目標 JVM 的連線，確保操作完成並釋放資源。

實用案例

效能監控

Java Agent 技術在效能監控領域的應用非常廣泛，它可以幫助開發者實時監控應用程式的執行狀態，識別效能瓶頸。

• 實時監控：透過 Java Agent，可以在應用程式執行時動態地收集 CPU、記憶體、執行緒等關鍵效能指標的資料。
• 資料收集：Agent 可以在不干擾應用程式正常執行的情況下，收集方法呼叫、執行時間等資訊，為效能分析提供資料支援。
• 效能分析工具整合：Java Agent 可以與現有的效能分析工具如 VisualVM、JProfiler 等整合，實現資料的自動收集和分析。
• 自定義監控邏輯：開發者可以根據需要編寫自定義的監控邏輯，例如監控特定方法的呼叫頻率、執行時間等，並透過 Agent 在執行時動態地插入到應用程式中。

安全性檢查

• Java Agent 也常用於安全性檢查，幫助發現和預防潛在的安全漏洞。

• 程式碼注入：Agent 可以在類載入時動態地注入安全檢查程式碼，例如檢查 SQL 查詢語句，防止 SQL 注入攻擊。

• 執行時檢查：在應用程式執行時，Agent 可以實時監控系統呼叫，檢測潛在的安全威脅，如未授權的檔案訪問嘗試。

• 安全策略實施：透過 Agent，可以實施自定義的安全策略，如限制特定方法的呼叫許可權，增強應用程式的安全性。

• 漏洞掃描：Agent 可以整合漏洞掃描工具，對應用程式進行深度的安全檢查，及時發現並修復安全漏洞。

效能影響

開發Java Agent時，效能影響是一個需要特別關注的問題。由於Agent會在目標應用程式的 JVM 中執行，其位元組碼轉換和監控操作可能會對應用程式的效能產生一定的影響。

• 位元組碼轉換開銷：在類載入時進行位元組碼轉換會增加類載入的時間，尤其是在啟動階段，可能會延長應用程式的啟動時間。
• 執行時監控：Agent 進行的實時監控和資料收集可能會佔用額外的 CPU 和記憶體資源，影響應用程式的響應時間和吞吐量。
• 除錯難度：由於 Agent 的介入，應用程式的行為可能會發生變化，這使得除錯和定位問題變得更加複雜。

為了最小化效能影響，開發者應該：

• 最佳化位元組碼轉換邏輯：儘量簡化轉換邏輯，減少不必要的操作，提高轉換效率。
• 合理配置監控頻率：根據實際需求合理設定監控資料的採集頻率，避免過度監控。
• 進行效能測試：在部署 Agent 之前，進行充分的效能測試，評估其對應用程式效能的影響，並根據測試結果進行最佳化。

FunTester 原創精華

• 服務端功能測試
• 效能測試專題
• Java、Groovy、Go
• 白盒、工具、爬蟲、UI 自動化
• 理論、感悟、影片