jpda tomcat远程调试

JPDA简介

顾名思义，JPDA为Java平台上的调试器定义了一个标准的体系结构。该体系结构包括3个主要组成部分：JVMTI、JDI和JDWP。

 

JVM TI的全称是Java Virtual Machine ToolInterface，它定义了JVM为了支持调试而必须提供的功能及相应的访问接口。这些访问接口是以本地语言的形式提供的，由JVM（比如Sun公司的HotSpotVM）负责实现。

不过，JVM TI只是JVM提供的一系列函数，调试器（特别是远程的调试器）如何调用呢？其实啊，JVMTI的直接客户端并不是调试器，而是一个称为“JPDA back-end”的东东。这个东东应该是属于JVM的一部分，在SUNJRE的bin目录下可以找到jdwp.dll(jdwp.so)的库文件，这就是JPDA back-end的实现。按我理解，JPDAback-end提供了各种访问方式（共享内存，Socket），通过这些方式接收调试器的请求，然后调用JVM TI接口。

 

JDI的全称是Java Debug Interface，它定义了访问JVMTI接口的高层API，以纯Java语言提供，由JDK实现（在SunJDK的tools.jar可以找到）。调试器直接使用JDI来实现调试的功能。与JPDAback-end相对应，JDI实现的角色就是JPDA front-end。

 

JDWP的全称是Java Debug Wire Protocol，它定义了JPDA front-end和JPDAback-end之间通讯信息的二进制格式。这里的通讯信息主要包括两种：调试器发送给JVM的请求信息和JVM发送给调试器的调试信息。

 

总结一下，调试器 调用JDK提供的JDI实现 (JPDAfront-end)，经由JDWP协议 ，和JVM自带的JPDAback-end (jdwp.dll, jdwp.so,...)进行通讯。JPDAback-end 通过调用JVMTI接口 ，从而获知调试信息，或发送控制命令。然后，JPDAback-end 将调试信息或命令执行结果，通过JDWP协议 ，返回给调试器 。

 

如何启用JPDA

默认情况下，JVM并没有启用JPDA back-end。需要在启动JVM的命令行加载以下参数：

-Xdebug-Xrunjdwp:transport=dt_socket,address=8000,server=y,suspend=y

 

-Xdebug

启用调试特性

-Xrunjdwp

启用JDWP实现，它包含若干子选项：

transport=dt_socket

JPDA front-end和back-end之间的传输方法。dt_socket表示使用套接字传输。

address=8000

JVM在8000端口上监听请求。

server=y

y表示启动的JVM是被调试者。如果为n，则表示启动的JVM是调试器。

suspend=y

y表示启动的JVM会暂停等待，直到调试器连接上。

 

suspend=y这个选项很重要。如果你想从Tomcat启动的一开始就进行调试，那么就必须设置suspend=y。

 

Tomcat的启动脚本

只要Tomcat启动时，启用了JPDA，那么就可以被调试。而Tomcat默认是不启用JPDA的，需要我们手动开启。

 

开启JPDA的方法也很简单，对Tomcat的启动脚本做点修改，把启动JPDA的命令行参数添加进去，就可以了。

 

不过Tomcat启动脚本还是有点复杂的，并不是简单的”java ...“。我们先简单的梳理一下。

 

在Tomcat 5.5.26发行版的bin目录下，有N多脚本，其中与Tomcat启停有关的脚本是(以Windows为例)：

startup.bat       //启动Tomcat

shutdown.bat   //停止Tomcat

catalina.bat      //包含启动/停止Tomcat的核心逻辑

 

startup.bat和shutdown.bat都是通过调用catalina.bat来实现启动和停止的功能，因此他俩的代码都很少。主要的逻辑都在catalina.bat中。

 

catalina.bat是个强大的脚本，通过参数，可以执行各种动作，包括debug run start stopversion等。

如果我们直接执行catalina.bat，就可以看到它的用法说明：

 

 

startup.bat，其实就是执行catalina.batstart；shutdown.bat，其实就是执行catalina.bat stop。

不难猜到，我们可以写一个jdpa.bat，直接调用catalina.bat jpdastart，应该就可以启用JPDA。我们拷贝一份startup.bat，把下面这行

call "%EXECUTABLE%" start %CMD_LINE_ARGS%

修改成

call "%EXECUTABLE%" jpda start %CMD_LINE_ARGS%

 

不过，-Xdebug -Xrunjdwp:transport=dt_socket,address=8000,server=y,suspend=y，这些选项参数怎么传递给catalina.bat呢？

看看catalina.bat前面的注释，server的值默认就是y，transport的值是变量JPDA_TRANSPORT，address的值是变量JPDA_ADDRESS，suspend的值是变量JPDA_SUSPEND。如果没有显式地复制，这些变量的值默认是dt_shmem jdbconnn（默认值表示使用共享内存作为传输方式）。这些默认值不是我们需要的，Eclisep的远程调试目前只支持套接字传输。在调用catalina.batjpda start之前，我们给这些变量设置恰当的值：

set JPDA_TRANSPORT=dt_socket
set JPDA_ADDRESS=8000
set JPDA_SUSPEND=y

call "%EXECUTABLE%" jpda start %CMD_LINE_ARGS%

 

然后，直接执行jpda.bat，Tomcat就运行在JPDA可调式模式下：

 

从上图可以看出，Tomcat的JPDA使用套接字传输，监听在8000端口。Tomcat的启动已经暂停，只有调试器连接上来，才会继续启动。

 

我把jpda.bat的完整内容列在下面，其中黑体部分，在startup.bat基础上添加的代码：

 

---

 

@echo off
if "%OS%" == "Windows_NT" setlocal
rem---------------------------------------------------------------------------
rem Jpda script for the CATALINA Server
rem
rem $Id: jpda.bat 302918 2004-05-27 18:25:11Z yoavs $
rem---------------------------------------------------------------------------

rem Guess CATALINA_HOME if not defined
set CURRENT_DIR=�%
if not "�TALINA_HOME%" == "" goto gotHome
set CATALINA_HOME=%CURRENT_DIR%
if exist "�TALINA_HOME%/bin/catalina.bat" goto okHome
cd ..
set CATALINA_HOME=�%
cd %CURRENT_DIR%
:gotHome
if exist "�TALINA_HOME%/bin/catalina.bat" goto okHome
echo The CATALINA_HOME environment variable is not definedcorrectly
echo This environment variable is needed to run this program
goto end
:okHome

set EXECUTABLE=�TALINA_HOME%/bin/catalina.bat

rem Check that target executable exists
if exist "%EXECUTABLE%" goto okExec
echo Cannot find %EXECUTABLE%
echo This file is needed to run this program
goto end
:okExec

rem Get remaining unshifted command line arguments and save them inthe
set CMD_LINE_ARGS=
:setArgs
if ""%1""=="""" goto doneSetArgs
set CMD_LINE_ARGS=%CMD_LINE_ARGS% %1
shift
goto setArgs
:doneSetArgs

set JPDA_TRANSPORT=dt_socket
set JPDA_ADDRESS=8000
set JPDA_SUSPEND=y 

call"%EXECUTABLE%" jpda start%CMD_LINE_ARGS%

:end

 

---

 

 

在Eclipse中远程调试Tomcat

首先将Tomcat 5.5.26的源代码分为container connectors jasper servletapibuild五个项目，导入到Eclipse中。启动相关的代码主要在container中，就以它为当前项目，打开”DebugConfigurations“对话框。（ 右键需要调试的工程→debug as→debug configurations）

然后创建一个”Remote Java Application“，Connection Type选择”Standard (SocketAttach)“，Host填写localhost（Tomcat所在的主机地址），Port填写8000。最后点击”Apply“保存。

 

首先确保已经执行了jpda.bat，Tomcat正在等待调试器连接；然后执行上述的DebugConfiguration，Eclipse就可以连上Tomcat。

 

Tomcat的启动是从Bootstrap的main方法开始，我在第一行代码处设置了断点，Tomcat的启动就停在了这一行：

 

 

接着，让Tomcat继续执行，我们可以看到，控制台输出了启动信息。