使用 Instrumentation,使得开发者能够构建一个独立于应用程序的代理程序(Agent),用来监测和协助运行在 JVM 上的程序,甚至可以替换和修改某些类的定义。有了这样的功能,开发者就能够实现更为灵活的运行时虚拟机监控和 Java 类操做了,这样的特性实际上提供了 一种虚拟机级别支持的 AOP 实现方式,使得开发者无需对 JDK 作任何升级和改动,就能够实现某些 AOP 的功能了。java
利用 java.lang.instrument 作静态 Instrumentation 是 Java SE 5 的新特性,它把 Java 的 instrument 功能从本地代码中解放出来,使之能够用 Java 代码的方式解决问题。编程
在 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 的目的。bash
另外,对 native 的 Instrumentation 也是 Java SE 6 的一个崭新的功能,这使之前没法完成的功能 —— 对 native 接口的 instrumentation 能够在 Java SE 6 中,经过一个或者一系列的 prefix 添加而得以完成。app
最后,Java SE 6 里的 Instrumentation 也增长了动态添加 class path的功能。全部这些新的功能,都使得 instrument 包的功能更加丰富,从而使 Java 语言自己更增强大。jvm
事实上,java.lang.instrument 包的实现,是基于JVMTI机制的:在 Instrumentation 的实现当中,存在一个 JVMTI 的代理程序,经过调用 JVMTI 当中 Java 类相关的函数来完成Java 类的动态操做。除开 Instrumentation 功能外,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 相关的功能。工具
Instrumentation 的最大做用,就是类定义动态改变和操做。在 Java SE 5 及其后续版本当中,开发者能够在一个普通 Java 程序(带有 main 函数的 Java 类)运行时,经过 -javaagent参数指定一个特定的 jar 文件(包含 Instrumentation 代理)来启动 Instrumentation 的代理程序。测试
编写 premain 函数this
编写一个 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 包中定义的一个接口,也是这个包的核心部分,集中了其中几乎全部的功能方法,例如类定义的转换和操做等等。
jar 文件打包
将这个 Java 类打包成一个 jar 文件,并在其中的META-INF/MAINIFEST.MF属性当中加入” Premain-Class”来指定步骤 1 当中编写的那个带有 premain 的 Java 类。(可能还须要指定其余属性以开启更多功能)
运行
用以下方式运行带有 Instrumentation 的 Java 程序:
java -javaagent:jar文件的位置 [= 传入 premain 的参数 ]
复制代码
举个替换Java类文件栗子:采用简单的类文件替换的方式来演示 Instrumentation 的使用
对 Java 类文件的操做,能够理解为对一个 byte 数组的操做(将类文件的二进制字节流读入一个 byte 数组)。开发者能够在“ClassFileTransformer”的 transform 方法当中获得,操做并最终返回一个类的定义(一个 byte 数组)。
首先,咱们有一个简单的类,TransClass, 能够经过一个静态方法返回一个整数 1
public class TransClass {
public int getNumber() {
return 1;
}
}
复制代码
咱们运行以下类,能够获得输出 “1”:
public class TestMainInJar {
public static void main(String[] args) {
System.out.println(new TransClass().getNumber());
}
}
复制代码
而后,咱们将 TransClass 的 getNumber 方法改为以下:
public int getNumber() {
return 2;
}
复制代码
再将这个返回 2 的 Java 文件编译成类文件,为了区别开原有的返回 1 的类,咱们将返回 2 的这个类文件命名为 TransClass2.class.2。
接下来,咱们创建一个 Transformer 类:这个类实现了 ClassFileTransformer 接口
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;
public 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;
}
}
/** * 参数: * loader - 定义要转换的类加载器;若是是引导加载器,则为 null * className - 彻底限定类内部形式的类名称和 The Java Virtual Machine Specification 中定义的接口名称。例如,"java/util/List"。 * classBeingRedefined - 若是是被重定义或重转换触发,则为重定义或重转换的类;若是是类加载,则为 null * protectionDomain - 要定义或重定义的类的保护域 * classfileBuffer - 类文件格式的输入字节缓冲区(不得修改) * 返回: * 一个格式良好的类文件缓冲区(转换的结果),若是未执行转换,则返回 null。 * 抛出: * IllegalClassFormatException - 若是输入不表示一个格式良好的类文件 */
public byte[] transform(ClassLoader l, String className, Class<?> c,
ProtectionDomain pd, byte[] b) throws IllegalClassFormatException {
if (!className.equals("TransClass")) {
return null;
}
return getBytesFromFile(classNumberReturns2);
}
}
复制代码
其中,getBytesFromFile 方法根据文件名读入二进制字符流,而 ClassFileTransformer 当中规定的 transform 方法则完成了类定义的替换转换。
最后,咱们创建一个 Premain 类,写入 Instrumentation 的代理方法 premain:
public class Premain {
public static void premain(String agentArgs, Instrumentation inst) throws ClassNotFoundException, UnmodifiableClassException {
inst.addTransformer(new Transformer());
}
}
复制代码
能够看出,addTransformer 方法并无指明要转换哪一个类。转换发生在 premain 函数执行以后,main 函数执行以前,这时每装载一个类,transform 方法就会执行一次,看看是否须要转换,因此,在 transform(Transformer 类中)方法中,程序用 className.equals("TransClass") 来判断当前的类是否须要转换。
代码完成后,咱们将他们打包为 TestInstrument1.jar。返回 1 的那个 TransClass 的类文件保留在 jar 包中,而返回 2 的那个 TransClass.class.2 则放到 jar 的外面。在 manifest 里面加入以下属性来指定 premain 所在的类:
Manifest-Version: 1.0
Premain-Class: Premain
复制代码
在运行这个程序的时候,若是咱们用普通方式运行这个 jar 中的 main 函数,能够获得输出“1”。若是用下列方式运行:
java -javaagent:TestInstrument1.jar -cp TestInstrument1.jar TestMainInJar
复制代码
则会获得输出“2”。
固然,程序运行的 main 函数不必定要放在 premain 所在的这个 jar 文件里面,这里只是为了例子程序打包的方便而放在一块儿的。 除开用 addTransformer 的方式,Instrumentation 当中还有另一个方法“redefineClasses”来实现 premain 当中指定的转换。用法相似,以下:
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 的功能比较强大,能够批量转换不少类。
在 Java SE 5 当中,开发者只能在 premain 当中施展想象力,所做的 Instrumentation 也仅限与 main 函数执行前,这样的方式存在必定的局限性。
在 Java SE 5 的基础上,Java SE 6 针对这种情况作出了改进,开发者能够在 main 函数开始执行之后,再启动本身的 Instrumentation 程序。
在 Java SE 6 的 Instrumentation 当中,有一个跟 premain“并驾齐驱”的“agentmain”方法,能够在 main 函数开始运行以后再运行。跟 premain 函数同样, 开发者能够编写一个含有“agentmain”函数的 Java 类:
public static void agentmain (String agentArgs, Instrumentation inst); [1]
public static void agentmain (String agentArgs);[2]
复制代码
一样,[1] 的优先级比 [2] 高,将会被优先执行([1] 和 [2] 同时存在时,[2] 被忽略)。跟 premain 函数同样,开发者能够在 agentmain 中进行对类的各类操做。其中的 agentArgs 和 Inst 的用法跟 premain 相同。
与“Premain-Class”相似,开发者必须在 manifest 文件里面设置“Agent-Class”来指定包含 agentmain 函数的类。
但是,跟 premain 不一样的是,agentmain 须要在 main 函数开始运行后才启动,这样的时机应该如何肯定呢,这样的功能又如何实现呢?
在 Java SE 6 文档当中,开发者也许没法在 java.lang.instrument 包相关的文档部分看到明确的介绍,更加没法看到具体的应用 agnetmain 的例子。不过,在 Java SE 6 的新特性里面,有一个不太起眼的地方,揭示了 agentmain 的用法。这就是 Java SE 6 当中提供的 Attach API。
Attach API 不是 Java 的标准 API,而是 Sun 公司提供的一套扩展 API,用来向目标 JVM ”附着”(Attach)代理工具程序的。有了它,开发者能够方便的监控一个 JVM,运行一个外加的代理程序。
Attach API 很简单,只有 2 个主要的类,都在 com.sun.tools.attach 包里面:
VirtualMachine 表明一个 Java 虚拟机,也就是程序须要监控的目标虚拟机,提供了 JVM 枚举,Attach 动做和 Detach 动做(Attach 动做的相反行为,从 JVM 上面解除一个代理)等等 ;
VirtualMachine类,该类容许咱们 经过给attach方法传入一个jvm的pid(进程id),远程链接到jvm上 。而后咱们能够 经过loadAgent方法向jvm注册一个代理程序agent,在该agent的代理程序中会获得一个Instrumentation实例,该实例能够 在class加载前改变class的字节码,也能够在class加载后从新加载。在调用Instrumentation实例的方法时,这些方法会使用ClassFileTransformer接口中提供的方法进行处理。
VirtualMachineDescriptor 则是一个描述虚拟机的容器类,配合 VirtualMachine 类完成各类功能。
为了简单起见,咱们举例简化以下:依然用类文件替换的方式
- 将一个返回 1 的函数替换成返回 2 的函数,Attach API 写在一个线程里面,用睡眠等待的方式,每隔半秒时间检查一次全部的 Java 虚拟机,当发现有新的虚拟机出现的时候,就调用 attach 函数,随后再按照 Attach API 文档里面所说的方式装载 Jar 文件。等到 5 秒钟的时候,attach 程序自动结束。
- 在 main 函数里面,程序每隔半秒钟输出一次返回值(显示出返回值从 1 变成 2)。
TransClass 类和 Transformer 类的代码不变,参看上一节介绍。 含有 main 函数的 TestMainInJar 代码为:
// 程序每隔半秒钟输出一次返回值(显示出返回值从 1 变成 2)
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 类的代码为:
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 同样,能够批量转换类定义,多用于 agentmain 场合。
Jar 文件跟 Premain 那个例子里面的 Jar 文件差很少,也是把 main 和 agentmain 的类,TransClass,Transformer 等类放在一块儿,打包为“TestInstrument1.jar”,而 Jar 文件当中的 Manifest 文件为 :
Manifest-Version: 1.0
Agent-Class: AgentMain
复制代码
另外,为了运行 Attach API,咱们能够再写一个控制程序来模拟监控过程:
import com.sun.tools.attach.VirtualMachine;
import com.sun.tools.attach.VirtualMachineDescriptor;
……
// 一个运行 Attach API 的线程子类
// 每隔半秒时间检查一次全部的 Java 虚拟机
static class AttachThread extends Thread {
private final List<VirtualMachineDescriptor> listBefore;
private final String jar;
AttachThread(String attachJar, List<VirtualMachineDescriptor> vms) {
listBefore = vms; // 记录程序启动时的 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 有增长,咱们就认为是被监控的 VM 启动了
// 这时,咱们开始监控这个 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();
}
复制代码
运行时,首先运行上面这个启动新线程的 main 函数,而后,在 5 秒钟内(仅仅简单模拟 JVM 的监控过程)运行以下命令启动测试 Jar 文件 :
java –cp TestInstrument1.jar TestMainInJar
复制代码
若是时间掌握得不太差的话,程序首先会在屏幕上打出 1,这是改动前的类的输出,而后会打出一些 2,这个表示 agentmain 已经被 Attach API 成功附着到 JVM 上,代理程序生效了,固然,还能够看到“Agent Main Done”字样的输出。
在 JDK 1.5 版本的 instumentation 里,并无对Java本地方法(Native Method)的处理方式,并且在 Java 标准的 JVMTI 之下,并无办法改变 method signature, 这就使替换本地方法很是地困难。一个比较直接而简单的想法是,在启动时替换本地代码所在的动态连接库—— 可是这样,本质上是一种静态的替换,而不是动态的 Instrumentation。
并且,这样可能须要编译较大数量的动态连接库 —— 好比,咱们有三个本地函数,假设每个都须要一个替换,而在不一样的应用之下,可能须要不一样的组合,那么若是咱们把三个函数都编译在同一个动态连接库之中,最多咱们须要 8 个不一样的动态连接库来知足须要。固然,咱们也能够独立地编译之,那样也须要 6 个动态连接库——不管如何,这种繁琐的方式是不可接受的。
在 Java SE 6 中,新的 Native Instrumentation 提出了一个新的 native code 的解析方式,做为原有的 native method 的解析方式的一个补充,来很好地解决了一些问。这就是在新版本的 java.lang.instrument 包里,咱们拥有了对 native 代码的 instrument 方式 —— 设置 prefix。
假设咱们有了一个 native 函数,名字叫 nativeMethod,在运行过程当中,咱们须要将它指向另一个函数(须要注意的是,在当前标准的 JVMTI 之下,除了 native 函数名,其余的 signature 须要一致)。好比咱们的 Java 代码是:
package nativeTester;
class nativePrefixTester{
…
native int nativeMethod(int input);
…
}
复制代码
那么咱们已经实现的本地代码是 :
jint Java_nativeTester_nativeMethod(jclass thiz, jobject thisObj, jint input);
复制代码
如今咱们须要在调用这个函数时,使之指向另一个函数。那么按照 J2SE 的作法,咱们能够按他的命名方式,加上一个 prefix 做为新的函数名。好比,咱们以 "another_" 做为 prefix,那么咱们新的函数是 :
jint Java_nativeTester_another_nativePrefixTester(jclass thiz, jobject thisObj, jint input);
复制代码
而后将之编入动态连接库之中。 如今咱们已经有了新的本地函数,接下来就是作 instrument 的设置。正如以上所说的,咱们可使用 premain 方式,在虚拟机启动之时就载入 premain 完成 instrument 代理设置。也可使用 agentmain 方式,去 attach 虚拟机来启动代理。而设置 native 函数的也是至关简单的 :
premain(){ // 或者也能够在 agentmain 里
…
if (!isNativeMethodPrefixSupported()){
return; // 若是没法设置,则返回
}
setNativeMethodPrefix(transformer,"another_"); // 设置 native 函数的 prefix,注意这个下划线必须由用户本身规定
…
}
复制代码
在这里要注意两个问题:
不是在任何的状况下都是能够设置 native 函数的 prefix 的;首先,咱们要注意到 agent 包之中的 Manifest 所设定的特性 :
Can-Set-Native-Method-Prefix
复制代码
要注意,这一个参数均可以影响是否能够设置 native prefix,并且,在默认的设置之中,这个参数是 false 的,咱们须要将之设置成 true(顺便说一句,对 Manifest 之中的属性来讲都是大小写无关的,固然,若是给一个不是“true”的值,就会被看成 false 值处理)。
固然,咱们还须要确认虚拟机自己是否支持 setNativePrefix。在 Java API 里,Instrumentation 类提供了一个函数 isNativePrefix,经过这个函数咱们能够知道该功能是否能够实行。
咱们能够为每个 ClassTransformer 加上它本身的 nativeprefix:
每个 ClassTransformer 均可觉得同一个 class 作 transform,所以对于一个 Class 来讲,一个 native 函数可能有不一样的 prefix,所以对这个函数来讲,它可能也有好几种解析方式。 在 Java SE 6 当中,Native prefix 的解释方式以下:对于某一个 package 内的一个 class 当中的一个 native method 来讲,首先,假设咱们对这个函数的 transformer 设置了 native 的 prefix“another”,它将这个函数接口解释成 :
由 Java 的函数接口:
native void method() 复制代码
和上述 prefix"another",去寻找本地代码中的函数:
// 请注意 prefix 在函数名中出现的位置!
void Java_package_class_another_method(jclass theClass, jobject thiz);
复制代码
一旦能够找到,那么调用这个函数,整个解析过程就结束了;若是没有找到,那么虚拟机将会作进一步的解析工做。咱们将利用 Java native 接口最基本的解析方式 , 去找本地代码中的函数 :
void Java_package_class_method(jclass theClass, jobject thiz);
复制代码
若是找到,则执行之。不然,由于没有任何一个合适的解析方式,因而宣告这个过程失败。 那么若是有多个 transformer,同时每个都有本身的 prefix,又该如何解析呢?事实上,虚拟机是按 transformer 被加入到的 Instrumentation 之中的次序去解析的(还记得咱们最基本的 addTransformer 方法吗?)。 假设咱们有三个 transformer 要被加入进来,他们的次序和相对应的 prefix 分别为:transformer1 和“prefix1_”,transformer2 和 “prefix2_”,transformer3 和 “prefix3_”。那么,虚拟机会首先作的就是将接口解析为 :
native void prefix1_prefix2_prefix3_native_method() 复制代码
而后去找它相对应的 native 代码。 可是若是第二个 transformer(transformer2)没有设定 prefix,那么很简单,咱们获得的解析是:
native void prefix1_prefix3_native_method() 复制代码
这个方式简单而天然。 固然,对于多个 prefix 的状况,咱们还要注意一些复杂的状况。好比,假设咱们有一个 native 函数接口是:
native void native_method() 复制代码
而后咱们为它设置了两个 prefix,好比 "wrapped_" 和 "wrapped2_",那么,咱们获得的是什么呢?
// 这个函数名正确吗?
void Java_package_class_wrapped_wrapped2_method(jclass theClass, jobject thiz);
复制代码
答案是否认的,由于事实上,对 Java 中 native 函数的接口到 native 中的映射,有一系列的规定,所以可能有一些特殊的字符要被代入。而实际中,这个函数的正确的函数名是:
// 只有这个函数名会被找到
void Java_package_class_wrapped_1wrapped2_1method(jclass theClass, jobject thiz);
复制代码
颇有趣不是吗?所以若是咱们要作相似的工做,一个很好的建议是首先在 Java 中写一个带 prefix 的 native 接口,用 javah 工具生成一个 c 的 header-file,看看它实际解析获得的函数名是什么,这样咱们就能够避免一些没必要要的麻烦。
另一个事实是,与咱们的想像不一样,对于两个或者两个以上的 prefix,虚拟机并不作更多的解析;它不会试图去掉某一个 prefix,再来组装函数接口。它作且仅做两次解析。
总之,新的 native 的 prefix-instrumentation 的方式,改变了之前 Java 中 native 代码没法动态改变的缺点。在当前,利用 JNI 来写 native 代码也是 Java 应用中很是重要的一个环节,所以它的动态化意味着整个 Java 均可以动态改变了 —— 如今咱们的代码能够利用加上 prefix 来动态改变 native 函数的指向。
正如上面所说的,若是找不到,虚拟机还会去尝试作标准的解析,这让咱们拥有了动态地替换 native 代码的方式,咱们能够将许多带不一样 prefix 的函数编译在一个动态连接库之中,而经过 instrument 包的功能,让 native 函数和 Java 函数同样动态改变、动态替换。 固然,如今的 native 的 instrumentation 还有一些限制条件,好比,不一样的 transformer 会有本身的 native prefix,就是说,每个 transformer 会负责他所替换的全部类而不是特定类的 prefix —— 所以这个粒度可能不够精确。
咱们知道,经过设置系统参数或者经过虚拟机启动参数,咱们能够设置一个虚拟机运行时的 boot class 加载路径(-Xbootclasspath)和 system class(-cp)加载路径。固然,咱们在运行以后没法替换它。然而,咱们也许有时候要须要把某些 jar 加载到 bootclasspath 之中,而咱们没法应用上述两个方法;或者咱们须要在虚拟机启动以后来加载某些 jar 进入 bootclasspath。在 Java SE 6 之中,咱们能够作到这一点了。
实现这几点很简单,首先,咱们依然须要 确认虚拟机已经支持这个功能,而后在 premain/agantmain 之中加上须要的 classpath。咱们能够在premain/agentmain方法中 Instrumentation inst 里使用 appendToBootstrapClassLoaderSearch/appendToSystemClassLoaderSearch来完成这个任务。
同时咱们能够注意到,在 agent 的 mainfest 里加入 Boot-Class-Path 其实同样能够在动态地载入agent本身的 boot class 路径,固然,在 Java code 中它能够更加动态方便和智能地完成 —— 咱们能够很方便地加入判断和选择成分。
在这里咱们也须要注意几点:
首先,咱们加入到 classpath 的 jar 文件中不该当带有任何和系统的 instrumentation 有关的系统同名类,否则,一切都陷入不可预料之中 —— 这不是一个工程师想要获得的结果,不是吗?
其次,咱们要注意到虚拟机的 ClassLoader 的工做方式,它会记录解析结果。好比,咱们曾经要求读入某个类 someclass,可是失败了,ClassLoader 会记得这一点。即便咱们在后面动态地加入了某一个 jar,含有这个类,ClassLoader 依然会认为咱们没法解析这个类,与上次出错的相同的错误会被报告。
再次咱们知道在 Java 语言中有一个系统参数“java.class.path”,这个 property 里面记录了咱们当前的 classpath,可是,咱们使用这两个函数,虽然真正地改变了实际的 classpath,却不会对这个 property 自己产生任何影响。
在公开的 JavaDoc 中咱们能够发现一个颇有意思的事情,Sun 的设计师们告诉咱们,这个功能事实上依赖于 ClassLoader 的 appendtoClassPathForInstrumentation 方法 —— 这是一个非公开的函数,所以咱们不建议直接(使用反射等方式)使用它,事实上,instrument 包里的这两个函数已经能够很好的解决咱们的问题了。
如下是agent jar文件的Manifest Attributes清单:
- Premain-Class 若是 JVM 启动时指定了代理,那么此属性指定代理类,即包含 premain 方法的类。若是 JVM 启动时指定了代理,那么此属性是必需的。若是该属性不存在,那么 JVM 将停止。注:此属性是类名,不是文件名或路径。
- Agent-Class 若是实现支持 VM 启动以后某一时刻启动代理的机制,那么此属性指定代理类,即包含 agentmain 方法的类。 此属性是必需的,若是不存在,代理将没法启动。注:这是类名,而不是文件名或路径。
- Boot-Class-Path 设置引导类加载器搜索的路径列表。路径表示目录或库(在许多平台上一般做为 JAR 或 zip 库被引用)。查找类的特定于平台的机制失败后,引导类加载器会搜索这些路径。按列出的顺序搜索路径。列表中的路径由一个或多个空格分开。路径使用分层 URI 的路径组件语法。若是该路径以斜杠字符(“/”)开头,则为绝对路径,不然为相对路径。相对路径根据代理 JAR 文件的绝对路径解析。忽略格式不正确的路径和不存在的路径。若是代理是在 VM 启动以后某一时刻启动的,则忽略不表示 JAR 文件的路径。此属性是可选的。
- Can-Redefine-Classes 布尔值(true 或 false,与大小写无关)。是否能重定义此代理所需的类。true 之外的值均被视为 false。此属性是可选的,默认值为 false。
- Can-Retransform-Classes 布尔值(true 或 false,与大小写无关)。是否能重转换此代理所需的类。true 之外的值均被视为 false。此属性是可选的,默认值为 false。
- Can-Set-Native-Method-Prefix 布尔值(true 或 false,与大小写无关)。是否能设置此代理所需的本机方法前缀。true 之外的值均被视为 false。此属性是可选的,默认值为 false。
- addTransformer/removeTransformer:注册/删除ClassFileTransformer;
- retransformClasses:对于已经加载的类从新进行转换处理,即会触发从新加载类定义,须要注意的是,新加载的类不能修改旧有的类声明,譬如不能增长属性、不能修改方法声明;
- redefineClasses:与如上相似,但不是从新进行转换处理,而是直接把处理结果(bytecode)直接给JVM;
- getAllLoadedClasses:得到当前已经加载的Class,可配合retransformClasses使用;
- getInitiatedClasses:得到由某个特定的ClassLoader加载的类定义;
- getObjectSize:得到一个对象占用的空间,包括其引用的对象;
- appendToBootstrapClassLoaderSearch/appendToSystemClassLoaderSearch:增长BootstrapClassLoader/SystemClassLoader的搜索路径;
- isNativeMethodPrefixSupported/setNativeMethodPrefix:判断JVM是否支持拦截Native Method;