Java高級特性之Instrumentation

不要說精通Java、Spring，能掌握70%就很不錯了，其他的高級特性。。。

我們平常開發java程序時，總想開發一個代理程序監視記錄類的運行情況，比如性能監控或運維人員很需要，比如調用業務方法時記錄日誌、計時等，除了AOP實現之外，還有一種實現，那就是基於java高級特性Instrumentation功能，

比如很多開源或商業公司也是基於此玩法，用開源的技術賺錢是我們一生的夢想！！！！！！！！！

Instrumentation簡介

• 利用java.lang.instrument(容器類) 做動態 Instrumentation(執行容器) 是 Java SE 5 的新特性。
• 使用 Instrumentation，開發者可以構建一個獨立於應用程序的代理程序（Agent），用來監測和協助運行在 JVM 上的程序，甚至能夠替換和修改某些類的定義。
• 這個功能爲虛擬機監控提供了支撐。

利用 Java 代碼，即 java.lang.instrument 做動態 Instrumentation 是 Java SE 5 的新特性，它把 Java 的 instrument 功能從本地代碼中解放出來，使之可以用 Java 代碼的方式解決問題。使用 Instrumentation，開發者可以構建一個獨立於應用程序的代理程序（Agent），用來監測和協助運行在 JVM 上的程序，甚至能夠替換和修改某些類的定義。有了這樣的功能，開發者就可以實現更爲靈活的運行時虛擬機監控和 Java 類操作了，這樣的特性實際上提供了一種虛擬機級別支持的 AOP 實現方式，使得開發者無需對 JDK 做任何升級和改動，就可以實現某些 AOP 的功能了。

在 Java SE 6 裏面，instrumentation 包被賦予了更強大的功能：啓動後的 instrument、本地代碼（native code）instrument，以及動態改變 classpath 等等。這些改變，意味着 Java 具有了更強的動態控制、解釋能力，它使得 Java 語言變得更加靈活多變。

在 Java SE6 裏面，最大的改變使運行時的 Instrumentation 成爲可能。在 Java SE 5 中，Instrument 要求在運行前利用命令行參數或者系統參數來設置代理類，在實際的運行之中，虛擬機在初始化之時（在絕大多數的 Java 類庫被載入之前），instrumentation 的設置已經啓動，並在虛擬機中設置了回調函數，檢測特定類的加載情況，並完成實際工作。但是在實際的很多的情況下，我們沒有辦法在虛擬機啓動之時就爲其設定代理，這樣實際上限制了 instrument 的應用。而 Java SE 6 的新特性改變了這種情況，通過 Java Tool API 中的 attach 方式，我們可以很方便地在運行過程中動態地設置加載代理類，以達到 instrumentation 的目的。

另外，對 native 的 Instrumentation 也是 Java SE 6 的一個嶄新的功能，這使以前無法完成的功能 —— 對 native 接口的 instrumentation 可以在 Java SE 6 中，通過一個或者一系列的 prefix 添加而得以完成。

最後，Java SE 6 裏的 Instrumentation 也增加了動態添加 class path 的功能。所有這些新的功能，都使得 instrument 包的功能更加豐富，從而使 Java 語言本身更加強大。

Instrumentation 的基本功能和用法

“java.lang.instrument”包的具體實現，依賴於 JVMTI。JVMTI（Java Virtual Machine Tool Interface）是一套由 Java 虛擬機提供的，爲 JVM 相關的工具提供的本地編程接口集合。JVMTI 是從 Java SE 5 開始引入，整合和取代了以前使用的 Java Virtual Machine Profiler Interface (JVMPI) 和 the Java Virtual Machine Debug Interface (JVMDI)，而在 Java SE 6 中，JVMPI 和 JVMDI 已經消失了。JVMTI 提供了一套”代理”程序機制，可以支持第三方工具程序以代理的方式連接和訪問 JVM，並利用 JVMTI 提供的豐富的編程接口，完成很多跟 JVM 相關的功能。事實上，java.lang.instrument 包的實現，也就是基於這種機制的：在 Instrumentation 的實現當中，存在一個 JVMTI 的代理程序，通過調用 JVMTI 當中 Java 類相關的函數來完成 Java 類的動態操作。除開 Instrumentation 功能外，JVMTI 還在虛擬機內存管理，線程控制，方法和變量操作等等方面提供了大量有價值的函數。

Instrumentation 的最大作用，就是類定義動態改變和操作。在 Java SE 5 及其後續版本當中，開發者可以在一個普通 Java 程序（帶有 main 函數的 Java 類）運行時，通過 – javaagent參數指定一個特定的 jar 文件（包含 Instrumentation 代理）來啓動 Instrumentation 的代理程序。

還記得嗎，雖然我們噼裏啪啦的寫java代碼，可到了JVM就只認識字節碼

在 Java SE 5 當中，開發者可以讓 Instrumentation 代理在 main 函數運行前執行。簡要說來就是如下幾個步驟：

1. 編寫 premain 函數

   編寫一個 Java 類，包含如下兩個方法當中的任何一個

   public static void premain(String agentArgs, Instrumentation inst); 【1】
   public static void premain(String agentArgs); 【2】

   其中，[1] 的優先級比 [2] 高，將會被優先執行（[1] 和 [2] 同時存在時，[2] 被忽略）。

   在這個 premain 函數中，開發者可以進行對類的各種操作。

   agentArgs 是 premain 函數得到的程序參數，隨同 “– javaagent”一起傳入。與 main 函數不同的是，這個參數是一個字符串而不是一個字符串數組，如果程序參數有多個，程序將自行解析這個字符串。

   Inst 是一個 java.lang.instrument.Instrumentation 的實例，由 JVM 自動傳入。java.lang.instrument.Instrumentation 是 instrument 包中定義的一個接口，也是這個包的核心部分，集中了其中幾乎所有的功能方法，例如類定義的轉換和操作等等。

2. jar 文件打包

   將這個 Java 類打包成一個 jar 文件，並在其中的 manifest 屬性當中加入” Premain-Class”來指定步驟 1 當中編寫的那個帶有 premain 的 Java 類。（可能還需要指定其他屬性以開啓更多功能）

3. 運行

   用如下方式運行帶有 Instrumentation 的 Java 程序：

   java -javaagent:jar文件的位置 [= 傳入 premain 的參數， ]
   
   

   對 Java class類文件的操作，可以理解爲對一個 byte 數組的操作（將類文件的二進制字節流讀入一個 byte 數組）。開發者可以在“ClassFileTransformer”的 transform 方法當中得到，操作並最終返回一個類的定義（一個 byte 數組）。

 

下面我就演示下怎麼監視類及類中方法

1.  到官網下載 第三方庫 Java bytecode http://www.javassist.org/

2.  eclipse新建純java項目Agent

先把步驟1下載好的jar包倒入java工程項目（如何導入我就不說了），然後新建包com.dongguangming.Agent，分別建立三個java文件:  CustomClassFileTransformer.java、CustomAgent.java、AgentTest.java(可選)，具體代碼如下

/**
 * @author dgm
 * @describe "具體攔截哪些類哪些方法"
 */
public class CustomClassFileTransformer implements ClassFileTransformer {
	public byte[] transform(ClassLoader loader, String className,
			Class classBeingRedefined, ProtectionDomain protectionDomain,
			byte[] classfileBuffer) throws IllegalClassFormatException {

		byte[] byteCode = classfileBuffer;
		if (className.equals("com/dongguangming/Agent/AgentTest")) {
			System.err.println("被攔截的類是："+className);

			ClassPool classPool = ClassPool.getDefault();
			try {
				CtClass ctClass = classPool.makeClass(new ByteArrayInputStream(
						classfileBuffer));
				CtMethod[] methods = ctClass.getDeclaredMethods();
				//System.err.println(methods);

				for (CtMethod method : methods) {
					System.err.println(method.getName());

					if (method.getName().equals("print")) {
						System.out.println("被攔截的方法是 : "
								+ className+"."+method.getName());
						method.insertAt(1,
								"System.out.println(\"注入代碼，打日誌，計時等\");");
					}
				}
				byteCode = ctClass.toBytecode();
				ctClass.detach();
			} catch (Throwable e) {
				e.printStackTrace();
			}
		}
		return byteCode;
	}
}

/**
 * @author dgm
 * @describe "自定義代理"
 */
public class CustomAgent {

	public static void premain(String agentArgs, Instrumentation instrumentation) {
		System.out.println("開始代理 Agent");
		
		CustomClassFileTransformer transformer = new CustomClassFileTransformer();
		instrumentation.addTransformer(transformer);
	}
}

/**
 *測試樣本
 */
public class AgentTest {
	public static void main(String[] args) {
		AgentTest sm = new AgentTest();
		System.out.println("準備進入測試階段");
		sm.print();
	}

	public void print() {
		System.out.println("真正的業務方法");
	}
}

 然後新建元配置文件MANIFEST.MF，內容如下

Manifest-Version: 1.0
Premain-Class: com.dongguangming.Agent.CustomAgent
Class-Path: lib/javassist-3.27.0-GA.jar

 至此項目基本代碼已完工，工程結構是這樣的

 注意Agent.jar是用eclipse手工配置生成的，實際看個人情況，比如命令行或通過maven構建工具也可以。

3.  測試

進入生成Agent.jar目錄，然後執行

java -javaagent:Agent.jar com.dongguangming.Agent.AgentTest

普通輸出：. 

執行方法計時

實際生產中比如用的spring全家桶開發，那麼傳的就是啓動類 SpringBoot*了。

這太強大了，對於監控、運維人員來說，可以做到不用改動業務代碼，實現零入侵的實現打點、統計、性能監控等。

沒有做不到，只有你想不到，世上本沒有路，走的人多了，便成了路

 

總結： 天外有太空，人外有人！！！

java博大精深，其它模塊你可以不用，但並不代表它不存在！！！

 

參考:

0.  Interface Instrumentation  https://docs.oracle.com/javase/8/docs/api/java/lang/instrument/Instrumentation.html 

1. Javabyte code: https://www.ibm.com/developerworks/ibm/library/it-haggar_bytecode

 

2. Developing a jvm agent for bytecode  instrumentation with  javassist-pt1 （要fq） http://rafaeloltra.com/developing-a-jvm-agent-for-bytecode-instrumentation-with-javassist-pt1/

3.  Easily Create Java Agents with Byte Buddy  https://www.infoq.com/articles/Easily-Create-Java-Agents-with-ByteBuddy/

4.  Building a dynamic instrumentation agent for Java 

https://blog.sqreen.com/building-a-dynamic-instrumentation-agent-for-java/

5.  魯迅說過：世上本沒有路，走的人多了便也成了路 https://baijiahao.baidu.com/s?id=1661756653899046770

6.  Creating Your Own Debugging Tools

https://blogs.oracle.com/javamagazine/creating-your-own-debugging-tools