开发Eclipse插件

　　在本文中，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 标记所指出的。 [/img][/code]
　　 　
　　 图 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.resourcePerspe

查看本文来源