當(dāng)前位置：首頁(yè) > 编程语言 > java >内容正文

java

Java SE 6 新特性 Instrumentation 新功能

發(fā)布時(shí)間：2025/3/21 java 25 豆豆

生活随笔收集整理的這篇文章主要介紹了 Java SE 6 新特性 Instrumentation 新功能小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,幫大家做個(gè)參考.

系列內(nèi)容：

此內(nèi)容是該系列的一部分：Java SE 6 新特性

Instrumentation 簡(jiǎn)介

利用 Java 代碼，即 java.lang.instrument 做動(dòng)態(tài) Instrumentation 是 Java SE 5 的新特性，它把 Java 的 instrument 功能從本地代碼中解放出來(lái)，使之可以用 Java 代碼的方式解決問(wèn)題。使用 Instrumentation，開(kāi)發(fā)者可以構(gòu)建一個(gè)獨(dú)立于應(yīng)用程序的代理程序（Agent），用來(lái)監(jiān)測(cè)和協(xié)助運(yùn)行在 JVM 上的程序，甚至能夠替換和修改某些類(lèi)的定義。有了這樣的功能，開(kāi)發(fā)者就可以實(shí)現(xiàn)更為靈活的運(yùn)行時(shí)虛擬機(jī)監(jiān)控和 Java 類(lèi)操作了，這樣的特性實(shí)際上提供了一種虛擬機(jī)級(jí)別支持的 AOP 實(shí)現(xiàn)方式，使得開(kāi)發(fā)者無(wú)需對(duì) JDK 做任何升級(jí)和改動(dòng)，就可以實(shí)現(xiàn)某些 AOP 的功能了。

在 Java SE 6 里面，instrumentation 包被賦予了更強(qiáng)大的功能：啟動(dòng)后的 instrument、本地代碼（native code）instrument，以及動(dòng)態(tài)改變 classpath 等等。這些改變，意味著 Java 具有了更強(qiáng)的動(dòng)態(tài)控制、解釋能力，它使得 Java 語(yǔ)言變得更加靈活多變。

在 Java SE6 里面，最大的改變使運(yùn)行時(shí)的 Instrumentation 成為可能。在 Java SE 5 中，Instrument 要求在運(yùn)行前利用命令行參數(shù)或者系統(tǒng)參數(shù)來(lái)設(shè)置代理類(lèi)，在實(shí)際的運(yùn)行之中，虛擬機(jī)在初始化之時(shí)（在絕大多數(shù)的 Java 類(lèi)庫(kù)被載入之前），instrumentation 的設(shè)置已經(jīng)啟動(dòng)，并在虛擬機(jī)中設(shè)置了回調(diào)函數(shù)，檢測(cè)特定類(lèi)的加載情況，并完成實(shí)際工作。但是在實(shí)際的很多的情況下，我們沒(méi)有辦法在虛擬機(jī)啟動(dòng)之時(shí)就為其設(shè)定代理，這樣實(shí)際上限制了 instrument 的應(yīng)用。而 Java SE 6 的新特性改變了這種情況，通過(guò) Java Tool API 中的 attach 方式，我們可以很方便地在運(yùn)行過(guò)程中動(dòng)態(tài)地設(shè)置加載代理類(lèi)，以達(dá)到 instrumentation 的目的。

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

最后，Java SE 6 里的 Instrumentation 也增加了動(dòng)態(tài)添加 class path 的功能。所有這些新的功能，都使得 instrument 包的功能更加豐富，從而使 Java 語(yǔ)言本身更加強(qiáng)大。

Instrumentation 的基本功能和用法

“java.lang.instrument”包的具體實(shí)現(xiàn)，依賴(lài)于 JVMTI。JVMTI（Java Virtual Machine Tool Interface）是一套由 Java 虛擬機(jī)提供的，為 JVM 相關(guān)的工具提供的本地編程接口集合。JVMTI 是從 Java SE 5 開(kāi)始引入，整合和取代了以前使用的 Java Virtual Machine Profiler Interface (JVMPI) 和 the Java Virtual Machine Debug Interface (JVMDI)，而在 Java SE 6 中，JVMPI 和 JVMDI 已經(jīng)消失了。JVMTI 提供了一套”代理”程序機(jī)制，可以支持第三方工具程序以代理的方式連接和訪問(wèn) JVM，并利用 JVMTI 提供的豐富的編程接口，完成很多跟 JVM 相關(guān)的功能。事實(shí)上，java.lang.instrument 包的實(shí)現(xiàn)，也就是基于這種機(jī)制的：在 Instrumentation 的實(shí)現(xiàn)當(dāng)中，存在一個(gè) JVMTI 的代理程序，通過(guò)調(diào)用 JVMTI 當(dāng)中 Java 類(lèi)相關(guān)的函數(shù)來(lái)完成 Java 類(lèi)的動(dòng)態(tài)操作。除開(kāi) Instrumentation 功能外，JVMTI 還在虛擬機(jī)內(nèi)存管理，線程控制，方法和變量操作等等方面提供了大量有價(jià)值的函數(shù)。關(guān)于 JVMTI 的詳細(xì)信息，請(qǐng)參考 Java SE 6 文檔（請(qǐng)參見(jiàn)?參考資源）當(dāng)中的介紹。

Instrumentation 的最大作用，就是類(lèi)定義動(dòng)態(tài)改變和操作。在 Java SE 5 及其后續(xù)版本當(dāng)中，開(kāi)發(fā)者可以在一個(gè)普通 Java 程序（帶有 main 函數(shù)的 Java 類(lèi)）運(yùn)行時(shí)，通過(guò)?– javaagent參數(shù)指定一個(gè)特定的 jar 文件（包含 Instrumentation 代理）來(lái)啟動(dòng) Instrumentation 的代理程序。

在 Java SE 5 當(dāng)中，開(kāi)發(fā)者可以讓 Instrumentation 代理在 main 函數(shù)運(yùn)行前執(zhí)行。簡(jiǎn)要說(shuō)來(lái)就是如下幾個(gè)步驟：

編寫(xiě) premain 函數(shù)

編寫(xiě)一個(gè) Java 類(lèi)，包含如下兩個(gè)方法當(dāng)中的任何一個(gè)

1 2	public static void premain(String agentArgs, Instrumentation inst);? [1] public static void premain(String agentArgs); [2]

其中，[1] 的優(yōu)先級(jí)比 [2] 高，將會(huì)被優(yōu)先執(zhí)行（[1] 和 [2] 同時(shí)存在時(shí)，[2] 被忽略）。

在這個(gè) premain 函數(shù)中，開(kāi)發(fā)者可以進(jìn)行對(duì)類(lèi)的各種操作。

agentArgs 是 premain 函數(shù)得到的程序參數(shù)，隨同 “– javaagent”一起傳入。與 main 函數(shù)不同的是，這個(gè)參數(shù)是一個(gè)字符串而不是一個(gè)字符串?dāng)?shù)組，如果程序參數(shù)有多個(gè)，程序?qū)⒆孕薪馕鲞@個(gè)字符串。

Inst 是一個(gè) java.lang.instrument.Instrumentation 的實(shí)例，由 JVM 自動(dòng)傳入。java.lang.instrument.Instrumentation 是 instrument 包中定義的一個(gè)接口，也是這個(gè)包的核心部分，集中了其中幾乎所有的功能方法，例如類(lèi)定義的轉(zhuǎn)換和操作等等。

jar 文件打包

將這個(gè) Java 類(lèi)打包成一個(gè) jar 文件，并在其中的 manifest 屬性當(dāng)中加入” Premain-Class”來(lái)指定步驟 1 當(dāng)中編寫(xiě)的那個(gè)帶有 premain 的 Java 類(lèi)。（可能還需要指定其他屬性以開(kāi)啟更多功能）

運(yùn)行

用如下方式運(yùn)行帶有 Instrumentation 的 Java 程序：

1	java -javaagent:jar 文件的位置 [= 傳入 premain 的參數(shù) ]

對(duì) Java 類(lèi)文件的操作，可以理解為對(duì)一個(gè) byte 數(shù)組的操作（將類(lèi)文件的二進(jìn)制字節(jié)流讀入一個(gè) byte 數(shù)組）。開(kāi)發(fā)者可以在“ClassFileTransformer”的 transform 方法當(dāng)中得到，操作并最終返回一個(gè)類(lèi)的定義（一個(gè) byte 數(shù)組）。這方面，Apache 的 BCEL 開(kāi)源項(xiàng)目提供了強(qiáng)有力的支持，讀者可以在參考文章“Java SE 5 特性 Instrumentation 實(shí)踐”中看到一個(gè) BCEL 和 Instrumentation 結(jié)合的例子。具體的字節(jié)碼操作并非本文的重點(diǎn)，所以，本文中所舉的例子，只是采用簡(jiǎn)單的類(lèi)文件替換的方式來(lái)演示 Instrumentation 的使用。

下面，我們通過(guò)簡(jiǎn)單的舉例，來(lái)說(shuō)明 Instrumentation 的基本使用方法。

首先，我們有一個(gè)簡(jiǎn)單的類(lèi)，TransClass，可以通過(guò)一個(gè)靜態(tài)方法返回一個(gè)整數(shù) 1。

public class TransClass {

????public int getNumber() {

????return 1;

???}

}

我們運(yùn)行如下類(lèi)，可以得到輸出 ”1“。

public class TestMainInJar {

???public static void main(String[] args) {

???????System.out.println(new TransClass().getNumber());

???}

}

然后，我們將 TransClass 的 getNumber 方法改成如下 :

public int getNumber() {

???????return 2;

}

再將這個(gè)返回 2 的 Java 文件編譯成類(lèi)文件，為了區(qū)別開(kāi)原有的返回 1 的類(lèi)，我們將返回 2 的這個(gè)類(lèi)文件命名為 TransClass2.class.2。

接下來(lái)，我們建立一個(gè) Transformer 類(lèi)：

import java.io.File;

import java.io.FileInputStream;

import java.io.IOException;

import java.io.InputStream;

import java.lang.instrument.ClassFileTransformer;

import java.lang.instrument.IllegalClassFormatException;

import java.security.ProtectionDomain;

class Transformer implements ClassFileTransformer {

???public static final String classNumberReturns2 = "TransClass.class.2";

???public static byte[] getBytesFromFile(String fileName) {

???????try {

???????????// precondition

???????????File file = new File(fileName);

???????????InputStream is = new FileInputStream(file);

???????????long length = file.length();

???????????byte[] bytes = new byte[(int) length];

???????????// Read in the bytes

???????????int offset = 0;

???????????int numRead = 0;

???????????while (offset <bytes.length

???????????????????&& (numRead = is.read(bytes, offset, bytes.length - offset)) >= 0) {

???????????????offset += numRead;

???????????}

???????????if (offset < bytes.length) {

???????????????throw new IOException("Could not completely read file "

???????????????????????+ file.getName());

???????????}

???????????is.close();

???????????return bytes;

???????} catch (Exception e) {

???????????System.out.println("error occurs in _ClassTransformer!"

???????????????????+ e.getClass().getName());

???????????return null;

???????}

???}

???public byte[] transform(ClassLoader l, String className, Class<?> c,

???????????ProtectionDomain pd, byte[] b) throws IllegalClassFormatException {

???????if (!className.equals("TransClass")) {

???????????return null;

???????}

???????return getBytesFromFile(classNumberReturns2);

???}

}

這個(gè)類(lèi)實(shí)現(xiàn)了 ClassFileTransformer 接口。其中，getBytesFromFile 方法根據(jù)文件名讀入二進(jìn)制字符流，而 ClassFileTransformer 當(dāng)中規(guī)定的 transform 方法則完成了類(lèi)定義的替換轉(zhuǎn)換。

最后，我們建立一個(gè) Premain 類(lèi)，寫(xiě)入 Instrumentation 的代理方法 premain：

public class Premain {

???public static void premain(String agentArgs， Instrumentation inst)

???????????throws ClassNotFoundException， UnmodifiableClassException {

???????inst.addTransformer(new Transformer());

???}

}

可以看出，addTransformer 方法并沒(méi)有指明要轉(zhuǎn)換哪個(gè)類(lèi)。轉(zhuǎn)換發(fā)生在 premain 函數(shù)執(zhí)行之后，main 函數(shù)執(zhí)行之前，這時(shí)每裝載一個(gè)類(lèi)，transform 方法就會(huì)執(zhí)行一次，看看是否需要轉(zhuǎn)換，所以，在 transform（Transformer 類(lèi)中）方法中，程序用 className.equals("TransClass") 來(lái)判斷當(dāng)前的類(lèi)是否需要轉(zhuǎn)換。

代碼完成后，我們將他們打包為 TestInstrument1.jar。返回 1 的那個(gè) TransClass 的類(lèi)文件保留在 jar 包中，而返回 2 的那個(gè) TransClass.class.2 則放到 jar 的外面。在 manifest 里面加入如下屬性來(lái)指定 premain 所在的類(lèi)：

1 2	Manifest-Version: 1.0 Premain-Class: Premain

在運(yùn)行這個(gè)程序的時(shí)候，如果我們用普通方式運(yùn)行這個(gè) jar 中的 main 函數(shù)，可以得到輸出“1”。如果用下列方式運(yùn)行 :

1	java – javaagent:TestInstrument1.jar – cp TestInstrument1.jar TestMainInJar

則會(huì)得到輸出“2”。

當(dāng)然，程序運(yùn)行的 main 函數(shù)不一定要放在 premain 所在的這個(gè) jar 文件里面，這里只是為了例子程序打包的方便而放在一起的。

除開(kāi)用 addTransformer 的方式，Instrumentation 當(dāng)中還有另外一個(gè)方法“redefineClasses”來(lái)實(shí)現(xiàn) premain 當(dāng)中指定的轉(zhuǎn)換。用法類(lèi)似，如下：

public class Premain {

???public static void premain(String agentArgs， Instrumentation inst)

???????????throws ClassNotFoundException， UnmodifiableClassException {

???????ClassDefinition def = new ClassDefinition(TransClass.class， Transformer

???????????????.getBytesFromFile(Transformer.classNumberReturns2));

???????inst.redefineClasses(new ClassDefinition[] { def });

???????System.out.println("success");

???}

}

redefineClasses 的功能比較強(qiáng)大，可以批量轉(zhuǎn)換很多類(lèi)。

Java SE 6 的新特性：虛擬機(jī)啟動(dòng)后的動(dòng)態(tài) instrument

在 Java SE 5 當(dāng)中，開(kāi)發(fā)者只能在 premain 當(dāng)中施展想象力，所作的 Instrumentation 也僅限與 main 函數(shù)執(zhí)行前，這樣的方式存在一定的局限性。

在 Java SE 5 的基礎(chǔ)上，Java SE 6 針對(duì)這種狀況做出了改進(jìn)，開(kāi)發(fā)者可以在 main 函數(shù)開(kāi)始執(zhí)行以后，再啟動(dòng)自己的 Instrumentation 程序。

在 Java SE 6 的 Instrumentation 當(dāng)中，有一個(gè)跟 premain“并駕齊驅(qū)”的“agentmain”方法，可以在 main 函數(shù)開(kāi)始運(yùn)行之后再運(yùn)行。

跟 premain 函數(shù)一樣，開(kāi)發(fā)者可以編寫(xiě)一個(gè)含有“agentmain”函數(shù)的 Java 類(lèi)：

1 2	public static void agentmain (String agentArgs, Instrumentation inst);????????? [1] public static void agentmain (String agentArgs);??????????? [2]

同樣，[1] 的優(yōu)先級(jí)比 [2] 高，將會(huì)被優(yōu)先執(zhí)行。

跟 premain 函數(shù)一樣，開(kāi)發(fā)者可以在 agentmain 中進(jìn)行對(duì)類(lèi)的各種操作。其中的 agentArgs 和 Inst 的用法跟 premain 相同。

與“Premain-Class”類(lèi)似，開(kāi)發(fā)者必須在 manifest 文件里面設(shè)置“Agent-Class”來(lái)指定包含 agentmain 函數(shù)的類(lèi)。

可是，跟 premain 不同的是，agentmain 需要在 main 函數(shù)開(kāi)始運(yùn)行后才啟動(dòng)，這樣的時(shí)機(jī)應(yīng)該如何確定呢，這樣的功能又如何實(shí)現(xiàn)呢？

在 Java SE 6 文檔當(dāng)中，開(kāi)發(fā)者也許無(wú)法在 java.lang.instrument 包相關(guān)的文檔部分看到明確的介紹，更加無(wú)法看到具體的應(yīng)用 agnetmain 的例子。不過(guò)，在 Java SE 6 的新特性里面，有一個(gè)不太起眼的地方，揭示了 agentmain 的用法。這就是 Java SE 6 當(dāng)中提供的 Attach API。

Attach API 不是 Java 的標(biāo)準(zhǔn) API，而是 Sun 公司提供的一套擴(kuò)展 API，用來(lái)向目標(biāo) JVM ”附著”（Attach）代理工具程序的。有了它，開(kāi)發(fā)者可以方便的監(jiān)控一個(gè) JVM，運(yùn)行一個(gè)外加的代理程序。

Attach API 很簡(jiǎn)單，只有 2 個(gè)主要的類(lèi)，都在 com.sun.tools.attach 包里面： VirtualMachine 代表一個(gè) Java 虛擬機(jī)，也就是程序需要監(jiān)控的目標(biāo)虛擬機(jī)，提供了 JVM 枚舉，Attach 動(dòng)作和 Detach 動(dòng)作（Attach 動(dòng)作的相反行為，從 JVM 上面解除一個(gè)代理）等等 ; VirtualMachineDescriptor 則是一個(gè)描述虛擬機(jī)的容器類(lèi)，配合 VirtualMachine 類(lèi)完成各種功能。

為了簡(jiǎn)單起見(jiàn)，我們舉例簡(jiǎn)化如下：依然用類(lèi)文件替換的方式，將一個(gè)返回 1 的函數(shù)替換成返回 2 的函數(shù)，Attach API 寫(xiě)在一個(gè)線程里面，用睡眠等待的方式，每隔半秒時(shí)間檢查一次所有的 Java 虛擬機(jī)，當(dāng)發(fā)現(xiàn)有新的虛擬機(jī)出現(xiàn)的時(shí)候，就調(diào)用 attach 函數(shù)，隨后再按照 Attach API 文檔里面所說(shuō)的方式裝載 Jar 文件。等到 5 秒鐘的時(shí)候，attach 程序自動(dòng)結(jié)束。而在 main 函數(shù)里面，程序每隔半秒鐘輸出一次返回值（顯示出返回值從 1 變成 2）。

TransClass 類(lèi)和 Transformer 類(lèi)的代碼不變，參看上一節(jié)介紹。含有 main 函數(shù)的 TestMainInJar 代碼為：

public class TestMainInJar {

???public static void main(String[] args) throws InterruptedException {

???????System.out.println(new TransClass().getNumber());

???????int count = 0;

???????while (true) {

???????????Thread.sleep(500);

???????????count++;

???????????int number = new TransClass().getNumber();

???????????System.out.println(number);

???????????if (3 == number || count >= 10) {

???????????????break;

???????????}

???????}

???}

}

含有 agentmain 的 AgentMain 類(lèi)的代碼為：

import java.lang.instrument.ClassDefinition;

import java.lang.instrument.Instrumentation;

import java.lang.instrument.UnmodifiableClassException;

public class AgentMain {

???public static void agentmain(String agentArgs, Instrumentation inst)

???????????throws ClassNotFoundException, UnmodifiableClassException,

???????????InterruptedException {

???????inst.addTransformer(new Transformer (), true);

???????inst.retransformClasses(TransClass.class);

???????System.out.println("Agent Main Done");

???}

}

其中，retransformClasses 是 Java SE 6 里面的新方法，它跟 redefineClasses 一樣，可以批量轉(zhuǎn)換類(lèi)定義，多用于 agentmain 場(chǎng)合。

Jar 文件跟 Premain 那個(gè)例子里面的 Jar 文件差不多，也是把 main 和 agentmain 的類(lèi)，TransClass，Transformer 等類(lèi)放在一起，打包為“TestInstrument1.jar”，而 Jar 文件當(dāng)中的 Manifest 文件為 :

1 2	Manifest-Version: 1.0 Agent-Class: AgentMain

另外，為了運(yùn)行 Attach API，我們可以再寫(xiě)一個(gè)控制程序來(lái)模擬監(jiān)控過(guò)程：（代碼片段）

import com.sun.tools.attach.VirtualMachine;

?import com.sun.tools.attach.VirtualMachineDescriptor;

……

?// 一個(gè)運(yùn)行 Attach API 的線程子類(lèi)

?static class AttachThread extends Thread {

?????????

?private final List<VirtualMachineDescriptor> listBefore;

????????private final String jar;

????????AttachThread(String attachJar, List<VirtualMachineDescriptor> vms) {

????????????listBefore = vms;? // 記錄程序啟動(dòng)時(shí)的 VM 集合

????????????jar = attachJar;

????????}

????????public void run() {

????????????VirtualMachine vm = null;

????????????List<VirtualMachineDescriptor> listAfter = null;

????????????try {

????????????????int count = 0;

????????????????while (true) {

????????????????????listAfter = VirtualMachine.list();

????????????????????for (VirtualMachineDescriptor vmd : listAfter) {

????????????????????????if (!listBefore.contains(vmd)) {

?// 如果 VM 有增加，我們就認(rèn)為是被監(jiān)控的 VM 啟動(dòng)了

?// 這時(shí)，我們開(kāi)始監(jiān)控這個(gè) VM

????????????????????????????vm = VirtualMachine.attach(vmd);

????????????????????????????break;

????????????????????????}

????????????????????}

????????????????????Thread.sleep(500);

????????????????????count++;

????????????????????if (null != vm || count >= 10) {

????????????????????????break;

????????????????????}

????????????????}

????????????????vm.loadAgent(jar);

????????????????vm.detach();

????????????} catch (Exception e) {

?????????????????ignore

????????????}

????????}

????}

……

?public static void main(String[] args) throws InterruptedException {???

?????new AttachThread("TestInstrument1.jar", VirtualMachine.list()).start();

運(yùn)行時(shí)，可以首先運(yùn)行上面這個(gè)啟動(dòng)新線程的 main 函數(shù)，然后，在 5 秒鐘內(nèi)（僅僅簡(jiǎn)單模擬 JVM 的監(jiān)控過(guò)程）運(yùn)行如下命令啟動(dòng)測(cè)試 Jar 文件 :

1	java – javaagent:TestInstrument2.jar – cp TestInstrument2.jar TestMainInJar

如果時(shí)間掌握得不太差的話，程序首先會(huì)在屏幕上打出 1，這是改動(dòng)前的類(lèi)的輸出，然后會(huì)打出一些 2，這個(gè)表示 agentmain 已經(jīng)被 Attach API 成功附著到 JVM 上，代理程序生效了，當(dāng)然，還可以看到“Agent Main Done”字樣的輸出。

以上例子僅僅只是簡(jiǎn)單示例，簡(jiǎn)單說(shuō)明這個(gè)特性而已。真實(shí)的例子往往比較復(fù)雜，而且可能運(yùn)行在分布式環(huán)境的多個(gè) JVM 之中。

Java SE 6 新特性：本地方法的 Instrumentation

在 1.5 版本的 instumentation 里，并沒(méi)有對(duì) Java 本地方法（Native Method）的處理方式，而且在 Java 標(biāo)準(zhǔn)的 JVMTI 之下，并沒(méi)有辦法改變 method signature，這就使替換本地方法非常地困難。一個(gè)比較直接而簡(jiǎn)單的想法是，在啟動(dòng)時(shí)替換本地代碼所在的動(dòng)態(tài)鏈接庫(kù) —— 但是這樣，本質(zhì)上是一種靜態(tài)的替換，而不是動(dòng)態(tài)的 Instrumentation。而且，這樣可能需要編譯較大數(shù)量的動(dòng)態(tài)鏈接庫(kù) —— 比如，我們有三個(gè)本地函數(shù)，假設(shè)每一個(gè)都需要一個(gè)替換，而在不同的應(yīng)用之下，可能需要不同的組合，那么如果我們把三個(gè)函數(shù)都編譯在同一個(gè)動(dòng)態(tài)鏈接庫(kù)之中，最多我們需要 8 個(gè)不同的動(dòng)態(tài)鏈接庫(kù)來(lái)滿足需要。當(dāng)然，我們也可以獨(dú)立地編譯之，那樣也需要 6 個(gè)動(dòng)態(tài)鏈接庫(kù)——無(wú)論如何，這種繁瑣的方式是不可接受的。

在 Java SE 6 中，新的 Native Instrumentation 提出了一個(gè)新的 native code 的解析方式，作為原有的 native method 的解析方式的一個(gè)補(bǔ)充，來(lái)很好地解決了一些問(wèn)題。這就是在新版本的 java.lang.instrument 包里，我們擁有了對(duì) native 代碼的 instrument 方式 —— 設(shè)置 prefix。

假設(shè)我們有了一個(gè) native 函數(shù)，名字叫 nativeMethod，在運(yùn)行中過(guò)程中，我們需要將它指向另外一個(gè)函數(shù)（需要注意的是，在當(dāng)前標(biāo)準(zhǔn)的 JVMTI 之下，除了 native 函數(shù)名，其他的 signature 需要一致）。比如我們的 Java 代碼是：

package nativeTester;

class nativePrefixTester{

???…

????native int nativeMethod(int input);

???…

}

那么我們已經(jīng)實(shí)現(xiàn)的本地代碼是 :

1	jint Java_nativeTester_nativeMethod(jclass thiz, jobject thisObj, jint input);

現(xiàn)在我們需要在調(diào)用這個(gè)函數(shù)時(shí)，使之指向另外一個(gè)函數(shù)。那么按照 J2SE 的做法，我們可以按他的命名方式，加上一個(gè) prefix 作為新的函數(shù)名。比如，我們以 "another_" 作為 prefix，那么我們新的函數(shù)是 :

1 2	jint Java_nativeTester_another_nativePrefixTester(jclass thiz, jobject thisObj, jint input);

然后將之編入動(dòng)態(tài)鏈接庫(kù)之中。

現(xiàn)在我們已經(jīng)有了新的本地函數(shù)，接下來(lái)就是做 instrument 的設(shè)置。正如以上所說(shuō)的，我們可以使用 premain 方式，在虛擬機(jī)啟動(dòng)之時(shí)就載入 premain 完成 instrument 代理設(shè)置。也可以使用 agentmain 方式，去 attach 虛擬機(jī)來(lái)啟動(dòng)代理。而設(shè)置 native 函數(shù)的也是相當(dāng)簡(jiǎn)單的 :

premain(){? // 或者也可以在 agentmain 里

…

?if (!isNativeMethodPrefixSupported()){

?????????return; // 如果無(wú)法設(shè)置，則返回

?setNativeMethodPrefix(transformer,"another_"); // 設(shè)置 native 函數(shù)的 prefix，注意這個(gè)下劃線必須由用戶(hù)自己規(guī)定

…

在這里要注意兩個(gè)問(wèn)題。一是不是在任何的情況下都是可以設(shè)置 native 函數(shù)的 prefix 的。首先，我們要注意到 agent 包之中的 Manifest 所設(shè)定的特性 :

1	Can-Set-Native-Method-Prefix

要注意，這一個(gè)參數(shù)都可以影響是否可以設(shè)置 native prefix，而且，在默認(rèn)的設(shè)置之中，這個(gè)參數(shù)是 false 的，我們需要將之設(shè)置成 true（順便說(shuō)一句，對(duì) Manifest 之中的屬性來(lái)說(shuō)都是大小寫(xiě)無(wú)關(guān)的，當(dāng)然，如果給一個(gè)不是“true”的值，就會(huì)被當(dāng)作 false 值處理）。

當(dāng)然，我們還需要確認(rèn)虛擬機(jī)本身是否支持 setNativePrefix。在 Java API 里，Instrumentation 類(lèi)提供了一個(gè)函數(shù) isNativePrefix，通過(guò)這個(gè)函數(shù)我們可以知道該功能是否可以實(shí)行。

二是我們可以為每一個(gè) ClassTransformer 加上它自己的 nativeprefix；同時(shí)，每一個(gè) ClassTransformer 都可以為同一個(gè) class 做 transform，因此對(duì)于一個(gè) Class 來(lái)說(shuō)，一個(gè) native 函數(shù)可能有不同的 prefix，因此對(duì)這個(gè)函數(shù)來(lái)說(shuō)，它可能也有好幾種解析方式。

在 Java SE 6 當(dāng)中，Native prefix 的解釋方式如下：對(duì)于某一個(gè) package 內(nèi)的一個(gè) class 當(dāng)中的一個(gè) native method 來(lái)說(shuō)，首先，假設(shè)我們對(duì)這個(gè)函數(shù)的 transformer 設(shè)置了 native 的 prefix“another”，它將這個(gè)函數(shù)接口解釋成 :

由 Java 的函數(shù)接口

1	native void method()

和上述 prefix"another"，去尋找本地代碼中的函數(shù)

1 2	void Java_package_class_another_method(jclass theClass, jobject thiz);? // 請(qǐng)注意 prefix 在函數(shù)名中出現(xiàn)的位置！

一旦可以找到，那么調(diào)用這個(gè)函數(shù)，整個(gè)解析過(guò)程就結(jié)束了；如果沒(méi)有找到，那么虛擬機(jī)將會(huì)做進(jìn)一步的解析工作。我們將利用 Java native 接口最基本的解析方式 , 去找本地代碼中的函數(shù) :

1	void Java_package_class_method(jclass theClass, jobject thiz);

如果找到，則執(zhí)行之。否則，因?yàn)闆](méi)有任何一個(gè)合適的解析方式，于是宣告這個(gè)過(guò)程失敗。

那么如果有多個(gè) transformer，同時(shí)每一個(gè)都有自己的 prefix，又該如何解析呢？事實(shí)上，虛擬機(jī)是按 transformer 被加入到的 Instrumentation 之中的次序去解析的（還記得我們最基本的 addTransformer 方法嗎？）。

假設(shè)我們有三個(gè) transformer 要被加入進(jìn)來(lái)，他們的次序和相對(duì)應(yīng)的 prefix 分別為：transformer1 和“prefix1_”，transformer2 和 “prefix2_”，transformer3 和 “prefix3_”。那么，虛擬機(jī)會(huì)首先做的就是將接口解析為 :

1	native void prefix1_prefix2_prefix3_native_method()

然后去找它相對(duì)應(yīng)的 native 代碼。

但是如果第二個(gè) transformer（transformer2）沒(méi)有設(shè)定 prefix，那么很簡(jiǎn)單，我們得到的解析是：

1	native void prefix1_prefix3_native_method()

這個(gè)方式簡(jiǎn)單而自然。

當(dāng)然，對(duì)于多個(gè) prefix 的情況，我們還要注意一些復(fù)雜的情況。比如，假設(shè)我們有一個(gè) native 函數(shù)接口是：

1	native void native_method()

然后我們?yōu)樗O(shè)置了兩個(gè) prefix，比如 "wrapped_" 和 "wrapped2_"，那么，我們得到的是什么呢？是

1 2	void Java_package_class_wrapped_wrapped2_method(jclass theClass, jobject thiz); // 這個(gè)函數(shù)名正確嗎？

嗎？答案是否定的，因?yàn)槭聦?shí)上，對(duì) Java 中 native 函數(shù)的接口到 native 中的映射，有一系列的規(guī)定，因此可能有一些特殊的字符要被代入。而實(shí)際中，這個(gè)函數(shù)的正確的函數(shù)名是：

1 2	void Java_package_class_wrapped_1wrapped2_1method(jclass theClass, jobject thiz); // 只有這個(gè)函數(shù)名會(huì)被找到

很有趣不是嗎？因此如果我們要做類(lèi)似的工作，一個(gè)很好的建議是首先在 Java 中寫(xiě)一個(gè)帶 prefix 的 native 接口，用 javah 工具生成一個(gè) c 的 header-file，看看它實(shí)際解析得到的函數(shù)名是什么，這樣我們就可以避免一些不必要的麻煩。

另外一個(gè)事實(shí)是，與我們的想像不同，對(duì)于兩個(gè)或者兩個(gè)以上的 prefix，虛擬機(jī)并不做更多的解析；它不會(huì)試圖去掉某一個(gè) prefix，再來(lái)組裝函數(shù)接口。它做且僅作兩次解析。

總之，新的 native 的 prefix-instrumentation 的方式，改變了以前 Java 中 native 代碼無(wú)法動(dòng)態(tài)改變的缺點(diǎn)。在當(dāng)前，利用 JNI 來(lái)寫(xiě) native 代碼也是 Java 應(yīng)用中非常重要的一個(gè)環(huán)節(jié)，因此它的動(dòng)態(tài)化意味著整個(gè) Java 都可以動(dòng)態(tài)改變了 —— 現(xiàn)在我們的代碼可以利用加上 prefix 來(lái)動(dòng)態(tài)改變 native 函數(shù)的指向，正如上面所說(shuō)的，如果找不到，虛擬機(jī)還會(huì)去嘗試做標(biāo)準(zhǔn)的解析，這讓我們擁有了動(dòng)態(tài)地替換 native 代碼的方式，我們可以將許多帶不同 prefix 的函數(shù)編譯在一個(gè)動(dòng)態(tài)鏈接庫(kù)之中，而通過(guò) instrument 包的功能，讓 native 函數(shù)和 Java 函數(shù)一樣動(dòng)態(tài)改變、動(dòng)態(tài)替換。

當(dāng)然，現(xiàn)在的 native 的 instrumentation 還有一些限制條件，比如，不同的 transformer 會(huì)有自己的 native prefix，就是說(shuō)，每一個(gè) transformer 會(huì)負(fù)責(zé)他所替換的所有類(lèi)而不是特定類(lèi)的 prefix —— 因此這個(gè)粒度可能不夠精確。

Java SE 6 新特性：BootClassPath / SystemClassPath 的動(dòng)態(tài)增補(bǔ)

我們知道，通過(guò)設(shè)置系統(tǒng)參數(shù)或者通過(guò)虛擬機(jī)啟動(dòng)參數(shù)，我們可以設(shè)置一個(gè)虛擬機(jī)運(yùn)行時(shí)的 boot class 加載路徑（-Xbootclasspath）和 system class（-cp）加載路徑。當(dāng)然，我們?cè)谶\(yùn)行之后無(wú)法替換它。然而，我們也許有時(shí)候要需要把某些 jar 加載到 bootclasspath 之中，而我們無(wú)法應(yīng)用上述兩個(gè)方法；或者我們需要在虛擬機(jī)啟動(dòng)之后來(lái)加載某些 jar 進(jìn)入 bootclasspath。在 Java SE 6 之中，我們可以做到這一點(diǎn)了。

實(shí)現(xiàn)這幾點(diǎn)很簡(jiǎn)單，首先，我們依然需要確認(rèn)虛擬機(jī)已經(jīng)支持這個(gè)功能，然后在 premain/agantmain 之中加上需要的 classpath。我們可以在我們的 Transformer 里使用 appendToBootstrapClassLoaderSearch/appendToSystemClassLoaderSearch 來(lái)完成這個(gè)任務(wù)。

同時(shí)我們可以注意到，在 agent 的 manifest 里加入 Boot-Class-Path 其實(shí)一樣可以在動(dòng)態(tài)地載入 agent 的同時(shí)加入自己的 boot class 路徑，當(dāng)然，在 Java code 中它可以更加動(dòng)態(tài)方便和智能地完成 —— 我們可以很方便地加入判斷和選擇成分。

在這里我們也需要注意幾點(diǎn)。首先，我們加入到 classpath 的 jar 文件中不應(yīng)當(dāng)帶有任何和系統(tǒng)的 instrumentation 有關(guān)的系統(tǒng)同名類(lèi)，不然，一切都陷入不可預(yù)料之中 —— 這不是一個(gè)工程師想要得到的結(jié)果，不是嗎？

其次，我們要注意到虛擬機(jī)的 ClassLoader 的工作方式，它會(huì)記載解析結(jié)果。比如，我們?cè)?jīng)要求讀入某個(gè)類(lèi) someclass，但是失敗了，ClassLoader 會(huì)記得這一點(diǎn)。即使我們?cè)诤竺鎰?dòng)態(tài)地加入了某一個(gè) jar，含有這個(gè)類(lèi)，ClassLoader 依然會(huì)認(rèn)為我們無(wú)法解析這個(gè)類(lèi)，與上次出錯(cuò)的相同的錯(cuò)誤會(huì)被報(bào)告。

再次我們知道在 Java 語(yǔ)言中有一個(gè)系統(tǒng)參數(shù)“java.class.path”，這個(gè) property 里面記錄了我們當(dāng)前的 classpath，但是，我們使用這兩個(gè)函數(shù)，雖然真正地改變了實(shí)際的 classpath，卻不會(huì)對(duì)這個(gè) property 本身產(chǎn)生任何影響。

在公開(kāi)的 JavaDoc 中我們可以發(fā)現(xiàn)一個(gè)很有意思的事情，Sun 的設(shè)計(jì)師們告訴我們，這個(gè)功能事實(shí)上依賴(lài)于 ClassLoader 的 appendtoClassPathForInstrumentation 方法 —— 這是一個(gè)非公開(kāi)的函數(shù)，因此我們不建議直接（使用反射等方式）使用它，事實(shí)上，instrument 包里的這兩個(gè)函數(shù)已經(jīng)可以很好的解決我們的問(wèn)題了。

結(jié)語(yǔ)

從以上的介紹我們可以得出結(jié)論，在 Java SE 6 里面，instrumentation 包新增的功能 —— 虛擬機(jī)啟動(dòng)后的動(dòng)態(tài) instrument、本地代碼（native code）instrumentation，以及動(dòng)態(tài)添加 classpath 等等，使得 Java 具有了更強(qiáng)的動(dòng)態(tài)控制、解釋能力，從而讓 Java 語(yǔ)言變得更加靈活多變。

這些能力，從某種意義上開(kāi)始改變 Java 語(yǔ)言本身。在過(guò)去很長(zhǎng)的一段時(shí)間內(nèi)，動(dòng)態(tài) 腳本語(yǔ)言的大量涌現(xiàn)和快速發(fā)展，對(duì)整個(gè)軟件業(yè)和網(wǎng)絡(luò)業(yè)提高生產(chǎn)率起到了非常重要的作用。在這種背景之下，Java 也正在慢慢地作出改變。而 Instrument 的新功能和 Script 平臺(tái)（本系列的后面一篇中將介紹到這一點(diǎn)）的出現(xiàn)，則大大強(qiáng)化了語(yǔ)言的動(dòng)態(tài)化和與動(dòng)態(tài)語(yǔ)言融合，它是 Java 的發(fā)展的值得考量的新趨勢(shì)。

相關(guān)主題

閱讀?Java SE 6 新特性系列文章的完整列表，了解 Java SE 6 其它重要的增強(qiáng)。
Java SE 6 文檔：Java SE 6 的規(guī)范文檔，可以找到絕大部分新特性的官方說(shuō)明。
Apache BCEL： Apache BCEL 項(xiàng)目，可以幫助開(kāi)發(fā)者操作 class 文件，開(kāi)發(fā)出功能強(qiáng)大的 instrumentation 代理程序。
閱讀文章“Java 5 特性 Instrumentation 實(shí)踐”：我的同事寫(xiě)的文章，介紹了在 Java SE 5 環(huán)境下，利用 BCEL 完成一個(gè)計(jì)時(shí)程序。
developerWorks Java 技術(shù)專(zhuān)區(qū)：這里有數(shù)百篇關(guān)于 Java 編程各個(gè)方面的文章。

from:?https://www.ibm.com/developerworks/cn/java/j-lo-jse61/index.html

總結(jié)

以上是生活随笔為你收集整理的Java SE 6 新特性 Instrumentation 新功能的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。

上一篇： Greys Java在线问题诊断工具
下一篇： java.lang.Instrument