Eclipse的遠程調試

本文Matrix永久鏡像：http://www.matrix.org.cn/resource/article/43/43843_Eclipse_Remote_Debug.html
說明：本文可能由Matrix原創，也可能由Matrix的會員整理，或者由
Matrix的Crawler在全球知名Java或者其他技術相關站點抓取並永久
保留鏡像，Matrix會保留所有原來的出處URL，並在顯著地方作出說明，
如果你發覺出處URL有誤，請聯繫Matrix改正.

配置Eclipse進行遠程調試
作者：Deepak Vohra
2005年8月31日
翻譯：observer

版權聲明：可以任意轉載，轉載時請務必以超鏈接形式標明文章原始出處和作者信息及本聲明
作者:
Deepak Vohra ;observer
原文地址:
http://www.onjava.com/pub/a/onjava/2005/08/31/eclipse-jboss-remote-debug.html
中文地址:
http://www.matrix.org.cn/resource/article/43/43843_Eclipse_Remote_Debug.html
關鍵詞： Eclipse Remote Debug


　　如果J2EE開發者在應用服務器上部署了應用，想在Eclipse的IDE（集成開發環境）下調試該應用，他可以利用Eclipse IDE的遠程調試器連接到應用服務器上進行調試。如果沒有這個調試器，出錯信息就只能從應用服務器的錯誤日誌裏獲取。

　　藉助於Eclipse的遠程調試器，你可以在應用程序中設置斷點，然後在Eclipse裏調試應用。當應用在諸如JBoss之類的服務器端運行出錯時，應用就被掛起，Eclipse IDE的Debug視圖顯示產生錯誤的那一行。在下面的演示裏我們將在Eclipse中對JBoss服務器上的應用進行調試。

　　開始測試之前我們要做以下工作：
　　1．啓動JBoss服務器。
　　2．將Eclipse的遠程調試器連接到JBoss服務器上。
　　3．在Eclipse的圖形界面下進行調試。

　　我們將編寫一個servlet應用示例並將其部署到JBoss服務器上。起初該servlet以無錯方式運行，接着我們引入錯誤以演示Eclipse的遠程調試功能。


安裝準備工作

1.下載jboss-4.0.2.zip文件。
2.將該zip文件解壓到安裝目錄完成JBoss 4.02應用服務器的安裝。
3.下載Eclipse 3.0 或 Eclipse 3.02的zip安裝文件eclipse-SDK-3.0-win32.zip。
4.安裝Eclipse 3/3.02的IDE開發環境

用Eclipse開發一個JBoss應用

安裝完JBoss服務器和Eclipse IDE之後，我們開發一個servlet應用以便在JBoss服務器上運行和調試。servlet應用示例由一個doGet方法組成，它能在瀏覽器裏輸出字符串信息。

JBossServlet.java示例的代碼如下：

package servlets;
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;

public class JBossServlet extends HttpServlet {
  public void doGet(HttpServletRequest request,
                    HttpServletResponse response)
      throws ServletException, IOException {
    PrintWriter out = response.getWriter();
    out.println("Eclipse Remote Debugging");
  }
}

爲web應用創建目錄結構。先創建WEB-INF目錄，然後在該目錄下創建classes目錄。爲servlet示例創建名爲servlets的java包目錄，並將JBossServlet.java文件拷貝到該目錄。爲web應用創建部署描述文件web.xml並拷貝到WEB-INF目錄中，該文件如下：

<?xml version="1.0" encoding="UTF-8"?>
<web-app
xmlns="http://java.sun.com/xml/ns/j2ee" version="2.4" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee 
http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">

 <servlet>
    <display-name>JBossServlet</display-name>
    <servlet-name>JBossServlet</servlet-name>
    <servlet-class>servlets.JBossServlet</servlet-class>
</servlet>
 <servlet-mapping>
     <servlet-name>JBossServlet</servlet-name>
     <url-pattern>/catalog</url-pattern>
 </servlet-mapping>

</web-app>

　　servlet示例映射的URL路徑爲/catalog。web應用的目錄結構如下：
     /WEB-INF
      |      |
   web.xml classes
                 |
                 servlets
                      |
                     JBossServlet.class

用Ant編譯和部署

　　Web應用的編譯、打包和部署是在Eclipse IDE中根據Ant build.xml文件完成的。我們用一個由若干個target（目標）元素組成的Ant build.xml文件來編譯JBossServlet.java，然後以webapp.war的文件格式打包、部署web應用。build.xml文件如下：

<project name="jbossApp" default="webapp" basedir="."> 
<property name="build" value="build"/>
<property name="src" value="." /> 
<property name="jboss.deploy"
 value="C:/JBoss/jboss-4.0.2/server/default/deploy"/>
<property name="dist" value="dist"/>
<property name="j2sdkee" value="C:/J2sdkee1.4"/>
<target name="init">
    <tstamp/>
  <mkdir dir="${build}" />
  <mkdir dir="${dist}" />
  <mkdir dir="${build}/WEB-INF" /> 
  <mkdir dir="${build}/WEB-INF/classes" />
</target>
<target name="compile" depends="init">
  <javac debug="true" classpath="${j2sdkee}/lib/j2ee.jar" 
  srcdir="${src}/WEB-INF/classes" 

  destdir="${src}/WEB-INF/classes"> 
    <include name="**/*.java" /> 
  </javac> 
  <copy todir="${build}/WEB-INF"> 
    <fileset dir="WEB-INF" >
      <include name="web.xml" />
    </fileset> 
  </copy> 
 <copy todir="${build}/WEB-INF/classes"> 
    <fileset dir="${src}/WEB-INF/classes" >
      <include name="**/JBossServlet.class" />
    </fileset> 
  </copy> 
</target>
<target name="webapp" depends="compile">
 <war basedir="${build}" includes="**/*.class"
 destfile="${dist}/webapp.war"  webxml="WEB-INF/web.xml"/> 
 <copy file="${dist}/webapp.war" todir="${jboss.deploy}"/>
  </target>
</project>

build.xml文件中的屬性如下表所示：


build.xml文件中還有以下幾個目標元素：


　　把編譯目標中javac任務的debug屬性設爲true意味着以debug模式進行編譯。對於採用debug模式編譯的應用，如果它在JBoss服務器上運行時出現異常，產生異常的代碼行號將會在Eclipse的Debug視圖中被顯示出來。

回到Eclipse

在Eclipse IDE中創建一個新項目，選擇File -> New -> Project，如圖1所示。


圖1 新項目

圖中顯示的是New Project屏。在New Project嚮導中，選擇Java -> Java Project，點擊Next按鈕進入New Java Project屏。在該屏中指定項目名稱（比如EclipseJBoss），然後點擊Next按鈕，如圖2所示。


圖2 創建一個Java項目

在Java Settings屏中，點擊Add Folder按鈕爲項目添加源程序文件夾，如圖3所示。


圖3 添加源程序文件夾

接下來出現的是New Source Folde屏。在該屏中指定文件夾名稱（比如src）並將文件夾添加到項目中。此時會出現一個提示信息，詢問是否更新源程序文件夾和輸出文件夾。在New Java Project屏中點擊Finish按鈕完成項目創建，如圖4所示。


圖4 Java編譯設置

新項目被添加到Eclipse IDE中，如圖5所示。


圖5 Eclipse JBoss項目

接下來，選擇File -> Import將servlet示例源程序文件夾導入到項目中。如果src文件夾和build.xml文件不是在Eclipse IDE中創建的，這時就需要將它們導入到項目中。在Import Select屏中選擇File System並點擊Next按鈕，在Import File System屏中選中src文件夾和build.xml文件，然後點擊Finish按鈕，如圖6所示。


圖6 導入文件系統

這樣就將servlet源程序文件導入到項目中，如圖7所示。


圖7 servlet源程序文件

用build.xml文件將servlet web應用程序編譯、打包並部署到JBoss服務器上。右擊build.xml文件，選擇Run -> Ant Build，如圖8所示。


圖8 執行Ant Build

Ant對web應用程序進行編譯，生成.war格式的webapp.war文件並部署到JBoss應用服務器的部署目錄。Ant的輸出如圖9所示。


圖9 Ant的輸出

接下來執行bin/run腳本啓動JBoss服務器。在瀏覽器中通過訪問http://localhost:8080/webapp/catalog來激活servlet示例，JBossServlet在JBoss服務器上運行並在瀏覽器中輸出信息，如圖10所示：


圖10 JBossServlet在JBoss服務器上運行

配置Eclipse進行遠程調試
　　爲了能在Eclipse中遠程調試JBoss應用，需要以debug模式啓動JBoss服務器，這可以通過在批命令腳本文件bin/run中設置debug選項來實現。JBoss提供的調試機制是基於Java平臺調試架構（JPDA）的。按以下方式設置JAVA_OPTS變量：

set JAVA_OPTS= -Xdebug -Xnoagent 
  -Xrunjdwp:transport=dt_socket,address=8787,
  server=y, suspend=n %JAVA_OPTS%

　　
這些debug參數有：


有關debug參數設置的詳細說明參見JPDA文檔。

爲了演示Eclipse的遠程調試功能，需要在JBossServlet中拋出異常。爲此我們在JBossServlet.java中引入NullPointerException（空指針異常），把原先的代碼：

out.println("Eclipse JBoss  Debugging");

改爲：

String str=null;
out.println(str.toString());

接下來，爲該Eclipse項目的遠程調試進行設置。在Debug選項下拉條中選擇Debug選項，如圖11所示。


圖11 Debug選項

圖中顯示的是Debug屏。在該屏中選中Remote Java Application節點，右擊節點選擇New，如圖12所示。


圖12 新的debug設置

在Debug Configuration屏中爲Debug設置指定名字。選中要調試的項目，也就是此前在Eclipse IDE中創建的EclipseJBoss項目。爲Connection Type（連接類型）選擇默認值，在Connection Properties（連接屬性）中將Host指定爲localhost，將Port（端口）指定爲8787（JBoss服務器批命令腳本run中的端口設定值）。點擊Apply按鈕將此遠程Java應用調試設置加入，如圖13所示。


圖13 JBoss調試設置

接下來，在JBossServlet.java文件中加入異常斷點。此前我們已在JBossServlet中引入了NullPointerException異常。選擇Run -> Add Java Exception Breakpoint在該servlet類中加入斷點，如圖14所示。


圖14 加入Java異常斷點

在Add Java Exception Breakpoint屏中選擇NullPointerException，如圖15所示。NullPointerException斷點被加入到servlet類中。


圖15 NullPointerException斷點

如果servlet應用在JBoss服務器上運行時產生了NullPointerException異常，該應用就會被掛起，同時Eclipse IDE的Debug視圖中會顯示出該異常。

遠程調試JBoss應用

爲部署在JBoss服務器上的servlet示例應用配置好debug設置後，我們就可以在Eclipse IDE中調試servlet應用了。參照“用Eclipse開發一個JBoss應用”一節所說的方法，用build.xml文件對修改後（引入了NullPointerException異常）的JBossServlet.class重新編譯，爲web應用生成新的webapp.war文件。在run批命令腳本中設定調試選項，以debug模式啓動JBoss服務器。
接下來，在Debug屏中選擇EclipseDebug作爲調試設置。點擊Debug按鈕將遠程調試器與JBoss服務器連接，如圖16所示。


圖16 將遠程調試器連接到JBoss服務器上

這樣Eclipse的遠程調試器就連接到了JBoss服務器上。選擇Debug Perspective按鈕切換到Eclipse的Debug視圖，在該視圖中顯示出遠程調試器已連接到本機的JBoss服務器上，端口號爲8787，如圖17所示。


圖17 遠程調試器已連接到JBoss服務器上

在瀏覽器中輸入URL地址http://localhost:8080/webapp/catalog來訪問JBoss服務器上的JBossServlet，就像我們在Debug視圖中看到的那樣，servlet因拋出NullPointerException異常而被掛起。產生了異常的那一行代碼被顯示出來，如圖18所示。

  
圖18 JBoss服務器在產生NullPointerException處被掛起

拋出異常的那一行是out.println(str.toString());。我們可以在Eclipse IDE的Run菜單中選擇不同的調試選項對該servlet應用進行調試。

小結
　　我們在Eclipse IDE中以遠程的方式調試了部署在JBoss服務器上的一個應用。只要將服務器設置成以debug模式啓動，我們就可以用這個方法調試部署在其它類型應用服務器（如Weblogic）上的應用。

資源
Eclipse IDE
JBoss服務器
Java平臺調試架構