java调试体系之Java 调试接口（JDI）

Dear 丶 2023-05-29 13:03 26阅读 0赞

## JDI 简介 ##

JDI（Java Debug Interface）是 JPDA 三层模块中最高层的接口，定义了调试器（Debugger）所需要的一些调试接口。基于这些接口，调试器可以及时地了解目标虚拟机的状态，例如查看目标虚拟机上有哪些类和实例等。另外，调试者还可以控制目标虚拟机的执行，例如挂起和恢复目标虚拟机上的线程，设置断点等。

目前，大多数的 JDI 实现都是通过 Java 语言编写的。比如，Java 开发者再熟悉不过的 Eclipse IDE，它的调试工具相信大家都使用过。它的两个插件 org.eclipse.jdt.debug.ui 和 org.eclipse.jdt.debug 与其强大的调试功能密切相关，其中 org.eclipse.jdt.debug.ui 是 Eclipse 调试工具界面的实现，而 org.eclipse.jdt.debug 则是 JDI 的一个完整实现。

## JDI 工作方式 ##

首先，调试器（Debuuger）通过 Bootstrap 获取唯一的虚拟机管理器，见 清单 1。

清单 1. 获取虚拟机管理器（VirtualMachineManager）

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 </td> 
 <td> <code>VirtualMachineManager virtualMachineManager </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>= Bootstrap.virtualMachineManager();</code> </td> 
 </tr> 
 </tbody> 
</table>

虚拟机管理器将在第一次被调用时初始化可用的链接器。一般地，调试器会默认地采用启动型链接器进行链接，见 清单 2。

清单 2. 获取默认的链接器（Connector）

<table> 
 <tbody> 
 <tr> 
 <td> 1 </td> 
 <td> <code>LaunchingConnector defaultConnector = virtualMachineManager.defaultConnector();</code> </td> 
 </tr> 
 </tbody> 
</table>

然后，调试器调用链接器的 launch () 来启动目标程序，并完成调试器与目标虚拟机的链接，见 清单 3。

清单 3. 启动目标程序，连接调试器（Debuuger）与目标虚拟机（VirtualMachine）

<table> 
 <tbody> 
 <tr> 
 <td> 1 </td> 
 <td> <code>VirtualMachine targetVM = defaultConnector.launch(arguments);</code> </td> 
 </tr> 
 </tbody> 
</table>

当链接完成后，调试器与目标虚拟机便可以进行双向通信了。调试器将用户的操作转化为调试命令，命令通过链接被发送到前端运行目标程序的虚拟机上；然后，目标虚拟机根据接受的命令做出相应的操作，将调试的结果发回给后端的调试器；最后，调试器可视化数据信息反馈给用户。

从功能上，可以将 JDI 分成三个部分：数据模块，链接模块，以及事件请求与处理模块。数据模块负责调试器和目标虚拟机上的数据建模，链接模块建立调试器与目标虚拟机的沟通渠道，事件请求与处理模块提供调试器与目标虚拟机交互方式，下面将逐一地介绍它们。

## JDI 数据模块 ##

### Mirror ###

Mirror 接口是 JDI 最底层的接口，JDI 中几乎所有其他接口都继承于它。镜像机制是将目标虚拟机上的所有数据、类型、域、方法、事件、状态和资源，以及调试器发向目标虚拟机的事件请求等都映射成 Mirror 对象。例如，在目标虚拟机上，已装载的类被映射成 ReferenceType 镜像，对象实例被映射成 ObjectReference 镜像，基本类型的值（如 float 等）被映射成 PrimitiveValue（如 FloatValue 等）。被调试的目标程序的运行状态信息被映射到 StackFrame 镜像中，在调试过程中所触发的事件被映射成 Event 镜像（如 StepEvent 等），调试器发出的事件请求被映射成 EventRequest 镜像（如 StepRequest 等），被调试的目标虚拟机则被映射成 VirtualMachine 镜像。但是，JDI 并不保证目标虚拟机上的每份信息和资源都只有唯一的镜像与之对应，这是由 JDI 的具体实现所决定的。例如，目标虚拟机上的某个事件有可能存在多个 Event 镜像与之对应，例如 BreakpointEvent 等。

Mirror 实例或是由调试器创建，或是由目标虚拟机创建，调用 Mirror 实例 virtualMachine() 可以获取其虚拟机信息，如下所示。

清单 4. 获取 Mirror 对象实例的虚拟机

<table> 
 <tbody> 
 <tr> 
 <td> 1 </td> 
 <td> <code>VirtualMachine virtualMachine = mirror.virtualMachine();</code> </td> 
 </tr> 
 </tbody> 
</table>

返回的目标虚拟机对象实现了 VirtualMachine 接口，该接口提供了一套方法，可以用来直接或间接地获取目标虚拟机上所有的数据和状态信息，也可以挂起、恢复、终止目标虚拟机，详情见 图 1。

图 1. 虚拟机接口

![图 1. 虚拟机接口][1.]

这样，调试器便可以获取目标虚拟机上的信息，维持与目标虚拟机间的通信，并且检查，修改和控制目标虚拟机上资源等。

### Value 和 Type ###

Value 和 Type 接口分别代表着目标虚拟机中对象、实例变量和方法变量的值和类型。通过 Value 接口的 type()，可以获取该值对应的类型。JDI 中定义了两种基本的数据类型：原始类型（PrimitiveType）和引用类型（ReferenceType）。与其对应的数值类型分别是原始值（PrimtiveValue）和对象引用（ObjectReference）。Value 和 Type 的具体对应关系，请参见 表 1。

表 1. JDI 中 Value-Type 的对照表

<table> 
 <thead> 
 <tr> 
 <th colspan="2">(Value, Type)</th> 
 <th>说明</th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td>(PrimtiveValue, PrimtiveType)</td> 
 <td>(ByteValue, ByteType)</td> 
 <td>表示一个字节</td> 
 </tr> 
 <tr> 
 <td>(CharValue, CharType)</td> 
 <td>表示一个字符</td> 
 </tr> 
 <tr> 
 <td>(ShortValue, ShortType)</td> 
 <td>表示一个短整型数据</td> 
 </tr> 
 <tr> 
 <td>(IntegerValue, IntegerType)</td> 
 <td>表示一个整型数据</td> 
 </tr> 
 <tr> 
 <td>(LongValue, LongType)</td> 
 <td>表示一个长整型数据</td> 
 </tr> 
 <tr> 
 <td>(FloatValue, FloatType)</td> 
 <td>表示一个浮点型数据</td> 
 </tr> 
 <tr> 
 <td>(DoubleValue, DoubleType)</td> 
 <td>表示一个双精度浮点型数据</td> 
 </tr> 
 <tr> 
 <td>(BooleanValue, BooleanType)</td> 
 <td>表示一个布尔型数据</td> 
 </tr> 
 <tr> 
 <td>(ObjectReference, ReferenceType)</td> 
 <td>(ObjectReference, ReferenceType)</td> 
 <td>表示目标虚拟机上的一个对象</td> 
 </tr> 
 <tr> 
 <td>(ArrayReference, ArrayType)</td> 
 <td>表示目标虚拟机上的一个数组</td> 
 </tr> 
 <tr> 
 <td>(StringReference, ClassType)</td> 
 <td>表示目标虚拟机上的一个字符串对象</td> 
 </tr> 
 <tr> 
 <td>(ThreadReference, ClassType)</td> 
 <td>表示目标虚拟机上的一个线程对象，有一套方法可以获得当前设置的断点，堆栈，也能挂起和恢复该线程等</td> 
 </tr> 
 <tr> 
 <td>(ThreadGroupReference, ClassType)</td> 
 <td>表示目标虚拟机上的一个线程组对象</td> 
 </tr> 
 <tr> 
 <td>(ClassObjectReference, ClassType)</td> 
 <td>表示目标虚拟机上的一个类的 java.lang.Class 实例</td> 
 </tr> 
 <tr> 
 <td>(ClassLoaderReference, ClassType)</td> 
 <td>表示目标虚拟机上的一个 ClassLoader 对象</td> 
 </tr> 
 <tr> 
 <td colspan="2">(VoidValue, VoidType)</td> 
 <td>表示 void 类型</td> 
 </tr> 
 </tbody> 
</table>

PrimitiveType 包括 Java 的 8 种基本类型，ReferenceType 包括目标虚拟机中装载的类，接口和数组的类型（数组也是一种对象，有自己的对象类型）。ReferenceType 有三种子接口：ClassType 对应于加载的类，InterfaceType 对应于接口，ArrayType 对应于数组。另外，ReferenceType 还提供了一组方法，可以用来获取该类型中声明的所有变量、方法、静态变量的取值、内嵌类、运行实例、行号等信息。

PrimtiveValue 封装了 PrimitiveType 的值，它提供一组方法可将 PrimtiveValue 转化为 Java 原始数据。例如，IntegerValue 的 value () 将返回一个 int 型数据。对应地，VirtualMachine 也提供了一组方法，用以将 Java 原始数据转化为 PrimtiveValue 型数据。例如 mirrorOf(float value) 将给定的 float 数据转化为 FloatValue 型数据。

ObjectReference 封装了目标虚拟机中的对象，通过 getValue() 和 setValue() 方法可以访问和修改对象中变量的值，通过 invokeMethod() 可以调用该对象中的指定方法，通过 referringObjects() 可以获得直接引用该对象的其他对象，通过 enableCollection() 和 disableCollection() 可以允许和禁止 GC 回收该对象。

### TypeComponent ###

TypeComponent 接口表示 Class 或者 Interface 所声明的实体（Entity），它是 Field 和 Method 接口的基类。Field 表示一个类或者实例的变量，调用其 type() 可返回域的类型。Method 表示一个方法。TypeComponent 通过方法 declaredType() 获得声明该变量或方法的类或接口，通过 name() 获得该变量或者方法的名字（对于 Field 返回域名，对于一般方法返回方法名，对于类构造函数返回 <init>，对于静态初始化构造函数返回 <clinit>）。

## JDI 的链接模块 ##

链接是调试器与目标虚拟机之间交互的渠道，一次链接可以由调试器发起，也可以由被调试的目标虚拟机发起。一个调试器可以链接多个目标虚拟机，但一个目标虚拟机最多只能链接一个调试器。链接是由链接器（Connector）生成的，不同的链接器封装着不同的链接方式。JDI 中定义三种链接器接口，分别是依附型链接器（AttachingConnector）、监听型链接器（ListeningConnector）和启动型链接器（LaunchingConnector）。在调试过程中，实际使用的链接器必须实现其中一种接口。

根据调试器在链接过程中扮演的角色，可以将链接方式划分为主动链接和被动链接。主动链接是较常见一种链接方式，表示调试器主动地向目标虚拟机发起链接。下面将举两个主动链接的例子：

由调试器启动目标虚拟机的链接方式：这是最常见、最简单的一种链接方式。

*  调试器调用 VirtualMachineManager 的 launchingConnectors() 方法获取所有的启动型链接器实例；
 *  根据传输方式或其他特征选择一个启动型链接器，调用其 launch() 方法启动和链接目标虚拟机；
 *  启动后，返回目标虚拟机的实例。

更高级的，当目标虚拟机已处于运行状态时，可以采用调试器 attach 到目标虚拟机的链接方式：

*  目标虚拟机必须以 -agentlib:jdwp=transport=xxx,server=y 参数启动，并根据传输方式生成监听地址；（其中，xxx 是传输方式，可以是 dt\_socket 和 share\_memory）
 *  调试器启动，调用 VirtualMachineManager 的 attachingConnectors() 方法获取所有的依附型链接器实例；
 *  根据目标虚拟机采用的传输方式选择一个依附型链接器，调用其 attach() 方法依附到目标虚拟机上；
 *  完成链接后，返回目标虚拟机的实例。

被动链接表示调试器将被动地等待或者监听由目标虚拟机发起的链接，同样也举两个被动链接的例子：

目标虚拟机 attach 到已运行的调试器上的链接方式：

*  调试器通过 VirtualMachineManager 的 listeningConnectors() 方法获取所有的监听型链接器实例；
 *  为每种传输类型分别选定一个链接器，然后调用链接器的 startListening() 方法让链接器进入监听状态；
 *  通过 accept() 方法通知链接器开始等待正确的入站链接，该方法将返回调试器正在监听的地址描述符；
 *  终端用户以 -agentlib:jdwp=transport=xxx,address=yyy 参数启动目标虚拟机（其中，yyy 是调试器的监听地址）；
 *  目标虚拟机会自动地 attach 到调试器上建立链接，然后返回目标虚拟机的实例。

即时（Just-In-Time）链接方式：

*  以 -agentlib:jdwp=launch=cmdline,onuncaught=y,transport=xxx,server=y 参数启动目标虚拟机；
 *  虚拟机将抛出一个未捕获的异常，同时生成特定于 xxx 传输方式的监听地址，用于确立一次链接；
 *  目标虚拟机启动调试器，并告知调试器传输方式和监听地址；
 *  启动后，调试器调用 VirtualMachineManager 的 attachingConnectors() 方法获取所有依附型链接器实例；
 *  根据指定的 xxx 传输方式，选择一个链接器；
 *  调用链接器的 attach 方法依附到对应地址的目标虚拟机上；
 *  完成链接后，返回目标虚拟机的实例。

Connector.Argument 是 Connector 的内嵌接口，表示链接器的一个参数，不同类型的链接器支持不同的链接器参数，LaunchingConnector 支持 home，main，suspend 等，AttachingConnector 和 ListeningConnector 支持 timeout，hostname，port 等参数，见 表 2。

表 2. 常见的链接器参数

<table> 
 <thead> 
 <tr> 
 <th>Connector 类型</th> 
 <th>参数名称</th> 
 <th>说明</th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td>LaunchingConnector</td> 
 <td>home</td> 
 <td>表示 java.home 的值，指向 JRE</td> 
 </tr> 
 <tr> 
 <td>main</td> 
 <td>表示所要执行的 Java 类的类名</td> 
 </tr> 
 <tr> 
 <td>options</td> 
 <td>表示使用的 Java 命令行参数</td> 
 </tr> 
 <tr> 
 <td>suspend</td> 
 <td>表示是否在启动目标虚拟机后挂起虚拟机</td> 
 </tr> 
 <tr> 
 <td>AttachingConnector ListeningConnector</td> 
 <td>hostname</td> 
 <td>表示被链接一端的地址</td> 
 </tr> 
 <tr> 
 <td>port</td> 
 <td>表示被链接一端的端口</td> 
 </tr> 
 <tr> 
 <td>timeout</td> 
 <td>表示等待链接的时间</td> 
 </tr> 
 </tbody> 
</table>

下面将举一个简单例子，描述如何设置 main 链接参数，并启动目标虚拟机。首先，调用链接器的 defaultArguments() 获取该链接器所支持的一组默认参数，见 清单 5。

清单 5. 获取链接器的默认参数

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 </td> 
 <td> <code>Map&lt;</code><code>String</code><code>,Connector.Argument&gt; defaultArguments </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>= connector.defaultArguments();</code> </td> 
 </tr> 
 </tbody> 
</table>

默认参数存储在一个 Key-Value 对的 Map 中，Key 是该链接器参数的唯一标识符（对终端用户不可见），Value 是对应的 Connector.Argument 实例（包括具体参数的信息和默认值）。返回的 Map 不能再新增或者删除元素，只能修改已有元素的值。

然后，从返回的 Map 中获取标识符为 main 的链接器参数，如 清单 6。

清单 6. 返回链接器的 main 参数

<table> 
 <tbody> 
 <tr> 
 <td> 1 </td> 
 <td> <code>Connector.Argument mainArgument = defaultArguments.get(“main”);</code> </td> 
 </tr> 
 </tbody> 
</table>

最后，将 main 参数值设置为 com.ibm.jdi.test.HelloWorld，以修改后的参数启动目标虚拟机，见 清单 7。

清单 7. 设置 main 参数的值并启动虚拟机

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 </td> 
 <td> <code>mainArgument.setValue(“com.ibm.jdi.test.HelloWorld”);</code> <code>VirtualMachine targetVM = connector.launch(defaultArguments);</code> </td> 
 </tr> 
 </tbody> 
</table>

## JDI 事件请求和处理模块 ##

### JDI 事件分类 ###

JDI 的 com.sun.jdi.event 包定义了 18 种事件类型，如 表 3 所示。其中，与 Class 相关的有 ClassPrepareEvent 和 ClassUnloadEvent；与 Method 相关的有 MethodEntryEvent 和 MethodExitEvent；与 Field 相关的有 AccessWatchpointEvent 和 ModificationWatchpointEvent；与虚拟机相关的有 VMDeathEvent，VMDisconnectEvent 和 VMStartEvent 等。

表 3. JDI 中的事件类型

<table> 
 <thead> 
 <tr> 
 <th colspan="1">事件类型</th> 
 <th colspan="1">描述</th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td>ClassPrepareEvent</td> 
 <td>装载某个指定的类所引发的事件</td> 
 </tr> 
 <tr> 
 <td>ClassUnloadEvent</td> 
 <td>卸载某个指定的类所引发的事件</td> 
 </tr> 
 <tr> 
 <td>BreakingpointEvent</td> 
 <td>设置断点所引发的事件</td> 
 </tr> 
 <tr> 
 <td>ExceptionEvent</td> 
 <td>目标虚拟机运行中抛出指定异常所引发的事件</td> 
 </tr> 
 <tr> 
 <td>MethodEntryEvent</td> 
 <td>进入某个指定方法体时引发的事件</td> 
 </tr> 
 <tr> 
 <td>MethodExitEvent</td> 
 <td>某个指定方法执行完成后引发的事件</td> 
 </tr> 
 <tr> 
 <td>MonitorContendedEnteredEvent</td> 
 <td>线程已经进入某个指定 Monitor 资源所引发的事件</td> 
 </tr> 
 <tr> 
 <td>MonitorContendedEnterEvent</td> 
 <td>线程将要进入某个指定 Monitor 资源所引发的事件</td> 
 </tr> 
 <tr> 
 <td>MonitorWaitedEvent</td> 
 <td>线程完成对某个指定 Monitor 资源等待所引发的事件</td> 
 </tr> 
 <tr> 
 <td>MonitorWaitEvent</td> 
 <td>线程开始等待对某个指定 Monitor 资源所引发的事件</td> 
 </tr> 
 <tr> 
 <td>StepEvent</td> 
 <td>目标应用程序执行下一条指令或者代码行所引发的事件</td> 
 </tr> 
 <tr> 
 <td>AccessWatchpointEvent</td> 
 <td>查看类的某个指定 Field 所引发的事件</td> 
 </tr> 
 <tr> 
 <td>ModificationWatchpointEvent</td> 
 <td>修改类的某个指定 Field 值所引发的事件</td> 
 </tr> 
 <tr> 
 <td>ThreadDeathEvent</td> 
 <td>某个指定线程运行完成所引发的事件</td> 
 </tr> 
 <tr> 
 <td>ThreadStartEvent</td> 
 <td>某个指定线程开始运行所引发的事件</td> 
 </tr> 
 <tr> 
 <td>VMDeathEvent</td> 
 <td>目标虚拟机停止运行所以的事件</td> 
 </tr> 
 <tr> 
 <td>VMDisconnectEvent</td> 
 <td>目标虚拟机与调试器断开链接所引发的事件</td> 
 </tr> 
 <tr> 
 <td>VMStartEvent</td> 
 <td>目标虚拟机初始化时所引发的事件</td> 
 </tr> 
 </tbody> 
</table>

不同的事件需要被分类地添加到不同的事件集合（EventSet）中，事件集是事件发送的最小单位。事件集一旦创建出来，便不可再被修改。JDI 定义了一些规则，用以规定应该如何将事件分别加入到不同的事件集中：

*  每个 VMStartEvent 事件应该分别加入到单独的一个事件集中；
 *  每个 VMDisconnectEvent 事件应该分别加入到单独的一个事件集中；
 *  所有的 VMDeathEvent 事件应该加入到同一个事件集中；
 *  同一线程的 ThreadStartEvent 事件应该加入到同一事件集中；
 *  同一线程的 ThreadDeathEvent 事件应该加入到同一事件集中；
 *  同一类型的 ClassPrepareEvent 事件应该加入到同一个事件集中；
 *  同一类型的 ClassUnloadEvent 事件应该加入到同一个事件集中；
 *  同一 Field 的 AccessWatchpointEvent 事件应该加入到同一个事件集中；
 *  同一 Field 的 ModificationWatchpointEvent 事件应该加入到同一个事件集中；
 *  同一异常的 ExceptionEvent 事件应该加入到同一个事件集中；
 *  同一方法的 MethodExitEvents 事件应该加入到同一个事件集中；
 *  同一 Monitor 的 MonitorContendedEnterEvent 事件应该加入到用一个事件集中；
 *  同一 Monitor 的 MonitorContendedEnteredEvent 事件应该加入到用一个事件集中；
 *  同一 Monitor 的 MonitorWaitEvent 事件应该加入到同一个事件集中
 *  同一 Monitor 上的 MonitorWaitedEvent 事件应该加入到同一个事件集中
 *  在同一线程执行过程中，具有相同行号信息的 BreakpointEvent、StepEvent 和 MethodEntryEvent 事件应该加入到同一个事件集合中。

生成的事件集将被依次地加入到目标虚拟机的事件队列（EventQueue）中。然后，EventQueue 将这些事件集以“先进先出”策略依次地发送到调试器端。EventQueue 负责管理来自目标虚拟机的事件，一个被调试的目标虚拟机上有且仅有一个 EventQueue 实例。特别地，随着一次事件集的发送，目标虚拟机上可能会有一部分的线程因此而被挂起。如果一直不恢复这些线程，有可能会导致目标虚拟机挂机。因此，在处理好一个事件集中的事件后，建议调用事件集的 resume() 方法，恢复所有可能被挂起的线程。

### JDI 事件请求 ###

Event 是 JDI 中所有事件接口的父接口，它只定义了一个 request() 方法，用以返回由调试器发出的针对该事件的事件请求（EventRequest）。事件请求是由调试器向目标虚拟机发出的，目的是请求目标虚拟机在发生指定的事件后通知调试器。只有当调试器发出的请求与目标虚拟机上发生的事件契合时，这些事件才会被分发到各个事件集，进而等待发送至调试器端。在 JDI 中，每一种事件类型都对应着一种事件请求类型。一次事件请求可能对应有多个事件实例，但不是每个事件实例都存在与之对应的事件请求。例如，对于某些事件（如 VMDeathEvent，VMDisconnectEvent 等），即使没有对应的事件请求，这些事件也必定会被发送给调试器端。

另外，事件请求还支持过滤功能。通过给 EventRequest 实例添加过滤器（Filter），可以进一步筛选出调试器真正感兴趣的事件实例。事件请求支持多重过滤，通过 EventRequest 的 add\*Filter() 方法可以添加多个过滤器。多个过滤器将共同作用，最终只有满足所有过滤条件的事件实例才会被发给调试器。常用的过滤器有：

*  线程过滤器：用以过滤出指定线程中发生的事件；
 *  类型过滤器：用以过滤出指定类型中发生的事件；
 *  实例过滤器：用以过滤出指定实例中发生的事件；
 *  计数过滤器：用以过滤出发生一定次数的事件；

过滤器提供了一些附加的限制条件，减少了最终加入到事件队列的事件数量，从而提高了调试性能。除了过滤功能，还可以通过它的 setSuspendPolicy(int) 设置是否需要在事件发生后挂起目标虚拟机。

事件请求是由事件请求管理器（EventRequestManager）进行统一管理的，包括对请求的创建和删除。一个目标虚拟机中有且仅有一个 EventRequestManager 实例。通常，一个事件请求实例有两种状态：激活态和非激活态。非激活态的事件请求将不起任何作用，即使目标虚拟机上有满足此请求的事件发生，目标虚拟机将不做停留，继续执行下一条指令。由 EventRequestManager 新建的事件请求都是非激活的，需要调用 setEnable(true) 方法激活该请求，而通过 setEnable(false) 则可废除该请求，使其转化为非激活态。

### JDI 事件处理 ###

下面将介绍 JDI 中调试器与目标虚拟机事件交互的方式。首先，调试器调用目标虚拟机的 eventQueue() 和 eventRequestManager() 分别获取唯一的 EventQueue 实例和 EventRequestManager 实例。然后，通过 EventRequestManager 的 createXxxRequest() 创建需要的事件请求，并添加过滤器和设置挂起策略。接着，调试器将从 EventQueue 获取来自目标虚拟机的事件实例。

一个事件实例中包含着事件发生时目标虚拟机的一些状态信息。以 BreakpointEvent 为例：

调用 BreakpointEvent 的 thread() 可以获取产生事件的线程镜像（ThreadReference），调用 ThreadReference 的 frame(int) 可获得当前代码行所在的堆栈（StackFrame），调用 StackFrame 的 visibleVariables() 可获取当前堆栈中的所有本地变量（LocaleVariable）。通过调用 BreakpointEvent 的 location() 可获得断点所在的代码行号（Location），调用 Location 的 method() 可获得当前代码行所归属的方法。通过以上调用，调试器便可获得了目标虚拟机上线程、对象、变量等镜像信息。

另外，根据从事件实例中获取的以上信息，调试器还可以进一步控制目标虚拟机。例如，可以调用 ObjectReference 的 getValue() 和 setValue() 访问和修改对象中封装的 Field 或者 LocalVariable 等，进而影响虚拟机的行为。更多的 JDI 的事件处理的详情，请参见图 2。

图 2. JDI 事件处理框架（[查看大图][Link 1]）

![图 2. JDI 事件处理框架][2. JDI]

## 一个 JDI 的简单实例 ##

下面给出一个简单例子，说明如何实现 JDI 的部分接口来提供一个简易的调试客户端。首先是被调试的 Java 类，这里给出一个简单的 Hello World 程序，main 方法第一行声明一个“Hello World!”的字符串变量，第二行打印出这个字符串的内容，见 清单 8。

清单 8. HelloWorld 类文件

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 </td> 
 <td> <code>package com.ibm.jdi.test;</code> &nbsp; <code>public class HelloWorld { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public static void main(String[] args) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>String str = "Hello world!";</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>System.out.println(str);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

接着是一个简单的调试器实现 SimpleDebugger，清单 9 列出了实现该调试器所需要导入的类库和变量。简单起见，所有的变量都声明为静态全局变量。这些变量分别代表了目标虚拟机镜像，目标虚拟机所在的进程，目标虚拟机的事件请求管理器和事件对列。变量 vmExit 标志目标虚拟机是否中止。

清单 9. SimpleDebugger 导入的类和声明的全局变量

随后是 SimpleDebugger 的 main() 方法，见 清单 10。首先从 VirtualMachineManager 获取默认的 LaunchingConnector，然后从该 Connector 取得默认的参数。接着，设置 main 和 suspend 参数，使得目标虚拟机运行 com.ibm.jdi.test.HelloWorld 类，并随后进入挂起状态。下一步，调用 LaunchingConnector.launch() 启动目标虚拟机，返回目标虚拟机的镜像实例，并且获取运行目标虚拟机的进程（ Process）。

然后，创建一个 ClassPrepareRequest 事件请求。当 com.ibm.jdi.test.HelloWorld 被装载时，目标虚拟机将发送对应的 ClassPrepareEvent 事件。事件处理完成后，通过 process 的 destroy() 方法销毁目标虚拟机进程，结束调试工作。

清单 10. SimpleDebugger 的 main() 方法

下面是 eventLoop() 函数的实现：首先获取目标虚拟机的事件队列，然后依次处理队列中的每个事件。当 vmExit（初始值为 false）标志为 true 时，结束循环。

清单 11. SimpleDebugger 的 eventLoop() 的实现

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 </td> 
 <td> <code>private static void eventLoop() throws Exception { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>eventQueue = vm.eventQueue();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>while (true) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if (vmExit == true) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>break;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>eventSet = eventQueue.remove();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>EventIterator eventIterator = eventSet.eventIterator();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>while (eventIterator.hasNext()) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>Event event = (Event) eventIterator.next();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>execute(event);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

具体事件的处理是由 execute(Event) 实现的，这里主要列举出 ClassPreparEvent 和 BreakpointEvent 事件的处理用法，请参见 清单 12。

清单 12. SimpleDebugger 的 execute () 方法

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 </td> 
 <td> <code>private static void execute(Event event) throws Exception { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if (event instanceof VMStartEvent) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>System.out.println("VM started");</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>eventSet.resume();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>} else if (event instanceof ClassPrepareEvent) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>ClassPrepareEvent classPrepareEvent = (ClassPrepareEvent) event;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>String mainClassName = classPrepareEvent.referenceType().name();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if (mainClassName.equals("com.ibm.jdi.test.HelloWorld")) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>System.out.println("Class " + mainClassName</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>+ " is already prepared");</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if (true) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// Get location</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>ReferenceType referenceType = prepareEvent.referenceType();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>List locations = referenceType.locationsOfLine(10);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>Location location = (Location) locations.get(0);</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// Create BreakpointEvent</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>BreakpointRequest breakpointRequest = eventRequestManager</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>.createBreakpointRequest(location);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>breakpointRequest.setSuspendPolicy(EventRequest.SUSPEND_ALL);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>breakpointRequest.enable();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>eventSet.resume();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>} else if (event instanceof BreakpointEvent) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>System.out.println("Reach line 10 of com.ibm.jdi.test.HelloWorld");</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>BreakpointEvent breakpointEvent = (BreakpointEvent) event;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>ThreadReference threadReference = breakpointEvent.thread();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>StackFrame stackFrame = threadReference.frame(0);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>LocalVariable localVariable = stackFrame</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>.visibleVariableByName("str");</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>Value value = stackFrame.getValue(localVariable);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>String str = ((StringReference) value).value();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>System.out.println("The local variable str at line 10 is " + str</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>+ " of " + value.type().name());</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>eventSet.resume();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>} else if (event instanceof VMDisconnectEvent) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>vmExit = true;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>} else { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>eventSet.resume();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

最后列出了以上程序的运行结果，见 清单 13。

清单 13. 运行结果

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 </td> 
 <td> <code>VM started</code> <code>Class com.ibm.jdi.test.HelloWorld is already prepared</code> <code>Reach line 10 of com.ibm.jdi.test.HelloWorld</code> <code>The local variable str at line 10 is Hello world! of java.lang.String</code> </td> 
 </tr> 
 </tbody> 
</table>

## 结束语 ##

本文介绍了 Java 调试接口（JDI）的体系结构和工作方式，JDI 是 JPDA 体系结构的调试器后端接口，开发人员通过使用它所提供的接口与 JDWP（Java 调试线协议）前端 Agent 通信，以这种方式访问和控制被调试的目标虚拟机。最后，本文希望能够帮助开发人员在无须掌握 JPDA 的技术细节的情况下，能够编写出实用、高效的 Java 调试器程序。

[1.]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly93d3cuaWJtLmNvbS9kZXZlbG9wZXJ3b3Jrcy9jbi9qYXZhL2otbG8tanBkYTQvaW1hZ2UwMDEucG5n?x-oss-process=image/format,png
[Link 1]: https://www.ibm.com/developerworks/cn/java/j-lo-jpda4/origin_image002.png
[2. JDI]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly93d3cuaWJtLmNvbS9kZXZlbG9wZXJ3b3Jrcy9jbi9qYXZhL2otbG8tanBkYTQvaW1hZ2UwMDIucG5n?x-oss-process=image/format,png