使用 Eclipse 远程调试 Java 应用程序
先决条件
如果您还没安装该程序，请下载 Eclipse V3.4（Ganymede）。在 Ganymede 中，套接字（socket）监听连接器被添加到 Remote Java Application 启动配置类型。Eclipse 最新的套接字监听连接器允许您打开 Java 调试器，它能够监听特定套接字上的连接。可以从命令行选项打开被调试的程序，并将其连接到调试器。在 Ganymede 发布之前，仅有一个连接套接字的连接器，被调试的程序所在的机器必须是一个与调试器相连的调试主机。由于受到内存和 CPU 不足的限制，要想让移动设备充当主机是不现实的。
为了进行远程调试，必须使用 Java Virtual Machine (JVM) V5.0 或更新版本，比如 IBM® J9 或 Sun Microsystem 的 Java SE Development Kit（JDK）。本文主要讨论远程调试，而不是每个 Eclipse 调试特性的细节。查看参考资料 获得更多关于使用 Eclipse 进行调试的信息，并且可以找到上面提到的软件。
JPDA 简介
Sun Microsystem 的 Java Platform Debugger Architecture (JPDA) 技术是一个多层架构，使您能够在各种环境中轻松调试 Java 应用程序。JPDA 由两个接口（分别是 JVM Tool Interface 和 JDI）、一个协议（Java Debug Wire Protocol）和两个用于合并它们的软件组件（后端和前端）组成。它的设计目的是让调试人员在任何环境中都可以进行调试。JPDA 不仅能够用于桌面系统，而且能够在嵌入式系统上很好地工作。
JVM Tool Interface (JVMTI) 规定必须为调试提供 VM（编辑注：从 Java V5 开始，将用 JVMTI 代替 Java V1.4 中的 JVMDI）。Java Debug Wire Protocol (JDWP) 描述调试信息的格式，以及在被调试的进程和调试器前端之间传输的请求，调试器前端实现 JDI，比如 Eclipse、Borland JBuilder 等。根据 Sun 的 JPDA 规范，被调试的程序常常称为debuggee。JDI 是一个高级的接口，它定义用于远程调试的信息和请求。下面给出了调试器的架构。
清单 1. Java 平台调试器架构
Components Debugger Interfaces
/ |--------------|
/ | VM |
debuggee -----( |--------------| <---- JVMTI - Java VM Tool Interface
\ | back-end |
\ |--------------|
/ |
comm channel --( | <------------ JDWP - Java Debug Wire Protocol
\ |
/ |--------------|
/ | front-end |
debugger -----( |--------------| <---- JDI - Java Debug Interface
\ | UI |
\ |--------------|
|
因此，任何第三方工具和基于 JPDA 的 VM 应该都能协调工作。通过这个客户机-服务器架构，您可以从运行该平台的本地工作站调试 Java 程序，甚至还可以通过网络进行远程调试。
在讨论调试场景之前，我们先了解 JPDA 规范中的两个术语：连接器和传输。连接器是一个 JDI 抽象，用来在调试器应用程序和目标 VM 之间建立连接。传输定义应用程序如何进行访问，以及数据如何在前端和后端之间传输。连接器 “映射” 到可用的传输类型和连接模式。在 Sun 的 JPDA 参考实现中，为 Microsoft® Windows® 提供了两个传输机制：套接字传输和共享内存传输。可用的连接器：
- 连接套接字连接器
- 连接共享内存连接器
- 监听套接字连接器
- 监听共享内存连接器
- 启动命令行连接器
在调试器应用程序和目标 VM 之间建立连接时，有一端将用作服务器并监听连接。随后，另一端将连接到监听器并建立一个连接。通过连接，调试器应用程序或目标 VM 都可以充当服务器。进程之间的通信可以在同一个机器或不同的机器上运行。
要远程调试 Java 程序，难点不是在调试器的前端，而是远程 Java 后端。不幸的是，Eclipse 帮助系统中为这方面提供的信息并不多。事实上，JDI 和 JVMTI 是分别由 Eclipse 和 Java 运行时环境实现的。我们仅需要考虑 JDMP，因为它包含与 JVMTI 和 JDI 进行通信所需的信息。JDWP 包含许多参数，用于为远程 Java 应用程序调用所需的程序。以下是本文用到的一些参数。
- -Xdebug
- 启用调试特性。
- -Xrunjdwp:<sub-options>
- 在目标 VM 中加载 JDWP 实现。它通过传输和 JDWP 协议与独立的调试器应用程序通信。下面介绍一些特定的子选项。
从 Java V5 开始，您可以使用 -agentlib:jdwp 选项，而不是 -Xdebug 和 -Xrunjdwp。但如果连接到 V5 以前的 VM，只能选择-Xdebug 和-Xrunjdwp。下面简单描述 -Xrunjdwp 子选项。
- transport
- 这里通常使用套接字传输。但是在 Windows 平台上也可以使用共享内存传输。
- server
- 如果值为 y，目标应用程序监听将要连接的调试器应用程序。否则，它将连接到特定地址上的调试器应用程序。
- address
- 这是连接的传输地址。如果服务器为 n，将尝试连接到该地址上的调试器应用程序。否则，将在这个端口监听连接。
- suspend
- 如果值为 y，目标 VM 将暂停，直到调试器应用程序进行连接。
要获得每个调试设置的详细解释，请参考 JPDA 文档（参见 参考资料）。
清单 2 是一个示例，显示如何在调试模式下启动 VM 并监听端口 8765 的套接字连接。
清单 2. 作为调试服务器的目标 VM
-Xdebug -Xrunjdwp:transport=dt_socket,server=y,address=8765 |
清单 3 显示如何使用位于 8000 端口的主机 127.0.0.1 上的套接字连接运行中的调试器应用程序。
清单 3. 作为调试客户机的目标 VM
-Xdebug -Xrunjdwp:transport=dt_socket,address=127.0.0.1:8000 |
回页首
Eclipse 中的远程调试特性
Eclipse 是一个图形化 Java 调试器前端。JDI 在 org.eclipse.jdt.debug 包中实现。本文不详细讨论 JDI 实现。参见 参考资料 获得关于 Eclipse JDT 和 Java JDI 技术的信息。
我们首先应该知道要使用哪个 Eclipse 连接器。要了解 Eclipse 提供的远程连接类型，您可以转到 Eclipse 菜单并选择 Run > Debug Configurations...，在Remote Java Application 中添加一个启动配置，然后从下拉列表中选择连接器。在 Ganymede 中共有两个连接器：
- Socket Attach
- Socket Listen
对于监听套接字的连接器，Eclipse VM 将是与远程 Java 应用程序连接的主机。对于连接套接字的连接器，目标 VM 将作为主机。这两种连接器对应用程序调试没有影响，用户可以任意选择。但根据经验，需要使用速度更快、更强大的计算机作为 VM 调试主机，因为需要计算的资源很多。
在调试 Java 应用程序之前，需要确保已经为远程应用程序启用所有调试选项。如果选项信息不可用，您将收到一个错误信息，比如 “Debug information is not available” 或 “Unable to install breakpoint due to missing line number”。您可以通过更改 Eclipse 菜单上的Window > Preferences > Java > Compiler 来修改设置。
图 1. Eclipse 中的调试选项
回页首
远程调试应用程序
现在，我们已经准备好远程调试应用程序。我们分步执行：
- 1. 使用简单类创建一个 Java 项目
- 我们为调试创建一个简单类。清单 4 给出了示例代码。
清单 4. 调试示例代码
package com.ibm.developerWorks.debugtest;
public class test {
public static void main(String[] args) {
System.out.println("This is a test.");
}
}
|
- 2. 设置一个断点
-
在代码中设置一个断点。在这个例子中，我们在
System.out.println("This is a test.");这行中设置断点。
图 2. 在 Eclipse 中设置断点
- 3. 从本地调试应用程序
- 在调试应用程序之前，确保已经为项目启用图 1 中描述的调试选项。从本地调试应用程序是没有必要的，但是这可以确保是否所有调试信息都可用。右键单击 Java 项目，并选择 Debug As，然后选择 Java Application（参见图 3）。如果应用程序在断点处停止执行，则表明调试信息正确显示。这时，可以继续使用这些调试特性，比如显示调试堆栈、变量或断点管理等等。
图 3. 从本地调试应用程序
- 4. 导出 Java 项目
- 我们将使用这个应用程序作为调试目标。右键单击 Java 项目，选择 Export，然后选择 Java，最后选择 JAR file 或 Runnable JAR file 导出项目。将在指定的位置生成 JAR 文件。注意，如果 Java 源代码与目标应用程序不匹配，调试特性将不能正常工作。
- 5. 手动运行 Java 应用程序
- 打开控制台手动启动应用程序，确保正确配置了 Java 运行时环境。
清单 5. 调用 Java 应用程序的示例
java -jar test.jar |
- 6. 远程调试应用程序
- 将 JAR 文件复制到远程计算机或同一台计算机上的适当位置，调用调试服务器，然后为它添加一个客户机。简单的 Java 应用程序就可以充当调试服务器或客户机。您可以在 Eclipse 中选择 Socket Attach 或 Socket Listen 连接类型，这取决于特定的配置。接下来的两个小节将学习如何将应用程序作为服务器或客户机运行。
作为调试服务器的目标 VM
下面这个示例远程调用 Java 应用程序作为调试服务器，并在端口 8000 监听套接字连接。目标 VM 将暂停，直到调试器连接。
清单 6. Eclipse 连接套接字模式下的 VM 调用示例
java -Xdebug -Xrunjdwp:transport=dt_socket,server=y,address="8000" -jar
test.jar
|
使用远程启动配置启动 Eclipse，并指定远程应用程序的目标 VM 地址。为此，单击 Run > Debug Configurations，然后在 Eclipse 菜单中双击Remote Java Application。从最新创建的启动配置中为目标应用程序指定 IP 和端口。为了在同一台机器上运行远程应用程序，仅需将主机 IP 指定为 localhost 或 127.0.0.1。
图 4. 连接套接字连接的配置
选择 Allow termination of remote VM 选项终止在应用程序调试期间连接的 VM。
图 5. Eclipse 中的 Terminate 按钮
作为调试客户机的目标 VM
第二个示例使用一个简单的 Java 应用程序作为调试客户机，并且调试器前端作为调试服务器。Eclipse 使用套接字监听模式连接类型进行监听。必须先启动调试前端来监听特定的端口。图 6 给出一个用于设置监听的示例配置。
图 6. 监听套接字连接的配置
单击 Eclipse Debug 按钮，状态栏将显示消息 “waiting for vm to connect at port 8000...”。看到这个消息后，启动远程应用程序。清单 7 显示了如何将 Java 应用程序作为调试客户机并调用它，然后使用端口 8000 上的主机 127.0.0.1 的套接字将其连接到一个正在运行的调试器应用程序。
清单 7. Eclipse 监听套接字连接模式中的 VM 调用示例
java -Xdebug -Xrunjdwp:transport=dt_socket,address=127.0.0.1:8000,suspend=y
-jar test.jar
|
如果一切进行顺利，将会显示一个调试透视图帮助调试应用程序，并且远程 Java 应用程序将正常停止。这类似于步骤 3 中的本地调试（参见图 3）。在这里，您可以使用标准的调试特性，比如设置断点和值、单步执行等。
何为远程调试？
我们一般调试一个 web项目的java代码时，需要将你的tomcat服务器和你的开发工具（比如Jbuilder）集成，或需要工具的一些插件支持(比如Eclipse 下的myclipse等)，这些方式都是在本地进行，即你的开发工具和tomcat运行在同一台服务器上，如果你的开发工具和服务器不再一台机器上那就需要实现远程调试功能了。
实现方法：
在tomcat的catalina.bat文件中加入下面的设置，当然SET CATALINA_OPTS 变量应该在使用它之前。这是在tomcat启动时设置一些虚拟机参数，使服务器允许远程连接功能，address=5888表示远程连接的端口号，可以设 置成任意其他不冲突端口。其他的应用服务器比如weblogic也应该可以设置这些参数，有兴趣的可以测试。
SET CATALINA_OPTS=-server -Xdebug -Xnoagent -Djava.compiler=NONE -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=5888
这 样就Ok了，重启动tomcat,可以直接独立启动，而不用在eclipes的插件中启动。打开eclipse中的debug设置窗口，选择Remote Java Application ，新建一个debug项，输入服务器IP和刚才设置端口号，点ok就可以进入debug状态了。Jbuilder中同样可以设置Remote Java Application。
用Eclipse远程调试(Remote debug)Tomcat
回页首
结束语
本文演示如何使用 Eclipse 内置的远程 Java 应用程序配置类型对应用程序执行远程调试。介绍了如何设置 Java 应用程序以调用远程调试，并帮助您理解 Eclipse 提供的连接器。最后，您还学习了如何将这些技术应用到项目中。
参考资料
学习
- 您可以参阅本文在 developerWorks 全球网站上的 英文原文。
- “Eclipse Ganymede 先睹为快” 概述了几个 Ganymede 项目，并提供相关的资源。
- 要初步了解如何在 Eclipse 平台上进行调试，请参阅 “使用 Eclipse 平台进行调试 -- 使用 Eclipse 平台调试您的软件项目”。
- 查看 Eclipse Debugging Resources 丰富您的 Eclipse 调试知识。
- 更多地了解 Sun Microsystems 提供的 Java Platform Debugger Architecture。
- 阅读 Java Platform Debugger Architecture 文档 更多地了解 JPDA。
- 阅读 Java Debug Interface documentation 更多地了解 JDI。
- JDT 项目 提供的工具插件可以实现 支持任何 Java 应用程序开发的 Java IDE，包括 Eclipse 插件。
- 查看 “推荐 Eclipse 阅读清单”。
- 在 developerWorks 上浏览所有的 Eclipse 内容。
- 您是 Eclipse 新手吗？阅读 developerWorks 文章 “Eclipse 平台入门” 以了解它的起源和架构，以及如何用插件扩展 Eclipse。
- 查看 IBM developerWorks 的 Eclipse 项目资源 提高您的 Eclipse 技巧。
- 要收听针对软件开发人员的有趣访谈和讨论，请访问 developerWorks podcasts。
- 随时关注 developerWorks 的 技术活动和网络广播。
- 查看免费的 developerWorks On demand demos 体验并了解 IBM 和开放源码技术及产品功能。
- 查阅最近将在全球举办的面向 IBM 开放源码开发人员的研讨会、交易展览、网络广播和其他 活动。
- 访问 developerWorks 开放源码专区，获得丰富的 how-to 信息、工具和项目更新，帮助您用开放源码技术进行开发，并与 IBM 产品结合使用。
获得产品和技术
- 从 Sun Microsystems 可以获得 Java 2 Standard Edition V5 或更新版本。
- 在 IBM alphaWorks 上查看最新的 Eclipse 技术下载。
- 从 Eclipse Foundation 下载 Eclipse Platform 和其他项目。
- 下载 IBM 产品评估版，使用来自 DB2®、Lotus®、Rational®、Tivoli® 和 WebSphere® 的应用程序开发工具和中间件产品。
- 使用 IBM 试用软件 改进您的下一个开源开发项目，可以下载或从 DVD 获得。
讨论
- Eclipse Platform 新闻组 应当是讨论关于 Eclipse 的问题的第一站（选择此链接将启动默认的 Usenet 新闻阅读器应用程序并打开 eclipse.platform）。
- Eclipse 新闻组 为对使用和扩展 Eclipse 感兴趣的人员提供了许多参考资料。
- 参与 developerWorks blogs 并加入 developerWorks 社区。
关于作者
Charles Lu 是 IBM China Software Development Lab 的软件开发人员，目前从事 IBM Lotus Expeditor 的开发。他感兴趣的领域包括设备编程、即时消息和语音技术。