问题的由来：平时的开发，我们基本都是在 Debug 模 式下做的，这样便于发现问题给于修正。一旦项目到了实施测阶段，程序被部署到服务器上，现场调试就会成为一个问题。因为被部署的服务器上的日志往往不能提 供足够的信息；或是有了足够的信息，可即时想得到一个状态点的信息又不是太容易（比如说几个关键变量的即时值）。于是想到，如果可以象本机调试程序一样就 好了。

于是（呵呵，又是于是）， google 了一下，真得还是找到了一篇文章（先谢谢了），做法是

只要在 TOMCAT 的启动文件中加入一些参数就可以在 ECLIPSE 中启动 REMOTE_DEBUG 了，具体方法如下：
在 %TOMCAT_HOME%\bin\catalina.bat 文件中加入 SET CATALINA_OPTS=-server -Xdebug -Xnoagent -Djava.compiler=NONE -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=9046 。
打开 ECLIPSE ，在 ECLIPSE 的 RUN 菜单中选择 DEBUG... 项，然后在左边的树形菜单中新增一个 REMOTE_DEBUG( 远程调试 ) ，填 写最基本的几项信息就行了，这几项信息是：调试名称，工程名称，调试主机的 URL 以及 PORT ，在 allow terminate of remote VM 前打上勾 . 最主要的就是端口信息，这个端口信息来自于上面那一串参数中的 address 项，可以将 address 设置为任何未被占用的端口。
以控制台方式启动 TOMCAT ，可以在控制台看到 "Listening for transport dt_socket at address: 5888" 这样的信息，说明调试端口已经被监听。然后打开之前设置的调试并在 IE 或者 ECLIPSE 内置的浏览器中输入 URL 运行 WEB 程序，记得在运行 WEB 程序之前要设置断点。
现在就可以在 ECLIPSE 中进行 WEB 调试了 ...

要说明的是：

我并没按上文那样设置变量。我看了 catalina.bat 这个批处理文件，写的很严谨，环境变量设置有它自己的规范，我不想更改。在这个文件我看到了这么一个名字 setenv.bat 。对了，看到它你就知道，你可以建立这么一个文件把 SET CATALINA_OPTS=-server -Xdebug -Xnoagent -Djava.compiler=NONE -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=9046 放进去，OK啦。但这是只是 windows 中的作法。

岔开说一句话。其实，上面的参数设置并不是都需要的，主要的就两项： transport 和 address ，对应于 catalina.bat 文件中 JPDA_TRANSPORT 和 JPDA_ADDRESS 现两个变量，你可以直接查询并修改这两个参数的值，注意 JPDA_TRANSPORT 的值一定是 dt_socket 才行。不过启动方式有些变化，命令行需要这样： catalina.bat jpda start

在 Linux 中，可以直接 ./ catalina.sh jpda start 命令直接启动调试模式，不过默认的端口是 8000 , 你也可以在 catalina.sh 查找 JPDA_ADDRESS="8000" 把端口修改想要的值。至于写配置文件 setenv.sh 直接用 ./starup.sh 启动的形式，我没成功，呵呵

下面这个就是 Eclipse 中的 Debug 设置窗口了，别告诉我你不会调出来，呵呵

一、安装所需软件

● 下载并且安装eclipse3.1.2，推荐使用lomboz-wtp-emf-gef-jem-eclipse-SDK-3.1.2-win32.zip这个完整的打包文件

http://download.zh.forge.objectweb.org/lomboz/lomboz-wtp-emf-gef-jem-eclipse-SDK-3.1.2-win32.zip

● 下载安装JBoss4.0.4RC1

http://jaist.dl.sourceforge.net/sourceforge/jboss/jboss-4.0.4RC1.zip

● 下载安装MyEclipse4.1GA

● 下载JBossIDE-1.5.1.GA-Bundle-win32，并且作为插件安装到eclipse目录

http://jaist.dl.sourceforge.net/sourceforge/jboss/JBossIDE-1.5.1.GA-Bundle-win32.zip

二、建立一个新的J2EE HelloWorld工程（假定上述程序都完全安装）

● 依次点击：菜单→File→New→Project 从列表中选择 EJB→EJB Project（记得是独立的EJB目录，不是MyEclipse→EJB或者其他），然后点击Next按钮

● 在Project Name中输入HelloWorld，在Target runtime中选择JBoss v4.0如果没有这个选项，则点击[New]按钮建立一个，具体方法参看下列图片，中间可能涉及到让你指定xdoclet目录的情况，请到下列网址下载 xdoclet-bin-1.2.3.zip

http://jaist.dl.sourceforge.net/sourceforge/xdoclet/xdoclet-bin-1.2.3.zip

（↑这个图片中的JRE列表中的j2sdk1.40是在eclipse中设置好的，步骤为：菜单→Window→Preferences→MyEclipse→Application Servers→JBoss4→JDK→Add，如下图所示↓）

● 在选择成JBoss v4.0之后点击下一步，然后勾选所有可以勾选的选项

● 将Source Folder修改为src（原来为ejbModule），然后点击Finish按钮

● 之后生成的目录结构如下图↓

● 菜单→File→New→Package，输入一个包名 cn.tkey （包的名字随意），然后点击Finish按钮

↓就是现在的目录结构

● 菜单→File→New→Other，然后在树形菜单中选择EJB→XDoclet Enterprise JavaBean，然后点击Next按钮

● 选中SessionBean 并且点击 Next按钮

● 在Class name中输入HelloWorldBean（注意：这个名称的后缀必须是Bean，比如xxxBean） ，然后点击 Next按钮

● 将EJB Name、JNDI Name、Display Name都修改为HelloWorldEJB（默认为HelloWorld，之所以写成HelloWorldEJB是为了清楚这个类是一个EJB调用，如 果可以记清楚，可以不用修改），其他选项使用默认，然后点击Finish按钮完成添加

● 修改生成的HelloWorldBean.java文件，将 foo 方法修改并且保存，修改为：

        public  String foo(String param)  {

             return   " Hello World and welcome  " + param;

    }

● 菜单 →File→New→Other， 然后在树形菜单中选择 JBoss-IDE→EJB Componets→EJB Test Client， 然后点击 Next 按钮

● 在Name中填入EJBTest，在JNDI Name修改为HelloWorldEJB（这个名字我们可以依次进入%工程目录%/src/META-INF，查看jboss.xml文件中的< jndi-name>HelloWorldEJB</jndi-name>这一行，填写<jndi-name>< /jndi-name>中的部分，这里就是HelloWorldEJB），在Remote Interface中输入cn.tkey.HelloWorldEJB，在Home Interface中输入cn.tkey.HelloWorldEJBHome，然后勾选foo(java.lang.String param)选项，最后点击Finish按钮结束配置。

● 菜单→Project→Properties，在树形菜单中选择Java Build Path，然后选择[Libraries]选项卡，点击[Add External JARs..]按钮，之后进入%JBOSS_HOME%/client中，选中这个下面的除了jboss-j2ee.jar之外的所有jar文件，最后点 击ok按钮完成配置

● 菜单→Project→Clean→选中Clean projects selected below，然后勾选 HelloWorld工程之后点击[ok]按钮完成重新编译

● 进入到windows的命令行状态，然后进入%工程目录%/build/classes，输入 jar cvf helloworld.jar *，将生成的helloworld.jar文件拷贝到%JBOSS_HOME%/server/default/deploy目录中

● 运行Jboss4.0你将在控制台中看到下列信息，表明EJB已经被加入到JBoss中去了：

● 回到eclipse中，修改刚生成的EJBTest.java文件，将方法public void testFoo() 修改为：

      public void testFoo() throws Exception {

       cn.tkey.HelloWorldEJB instance;
        java.lang.String result;

 

       // Parameters
 
       java.lang.String param0 = null;

 

       // Instance creation
 
       instance = this.home.create();

 

       // Method call
 
       result = instance.foo(param0);

      

       System.out.println(instance.foo(param0));

 

       // Various assertions

       // assertNotNull(result);
 
    }

● 开始测试 EJB， 用右键选中我们刚才生成的 EJBTest.java， 依次选择 Run As→JUnit Test

● 最后当我们看到eclipse右下角出现如下图所示的输出的时候，说明我们的J2EE之旅开始了！而这个Hello World and welcome null 却是来自于另外一个世界的声音他就是JBoss

注解：所有用%xxx%表示的意思是xxx的根目录，比如我的jboss被安装到了c:\jboss4.0，那么%JBOSS_HOME%就代表c:\jboss4.0，因为台机器安装的jboss目录以及其他目录都不尽相同，所以就采用这种方式。

其 中%工程目录%表示eclipse工程的安装目录，比如在运行eclipse的时候会提示让你输入一个工作目录，然后你再建立新工程的时候就会全部在这个 目录下面建立新的子目录，比如我的eclipse工作目录为c:\workshop，我的EJB工程名为HelloWorld，那么我的%工程目录%，就 代表c:\workshop\HelloWorld

Gary Pollice, 实践教授, 伍斯特工业学院

2005 年 9 月 07 日

本文来自于 Rational Edge：在 Gary Pollice 本月的专栏中，他讨论了 Eclipse 技术的优点并解释了为什么他和伍斯特工业学院的其他教师在他们的课程中使用 Eclipse。

每个软件技术的发展都需要在软件开发工具中并行变化。作为教授未来软件开发人员的人，我经常从教学角度考虑我的学生对完成作业工具的需求。倘若科学技术快速地变化，我可以 —— 应该 —— 教给学生多少关于具体工具的内容呢？

一 方面，我知道如果大学教授不在课堂上使用好的工具，那么学生也许会拿着重要的书本知识离开而仍旧处于实践的不利地位。另一方面，教授学生使用“行业力量” 工具需要许多时间。最好有个水晶球告诉我们哪个工具值得投资。记得 80 年代的 CASE 工具吗？我们花费许多时间学习如何使用，但现在还有多少仍在使用？

幸运的是，近来对我来说生活简单多了。Eclipse 对于我的学生是近乎于完美的软件开发环境。它是行业力量。您不需要知道它的所有内容才能有效地使用它。它像您曾想的那样灵活。

如果您不知道 Eclipse 是什么，那么我推荐您去看看 Eclipse 的网站。¹主 页上的第一句话说出了全部：“ Eclipse 是通用的工具平台 —— 一个开放的可以为任何内容（没有特殊的）而扩展的集成开发环境。”它真的是软件工具的瑞士军刀。听起来太好都不真实了吧？我们大部分人都知道当一个工具试 图做每件事时，它会以做好很少的事而告终。但是仅 Eclipse 例外！

什么使 Eclipse 对学术使用那么重要？这里是它的一些优点：

• 在大部分平台上提供一致的特性集
  
  
• 不仅支持 Java 或任意单一的语言
  
  
• 开源且免费，但完全得到支持
  
  
• 真正地可扩展并可配置
  
  
• 行业力量

我们将在下面更细致地讨论。

Eclipse 在多重平台上提供一致的特性集

在 伍斯特工业学院，我们教授的内容不深入到任意具体的计算平台。我们的学生通常可以自由地选择他们使用最舒适的平台，大多数至少有一台计算机，且许多人有更 多台。整个校园范围内实验室中的机器运行着许多操作系统。这是我们想避免留一些需要具体平台，如 Microsoft® Windows，的作业的原因。

当 我在软件工程课上布置大型的团队工程时，我想让学生自由地全神贯注于问题，而不是具体的平台。Eclipse 支持该目标，因为它可在所有我们使用的平台上运行：Windows、Linux 和 MacOS X。更重要的是，它在每个平台上以同样的方式运行，所以即使我不是学生所选平台方面的专家，我也可以与学生一起工作。

事实上，不论您使用什么平台，Eclipse 就像为该平台建立的应用程序一样。当您下载 Eclipse 时，您下载对应您具体平台的 Eclipse，对每个平台它都有单独的图形工具包。这提供了接近本土的外观，以及更好的性能。

回页首

Eclipse 支持超过 Java 的语言

当 您发现 Eclipse 不仅是 Java 开发平台时，您将看到 Eclipse 的真正好处。Eclipse 的基本原理具体化到技术的体系结构中：提供一个给与开发人员一个一致的方式来扩展系统功能的小核心。每个扩展，或插件为 Eclipse 配置提供具体的功能并且提供其他插件能够使用的扩展点。²

插件体系结构使 Eclipse 有可能支持许多语言和范型。插件的实例是：

• Eclipse C 开发工具（C Development Tool，CDT）工程（http://www.eclipse.org/cdt/）。此核心工程，由 Eclipse Foundation 所支持，³ 提供了高质量的 C 和 C++ 支持。可交付的工程包括对编辑、调试、makefile 生成器、语法分析、搜索和内容辅助的支持。
  
  
• 同样由 Eclipse Foundation 发起的，COBOL 插件（http://www.eclipse.org/cobol/）提供类似于 CDT 的功能。
  
  
• EPIC（http://e-p-i-c.sourceforge.net/）向 Eclipse 提供 Perl 开发环境。
  
  
• Pydev（http://sourceforge.net/projects/pydev/）是其中一个支持 Python 语言的插件。

最近当我察看最喜爱的 Eclipse 插件目录（http://www.eclipse-plugins.info/eclipse/index.jsp） 时，我看到在语言分类中目前有五十一个插件。无论您使用什么语言，碰巧的是会有一个 Eclipse 插件使您在 Eclipse 中用该语言开发程序，Haskell、ML、Prolog 和 GOO 都得到支持。不仔细分析图 1 中显示的 Eclipse 实例，您可能不能说出我是否在使用 Java 、C++、Ruby 或任意一个其他被支持的语言。

这种外观上的一致性给作为老师的我带来了 重大的好处 —— 并且也可以为作为实践工程师或管理人员的您带来好处。一旦您了解如何通过不同的 Eclipse 视图进行定位，您就可以轻易地从一种语言或平台迁移到另一种并且知道工作起来是一样的。我祝贺 Eclipse 的开发团队，他们建立了一组标准，其他开发人员可以 —— 且确实 —— 要依照该标准来实际上创建任意类型的插件。数量较少的没有依照标准指导方针的插件通常是质量不合格的。

教我的学生如何使用 Eclipse 通常需要一到两节课。这对于他们所获得的收益来说不是很大的代价 —— 且我从收到一致格式的作业中得到好处。当我能够不出任何问题地加载并运行他们的工程时，评分就更简单了。

图 1：典型的 Eclipse 视图

回页首

Eclipse 是开源且免费的，但得到全面支持

开 源的出现已经证明免费的软件不一定必然是低质量的软件。然而，企业，如 RedHat，也认识到，向使用该软件的人提供支持是重要的。事实上，Eclipse 拥有一个非常活跃的专区愿意帮助解决任何问题。另外，由于 Eclipse 是许多商业软件产品的基础，包括 IBM Rational 工具，许多厂商提供额外的支持。

如一个电视广告中说的，“免 费”是很高的价钱，并且这对学术界尤其正确。IBM、Microsoft 和其他公司拥有极好的计划，帮助教育工作者和学生以非常低的价格或免费获得软件。没有他们的帮助，大学教育的费用会比目前更高。Eclipse 平台和它的许多免费插件使学生很容易地下载他们所需要的东西。另外，通过尝试新的语言和工具，大量的免费插件提供学生一种低风险的方式来扩展视野。这对我 来说也非常好，因为我在不断地寻找很棒的新事物来展示给学生。我不愿意为一个课程指定一本 100 美元的书籍，当我让学生代替使用不增加总体课程成本的免费的软件下载时，我的良心上好过些。

我的两个学生刚完成他们的专业资格考试工程 （major qualifying project，MQP），WPI 的毕业要求。他们的工程是为 Eclipse 建立一个对象平台，可以使您与您创建的类对象交互，且不必书写完整的程序。他们做出了惊人的工作，但没有 Eclipse 专区的支持，他们决不可能实现他们所做的。只要他们遇到困难，他们就向适当的新闻组发送消息并接收到提示回答。这帮助他们不仅完成了工作，而且还成为专注 的职业开发人员的一部分，在进入他们的职业生涯之前，那种支持将是无价的。⁴

回页首

Eclipse 是真正地可扩展及可配置的

在 这些年间，我用过许多号称可扩展且可配置的工具。然而，当我买了它们之后，我发现配置不像听起来那样简单。我的第一次经历是在 1974 年，我需要适应一个数据点计算机，而销售员告诉我可以用他们的新系统做到。我订了一个带有巨大的 5MB 磁盘的系统并等待。当它出现时，我问他，“好了，我现在如何做工作？”回答是，“您可以做，但我们没有对应它的软件。您需要自己编写。”在得克萨斯州的圣 安东尼奥花了两周的时间以后，了解操作系统和汇编语言，我能够按自己想要的扩展软件。但我得到了经验 —— “可扩展的”是在旁观者的眼中的。

然而，Eclipse 是真 正可扩展的。使用为该目的而设计良好的软件是多么高兴的事。现在，我正在写一个插件，它将比我在 1974 年时的简单汇编语言程序需要花费更多的时间，而我可以做如此复杂的事情。另外，由于 Eclipse 社区可以提供帮助，我期望工作可以更令人愉快且最终产品不容易有缺陷。

Eclipse 插件页面（参见前面的脚注）列出了 825 个提供产品，它是平台可扩展性的证据。对于大部分的 Eclipse 软件，安装插件是一件简单的事。装有最新的 Eclipse 版本后，您就可以简单地在 Eclipse 中指向特定的 Web 站点并单击按钮。图 2 显示了加载 AspectJ 开发工具插件的向导。如果您想要的插件不支持更新站点，您可以简单地下载并将插件解包到适当的目录下 —— 这也是 Eclipse 交付使用的方式。要安装 Eclipse，您只要将其拆包。只要您的系统中有了一个 Java JRE，您就可以准备行动了。

不是所有的 Eclipse 插件都免费。许多商业工具也是 Eclipse 的插件或与 Eclipse 绑定。例如，最新版本的 IBM Rational 工具处于 Eclipse 之上，包括为 Eclipse 提供许多扩展的 IBM Websphere。一旦您安装了这些工具，您可以在它们之上建立扩展以及其他 Eclipse 插件。此种灵活性应该给采用这些基于 Eclipse 的工具的企业带来很多好处。

图 2：安装 AspectJ 开发工具插件的向导

Eclipse 也是高度可配置的。其体系结构允许每个插件提供具有功能的可配置选项。甚至在使用 Eclipse 许多年之后，我确定我仍旧没有发现所有可能的配置功能 —— 但我已经找到足够让我觉得该环境很舒适的配置功能了。

通 过 Preferences 窗口配置 Eclipse，如图 3 所示。如您所见到的，我在改变一些 Java 编译设置。您可以以不同的方式解释许多类型的 Java 违规，并且 Preferences 窗口中的 Compiler 窗格让您决定这些是否为错误、警告或可接受的。最新的 Java 编辑器，一个叠合的编辑器，让您选择是否关闭代码或甚至只察看您现在正处理的方法。

我已经发现建立编码式样非常简单，用 Eclipse 参数选择进行设定，并与其他人分享该式样。利用简单的按键顺序组合 —— 如 Windows 中的 SHIFT-CTL-F —— 代码会自动地根据您的首选式样格式化。

图 3：Eclipse Preferences 窗口

Eclipse 可配置性是 Emacs 可配置性的再现。如果您是一个 Emacs 用户，您很可能添加自己的宏指令和简化操作来为您的式样进行定制。Eclipse 继承了该传统。

回页首

Eclipse 是行业力量

IBM⁵最 初将 Eclipse 作为私有的平台进行开发，但在 2004 年它帮助组成了非盈利的 Eclipse Foundation 以俯瞰技术的更远发展。现在，基金会理事会批准新的子项目并且基金会吸收了商业组织、学术和研究机构、标准团体等等，以确保 Eclipse 处于软件工具行业的最前沿。这意味着您可以依赖 Eclipse 作为可预见的未来中使用的可行的行业力量工具。

当我花时间向我的学生介绍 Eclipse 时，我知道时间花得很值得。Eclipse 是他们可以带到工作中的东西，因为如此多的企业在使用它。如果他们的企业还没有使用，那么它是他们可以引入的东西。尤其是它拥有他们生产高质量软件所需要 的特性。我常常向我的学生讲述人、过程和工具的道理，并且 Eclipse 确实说明了好工具的益处。

在我的软件工程课上，学生在最小程度上也要接触：

• 基本的 Eclipse Java 开发环境。
  
  
• JUnit 单元测试插件。
  
  
• 用于版本控制的 CVS 或 Subversion 插件。

一旦他们掌握了这三种技术，他们就有了一个好的基础软件开发工具包，并且很容易通过其他的插件添加新增的功能。

回页首

总结

不 是所有的学生都使用 Eclipse。一些人仍旧使用文本编辑器，如 Textpad®，和命令行程序运行。然而，我的那些接触 Eclipse 的学生中的大多数都带着对好的开发工具的功能的更好的理解离开了，并且增加了他们能够在更大型软件开发项目中有效工作的信心。

这里是两个不同的学生做出的关于在我最近的软件工程项目中使用 Eclipse 的经历的评述：

学生 1： 我曾经认为像 Eclipse 这样的工具为你做了太多的事并使你成为懒惰的程序员。在像 Eclipse 这样惊人的工具带走了琐碎的编码工作时我们完成了多么多的工作，当我看到这时，很难看出任何专业人员如何避免使用像 Eclipse 这样的工具。一致的格式、直观的调试、内嵌的 CVS 和 JUnit 支持、类和包的一览和层次，以及用于它们所有的图形用户界面，使 Eclipse 成为非常友好的助手。

学生 2：学习使用像 Eclipse 这样的高级图形用户界面来开发软件也是极好的，由于它去掉了许多重复琐碎的工作，使我有更多的时间考虑实际的代码和重要的算法。

当然，在学生使用任何产品时，他们都会遇到问题。一些人发现了当使用可视化编辑器时使 Eclipse 崩溃的方法。一些人发现 Eclipse 很慢并带有他们不需要的特性而显得“臃肿”⁶ —— 但许多人一旦实际调试其他人的代码时就改变了观点。他们的大多数经历是积极且非常真实的。

恰好那些没有结束热爱 Eclipse 的学生接触到了真实的软件，并且他们了解了我希望他们在毕业时达到的质量级别。他们见到如何设计并实现健壮的产品，并且他们发现工具是多么有价值。如果您没有试过 Eclipse，我推荐您试一试。您会很高兴使用的。

回页首

更多的读物

下面是一些我觉得有帮助的 Eclipse 资源。

• Eclipse 网站（http://www.eclipse.org）有关于产品每个部分的文章。它们是入门和寻找详细技术信息的好去处。
  
  
• Eclipse ECESIS 工程页面（在 http://www.eclipse.org/ecesis/）提供一个很棒的，关于如何使用 Eclipse 和书写插件的录像教程。
  
  
• 如果您对 Eclipse 很陌生，我推荐 Addison-Wesley 出版的，由 D'Anjou 等人所著的 The Java Developer's Guide to Eclipse, 2e。这是一本提供关于大部分主题的有用信息的大而完全的书籍。
  
  
• 如果您要建立自己的插件，您或许应该看看 Beck 和 Gamma 所写的 Contributing to Eclipse，以及 Clayberg 和 Rubel 所写的 Building Commercial-Quality Plug-Ins。两本书都是由 Addison-Wesley 出版的。

回页首

注释

¹从 http://www.eclipse.org 开始。

²要了解更多关于插件体系结构的内容，请参见 http://www.eclipse.org/articles/Article-Plug-in-architecture/plugin_architecture.html。

³Eclipse Foundation 是非营利的企业，目标是促进 Eclipse 平台：http://www.eclipse.org/org/index.html。

⁴Eclipse 对象工作台的主页是 http://sourceforge.net/projects/ebob/。

⁵参见 http://www.eweek.com/article2/0,1759,1750358,00.asp

⁶我们发现仍在开发中的 Eclipse 3.1 比 Eclipse 3.0 慢得多。由于我们不需要新版本支持的所有特性，所以班里的大多数使用 Eclipse。

回页首

参考资料

• 您可以参阅本文在 developerWorks 全球站点上的 英文原文。
  

回页首

关于作者

	Gary Pollice 是马塞诸塞州伍斯特市，伍斯特工业学院的教授实践的教授。他教授软件工程、设计、测试和其他计算机科学课程，并指导学生项目。在进入学术界之前，他花了超 过 35 年的时间开发各种类型的软件，从业务应用程序到编译程序和工具。他的最后一份业内工作是由 IBM Rational Software 提供的，在那里他被称为“RUP 怪人”，他还是原 Rational Suite 队伍中的成员。他是 2004 年 Addison-Wesley 发表的文章 Software Development for Small Teams: A RUP-Centric Approach, 的主要作者。他拥有数学的学士学位和计算机科学的硕士学位。

如何创建、调试和安装插件

级别: 初级 David Gallardo, 软件顾问 2003 年 3 月 26 日 在本文中，David Gallardo 向您展示了如何使用 Plug-in Development Environment 的代码生成向导来创建 Eclipse 插件。您将学到如何在运行时工作台中运行和调试插件，并且在 Eclipse 中安装完成的插件。David 还研究了与打包插件相关的问题 ― 包括维护版本信息、以插件片段的形式更新功能，以及组合插件来创建完整的功能部件。 基于插件的体系结构 Eclipse 平台是 IBM 向开发源码社区捐赠的开发框架，它之所以出名并不是因为 IBM 宣称投入开发的资金总数 ― 4 千万美元 ― 而是因为如此巨大的投入所带来的成果：一个成熟的、精心设计的以及可扩展的体系结构。Eclipse 的价值是它为创建可扩展的集成开发环境提供了一个开放源码平台。这个平台允许任何人构建与环境和其它工具无缝集成的工具。 工具与 Eclipse 无缝集成的关键是 插件。除了小型的运行时内核之外，Eclipse 中的所有东西都是插件。从这个角度来讲，所有功能部件都是以同等的方式创建的。从这个角度来讲，所有功能部件都是以同等的方式创建的。 但是，某些插件比其它插件更重要些。Workbench 和 Workspace 是 Eclipse 平台的两个必备的插件 ― 它们提供了大多数插件使用的扩展点，如图 1 所示。插件需要扩展点才可以插入，这样它才能运行。 图 1. Eclipse Workbench 和 Workspace：必备的插件支持 Workbench 组件包含了一些扩展点，例如，允许您的插件扩展 Eclipse 用户界面，使这些用户界面带有菜单选择和工具栏按钮；请求不同类型事件的通知；以及创建新视图。Workspace 组件包含了可以让您与资源（包括项目和文件）交互的扩展点。 当然，其它插件可以扩展的 Eclipse 组件并非只有 Workbench 和 Workspace。此外，还有一个 Debug 组件可以让您的插件启动程序、与正在运行的程序交互，以及处理错误 ― 这是构建调试器所必需的。虽然 Debug 组件对于某些类型的应用程序是必需的，但大多数应用程序并不需要它。 还有一个 Team 组件允许 Eclipse 资源与版本控制系统（VCS）交互，但除非您正在构建 VCS 的 Eclipse 客户机，否则 Team 组件，就象 Debug 组件一样，不会扩展或增强它的功能。 最后，还有一个 Help 组件可以让您提供应用程序的联机文档和与上下文敏感的帮助。没有人会否认帮助文档是专业应用程序必备的部分，但它并不是插件功能的必要部分。 上述每个组件提供的扩展点都记录在 Eclipse Platform Help 中，该帮助在 Platform Plug-in Developer 指南的参考部分中。乍一看，尤其是 API 参考大全的 Workbench 部分，一开始会令人望而却步。我们不会深入了解众多可用扩展点的详细信息，而只是粗略地看一个简单插件及其组件。 回页首 插件简介 创建插件最简单的方法是使用 Plug-in Development Environment（PDE）。PDE 和 Java Development Tooling（JDT）IDE 是 Eclipse 的标准扩展。PDE 提供了一些向导以帮助创建插件，包括我们将在这里研究的“Hello, world”示例。 从 Eclipse 菜单，选择 File=>New=>Other（或按 Ctrl-N），然后选择 Select 对话框左边的 Plug-in Development 向导。在 Select 对话框的右边，选择 Plug-in Project。按 Next。在下一屏上，输入项目名称；我使用了 com.example.hello 。再次按 Next。在下一屏上，请注意，插件标识就与项目名称相同。使用项目名称作为插件标识可以将该插件与另一个插件的名称发生冲突的机会减到最小。再按一次 Next。下一屏让您选择是手工创建初始插件代码，还是运行代码生成向导。保留代码生成向导的缺省选项，选择“Hello, World”，然后按 Next，如图 2 所示。 图 2. 选择“Hello, World”代码生成向导 下一屏要求一些附加信息。请注意这一屏上的信息：它包含了插件名称、版本号、提供者名称和类名。这些是关于插件的重要信息，我们将在稍后研究。可以 接受向导提供的缺省值。按 Next。在下一屏幕上，接受包名、类名和消息文本的缺省值。选择“Add the action set to the resource perspective”复选框。按 Finish。 如果接到通知：向导需要启用某些其它插件才能完成，那么按 OK。 过一会儿，向导将完成，而在您的工作区中将会有一个新的项目，名为 com.example.hello ，如图 3 所示。 图 3. PDE 透视图：Welcome to Hello Plug-in 在 Package Explorer 中，工作台的左边是向导创建的一些东西的概述。大多数项都不引人关注：包括项目类路径中的许多 .jar 文件（这些包括插件和 Java 运行时所需的 Eclipse 类）、一个图标文件夹（包含了工具栏按钮的图形），以及 build.properties 文件（包含自动构建脚本所使用的变量）。 这里最有意思的东西是 src 文件夹，它包含了插件和 plugin.xml 文件的源代码 ― plug-in.xml 是插件的清单文件。我们将先查看 plugin.xml。 回页首 插件清单文件 插件清单文件 plugin.xml 包含了 Eclipse 将插件集成到框架所使用的描述信息。缺省情况下，当第一次创建插件时，会在清单编辑器区域中打开 plugin.xml。编辑器底部的选项卡让您可以选择关于插件的不同信息集合。Welcome 选项卡显示了消息“Welcome to Hello Plug-In”，并且简要讨论了所使用的模板和关于使用 Eclipse 实现插件的提示。选择“Source”选项卡可以让您查看 plugin.xml 文件的完整源代码。 让我们看看插件清单文件的各个部分。首先是关于插件的常规信息，包括它的名称、版本号、实现它的类文件的名称和 .jar 文件名。 清单 1. 插件清单文件 ― 常规信息 <?xmlversion="1.0" encoding="UTF-8"?> <plugin id="com.example.hello" name="Hello Plug-in" version="1.0.0" provider-name="EXAMPLE" class="com.example.hello.HelloPlugin"> <runtime> <library name="hello.jar"/> </runtime> 接着，列出了我们的插件所需的插件： 清单 2. 插件清单文件 ― 必需的插件 <requires> <import plugin="org.eclipse.core.resources"/> <import plugin="org.eclipse.ui"/> </requires> 列出的第一个插件 org.eclipse.core.resources 是工作区插件，但实际上我们的插件并不需要它。第二个插件 org.eclipse.ui 是工作台。我们需要工作台插件，因为我们将扩展它的两个扩展点，正如后面的 extension 标记所指出的。 第一个 extension 标记拥有点属性 org.eclipse.ui.actionSets 。操作集合是插件添加到工作台用户界面的一组 基值― 即，菜单、菜单项和工具栏。操作集合分组了基值，这样用户可以更方便地管理它们。例如，我们的 Hello 插件的菜单和工具栏项将出现在 Resource 透视图中，因为当在运行代码生成向导时，我们做了这样的选择。如果用户要更改它，可以使用 Window=>Customize Perspective菜单选项从要在 Resource 透视图中显示的项中除去“Sample Action Set”。 图 4. 定制 Resource 透视图 操作集合包含了两个标记： menu 标记（描述菜单项应该出现在工作台菜单的什么位置，以及如何出现）和 action 标记（描述它应该做什么）― 尤其是 action 标记标识了执行操作的类。注：这个类不是上面列出的插件类。 清单 3. 操作集合 <extension point="org.eclipse.ui.actionSets"> <actionSet label="Sample Action Set" visible="true" id="com.example.hello.actionSet"> <menu label="Sample &Menu" id="sampleMenu"> <separator name="sampleGroup"> </separator> </menu> <action label="&Sample Action" icon="icons/sample.gif" class="com.example.hello.actions.SampleAction" tooltip="Hello, Eclipse world" menubarPath="sampleMenu/sampleGroup" toolbarPath="sampleGroup" id="com.example.hello.actions.SampleAction"> </action> </actionSet> </extension> 许多菜单和操作属性的目的相当明显 ― 例如，提供工具提示文本和标识工具栏项的图形。但还要注意 action 标记中的 menubarPath ：这个属性标识了 menu 标记中定义的哪个菜单项调用 action 标记中定义的操作。有关这个和其它工作台扩展点的详细信息，请参考 Platform Plug-in Developer Guide，尤其是“Plugging into the workbench”章节（可以从 Eclipse 的帮助菜单中获取该指南）。 由于我们选择了将插件添加到 Resource 透视图，于是生成了第二个 extension 标记。这个标记会导致当 Eclipse 第一次启动并装入我们的插件时，将插件添加到 Resource 透视图。 清单 4. extension 标记 <extension point="org.eclipse.ui.perspectiveExtensions"> <perspectiveExtension targetID="org.eclipse.ui.resourcePerspective"> <actionSet id="com.example.hello.actionSet"> </actionSet> </perspectiveExtension> </extension> </plugin> 如果忽略这最后一个 extension，用户就需要使用 Window=>Customize Perspective将插件添加到 Resource（或其它）透视图。 回页首 插件源代码 代码生成向导生成了两个 Java 源文件，打开 PDE Package Explorer 中的 src 文件夹就可以看到它们。第一个文件 HelloPlugin.java 是插件类，它继承了 AbstractUIPlugin 抽象类。 HelloPlugin 负责管理插件的生命周期，在更为扩展的应用程序中，它负责维护诸如对话框设置和用户首选项等内容。 HelloPlugin 要做的事就这么多： 清单 5. HelloPlugin packagecom.example.hello.actions; import org.eclipse.ui.plugin.*; import org.eclipse.core.runtime.*; import org.eclipse.core.resources.*; import java.util.*; /** * The main plugin class to be used in the desktop. */ public class HelloPlugin extends AbstractUIPlugin { //The shared instance. private static HelloPlugin plugin; //Resource bundle. private ResourceBundle resourceBundle; /** * The constructor. */ public HelloPlugin(IPluginDescriptor descriptor) { super(descriptor); plugin = this; try { resourceBundle= ResourceBundle.getBundle( "com.example.hello.HelloPluginResources"); } catch (MissingResourceException x) { resourceBundle = null; } } /** * Returns the shared instance. */ public static HelloPlugin getDefault() { return plugin; } /** * Returns the workspace instance. */ public static IWorkspace getWorkspace() { return ResourcesPlugin.getWorkspace(); } /** * Returns the string from the plugin's resource bundle, * or 'key' if not found. */ public static String getResourceString(String key) { ResourceBundle bundle= HelloPlugin.getDefault().getResourceBundle(); try { return bundle.getString(key); } catch (MissingResourceException e) { return key; } } /** * Returns the plugin's resource bundle, */ public ResourceBundle getResourceBundle() { return resourceBundle; } } 第二个源文件 SampleAction.java 包含的类将执行在清单文件的操作集合中指定的操作。 SampleAction 实现了 IWorkbenchWindowActionDelegate 接口，它允许 Eclipse 使用插件的代理，这样不是在万不得已的情况下，Eclipse 就无需装入插件（这项优化工作使在装入插件时发生内存和性能方面的问题降到最低）。 IWorkbenchWindowActionDelegate 接口方法使插件可以与代理进行交互： 清单 6. IWorkbenchWindowActionDelegate 接口方法 package com.example.hello.actions; import org.eclipse.jface.action.IAction; import org.eclipse.jface.viewers.ISelection; import org.eclipse.ui.IWorkbenchWindow; import org.eclipse.ui.IWorkbenchWindowActionDelegate; import org.eclipse.jface.dialogs.MessageDialog; /** * Our sample action implements workbench action delegate. * The action proxy will be created by the workbench and * shown in the UI. When the user tries to use the action, * this delegate will be created and execution will be * delegated to it. * @see IWorkbenchWindowActionDelegate */ public class SampleAction implements IWorkbenchWindowActionDelegate { private IWorkbenchWindow window; /** * The constructor. */ public SampleAction() { } /** * The action has been activated. The argument of the * method represents the 'real' action sitting * in the workbench UI. * @see IWorkbenchWindowActionDelegate#run */ public void run(IAction action) { MessageDialog.openInformation( window.getShell(), "Hello Plug-in", "Hello, Eclipse world"); } /** * Selection in the workbench has been changed. We * can change the state of the 'real' action here * if we want, but this can only happen after * the delegate has been created. * @see IWorkbenchWindowActionDelegate#selectionChanged */ public void selectionChanged(IAction action, ISelection selection) { } /** * We can use this method to dispose of any system * resources we previously allocated. * @see IWorkbenchWindowActionDelegate#dispose */ public void dispose() { } /** * We will cache window object in order to * be able to provide parent shell for the message dialog. * @see IWorkbenchWindowActionDelegate#init */ public void init(IWorkbenchWindow window) { this.window = window; } } 回页首 运行和调试插件 当开发 Eclipse 的插件时，必须停止 Eclipse 并用新的插件重新启动它以便进行测试和调试，这很笨拙。幸好，Eclipse PDE 提供了一个自托管（self-hosted）的开发环境，它让您无需将插件安装在工作台的单独实例中即可运行。 要运行 Hello 插件，选择 Run=>Run As=>Run-time Workbench来启动另一个 Workbench 实例，而该实例添加了插件的菜单选项和工具栏，如图 5 所示。 图 5. 在运行时工作台中运行的 Hello 插件 我们可以通过单击工具栏按钮或从“Sample Menu”菜单激活插件。任何一种方法都会生成一个框，其标题是“Hello Plug-in”，内容是“Hello, Eclipse world”，以及一个 OK 按钮，按该按钮可以关闭这个框。 通过选择 Run=>Debug As=>Run-time Workbench，按类似的方法调试插件。这次，当插件在第二个工作台实例中运行时，我们可以在最初的工作台中单步执行源代码，以及检查变量等。 一旦插件经过测试并准备发布，我们就需要将它适当打包，以便在 Eclipse 中安装。 回页首 打包插件 Eclipse 在启动时会查看其插件目录来确定要装入哪些插件。要安装插件，我们需要在插件目录中创建一个子目录，并将程序文件和清单文件复制到那里。建议目录名称能表 示插件的标识，并且后面跟下划线和版本号，但是这种做法不是必需的。假设 Eclipse 安装在 C:\eclipse 中；我们要创建一个目录： C:\eclipse\plugins\com.example.hello_1.0.0. 按照 Java 程序的标准，我们的程序文件需要归档到 .jar 文件中 — 我们的插件清单文件，您也许记得它包含这个项： <runtime> <library name="hello.jar"/> </runtime> 要创建 hello.jar 文件，我们可以通过突出显示项目名称，并从 Eclipse 菜单选择 File=>Export，以导出插件文件。选择 JAR 文件作为导出方式，按 Next，然后浏览到我们为它创建的目录。下一步，我们还需要将 plugin.xml 文件复制到这个目录。也可以使用 File=>Export菜单选项（但请要记住选择 File System 作为导出目的地）。 这就是安装插件所需的全部操作，但您将需要停止并重新启动 Eclipse，以便能识别这个新的插件。从帮助菜单中选择“About Eclipse Platform”，可以找到关于已安装插件的信息，包括版本号。在出现的屏幕上有一个按钮是 Plug-in Details；向下滚动列表来寻找 Hello 插件及其版本号。 回页首 更新插件版本 在目录名称中包含版本号的目的是允许在同一台机器上共存某个插件的多个版本（每次只装入一个版本）。我们可以通过创建一个 Hello 插件的已更新版本来看看这是如何工作的：例如，将 plugin.xml 文件中的版本号更改成“1.0.1”，然后将 SampleAction.java 中的文本更改成“New and improved Hello, Eclipse world”。从 Eclipse 菜单中选择 Project=> Rebuild All。下一步，将项目文件以 JAR 形式导出到新的插件目录，例如， com.example.hello_1.0.1 。将修订过的 plugin.xml 文件复制到同一个目录中。当停止并重新启动 Eclipse 时，只会装入已更新的插件。 回页首 插件片段和功能部件 Eclipse 由插件组成，但在开发 Eclipse 的插件时，还要慎重考虑另外两个级别的组件 ― 插件片段和功能部件。 插件 片段（如名称所暗示的）是完整插件的组成部分 ― 目标插件。片段提供的功能与目标插件的功能合并。片段可以用 于将插件本地化成各种语言；在无需形成一个全新发行版的情况下，以增量形式将功能部件添加到现有插件，或者提供特定于平台的功能。在许多方面，片段与插件 一样。主要的区别就是片段没有插件类 ― 片段的生命周期由其目标插件管理。此外，片段的清单文件叫作 fragment.xml，它列出了目标插件的标识和版本号，以及片段的标识和版本号。 另一方面，插件 功能部件根本不包含编码。在 Eclipse 体系结构术语中，功能部件是将一组相关插件打包到完整的产品中。例如，JDT 是包含了象 Java 编辑器、调试器和控制台这样的插件的功能部件。名为 feature.xml 的清单文件描述了一个功能部件归档文件。在其中，该清单文件包含了对该功能部件所包含的插件和其它资源的引用、关于如何更新该功能部件的信息、版权信息和 许可证信息。 在 Eclipse 中， 主功能部件设置了 Eclipse 平台的外观。主功能部件旨在确定诸如给予 Eclipse 其身份的闪屏和其它特征之类的东西。Eclipse 只允许一个主功能部件。用这种方式，通过创建一组插件，将它们打包到功能部件中，并且使这个功能部件成为主功能部件，就可以重新创建 Eclipse 的品牌，并将它用于创建全新且不同的产品。如果从 Eclipse.org 下载，缺省主功能部件是 eclipse.org.platform 。 回页首 后续步骤 在插件的介绍里我们只是稍微了解一些插件的必要用法。学习插件的更多知识的最佳参考资料是 Plug-in Developer's Guide， 可以从 Eclipse 中的帮助菜单中获得该指南。该文档包含了编程指南、Eclipse API 和插件扩展点的参考大全、Eclipse.org 上可用的编程示例的指南，以及常见问题列表。另一个优秀参考资料是 Eclipse 本身的源代码。根据您的兴趣，您也许想要查找一些示例，以了解不同工作台功能部件（如视图和编辑器）是如何扩展的，或者如何使用 SWT（Eclipse 图形 API）。此外，下面的 参考资料可以帮助您学到更多知识。 回页首 参考资料 您可以参阅本文在 developerWorks 全球站点上的 英文原文. 可以从 Eclipse 项目网站获得 Eclipse 的文档、文章以及下载 Eclipse。 浏览完整的 Eclipse 插件列表。 还可以获得更多的 插件信息（法语）。 可以从以下 developerWorks文章中学到更多 Eclipse 知识： David Gallardo 的另一篇文章“ Getting started with the Eclipse Platform”（ developerWorks，2002 年 11 月） “ Plug a Swing-based development tool into Eclipse”（ developerWorks，2002 年 10 月） “ Internationalizing your Eclipse plug-in”（ developerWorks，2002 年 6 月） “ Testing your internationalized Eclipse plug-in”（ developerWorks，2002 年 7 月） “ Working XML: Use Eclipse to build a user interface for XM”（ developerWorks，2002 年 10 月） “ 采访 Marc Erikson：Eclipse 代码捐赠”（ developerWorks，2001 年 11 月） “ Working the Eclipse Platform”（ developerWorks，2001 年 11 月） “ Getting to know WebSphere Studio Application Developer”（ developerWorks，2001 年 11 月） “ Help for reusing your assets”（ developerWorks，2001 年 11 月） “ Create native, cross-platform GUI applications”（ developerWorks，2002 年 4 月） 有关插件开发的更多详细信息，请参阅 Eclipse.org 站点上的文章。 请在 developerWorks上的 开放源码项目专区和 Java 技术专区中查找您需要的参考资料。