Eclipse Java插件开发如何入门？-杰瑞科技汇

Eclipse 插件开发（通常称为 PDE - Plug-in Development Environment）是利用 Eclipse 框架自身的扩展点机制，来定制和增强 Eclipse 功能的一门技术，你可以用它来创建新的编辑器、视图、菜单、构建工具等等，几乎可以改变 Eclipse 的任何行为。

（图片来源网络，侵删）

核心概念：Eclipse 插件是什么？

想象一下 Eclipse 是一个“空壳”或“操作系统”，它本身只提供最基本的运行时（OSGi）和核心服务，所有的具体功能，Java 编辑器、调试器、资源管理器等，都是以“插件”的形式存在的。

一个 Eclipse 插件本质上是一个 OSGi Bundle，它是一个 Java 的 JAR 文件，但包含了一些特殊的元数据（META-INF/MANIFEST.MF）来声明自己能提供什么（扩展点 Extension），以及需要依赖什么（扩展点 Extension）。

两大核心机制：

扩展点：插件通过扩展其他插件提供的扩展点，来“挂载”自己的功能，你通过扩展 org.eclipse.ui.views 扩展点，就可以在 Eclipse 的 "Show View" 菜单中添加一个新的视图。
扩展点：插件可以定义自己的扩展点，允许其他插件来扩展它的功能，Eclipse UI 插件定义了 org.eclipse.ui.menus 扩展点,你的插件就可以通过扩展它来添加一个新的菜单项。

开发环境准备

你需要一个完整的 Eclipse IDE，并且安装 PDE 插件。

（图片来源网络，侵删）

下载 Eclipse IDE for RCP and RAP Developers：
- 这是最推荐的版本，因为它已经预装了所有插件开发所需的工具，包括 PDE、Eclipse IDE for Java Developers 等。
- 下载地址：Eclipse Downloads
- 选择 "Eclipse IDE for RCP and RAP Developers"。
（可选）在现有 Eclipse 中安装 PDE：

如果你已经有 Eclipse IDE for Java Developers，可以通过 "Help" -> "Eclipse Marketplace..." 搜索 "Eclipse Plugin Development Environment" 并安装。

创建你的第一个插件项目

新建项目：
（图片来源网络，侵删）
- File -> New -> Project...
- 选择 Plug-in Development -> Plug-in Project，然后点击 Next。
项目配置：
- Project name: 给你的项目起个名字，com.example.myfirstplugin。
- Target platform: 选择一个目标平台，通常选择 "An Eclipse installation" 并指向你当前的 Eclipse IDE 目录,这能确保你的插件与开发环境兼容。
- Template: 选择 "Hello, World" 模板，这是一个最简单的模板,能快速帮你搭建起一个可以运行的插件。
生成代码并检查：
- 点击 Finish，PDE 会为你生成一个完整的项目结构。
- 关键文件：
  - META-INF/MANIFEST.MF: 插件的“身份证”，定义了插件ID、版本、依赖的包等。
  - plugin.xml: 插件的“配置文件”，定义了所有对 Eclipse 的扩展（比如视图、菜单等）。
  - OSGI-INF/lifecycle.xml: 定义插件的启动和停止行为。
  - src/ 目录：你的 Java 源代码。

插件开发核心实践

让我们通过创建一个简单的“问候”功能来学习。

目标：在菜单栏添加一个 "Say Hello" 选项，点击后弹出一个对话框。

步骤 1：扩展菜单

打开 plugin.xml 文件，切换到 "Extensions" 标签页。
点击 "Add..." 按钮。
在弹出的窗口中，找到并选择 org.eclipse.ui.menus，然后点击 Finish。
plugin.xml 的 "Extensions" 视图中会出现 org.eclipse.ui.menus 节点。
右键点击 org.eclipse.ui.menus -> New -> menu。
- 在右侧的 "Properties" 视图中，将 id 设置为 com.example.myfirstplugin.menu.main，label 设置为 &MyPlugin。
右键点击刚刚创建的 menu 节点 -> New -> command。
- 在 "Properties" 视图中，设置 id 为 com.example.myfirstplugin.commands.hello，label 为 Say &Hello。
右键点击 command 节点 -> New -> handler。
- 在 "Properties" 视图中，设置 class，点击 "Browse..."，选择 "New Class..."，创建一个名为 com.example.myfirstplugin.handlers.HelloHandler 的类，PDE 会自动帮你在 MANIFEST.MF 中添加对 org.eclipse.ui.handlers 的依赖。

步骤 2：实现处理器逻辑

打开 HelloHandler.java 文件，Eclipse 会为你生成一个骨架，我们需要重写 execute 方法。

package com.example.myfirstplugin.handlers;
import org.eclipse.core.commands.AbstractHandler;
import org.eclipse.core.commands.ExecutionEvent;
import org.eclipse.core.commands.ExecutionException;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.ui.handlers.HandlerUtil;
public class HelloHandler extends AbstractHandler {
    @Override
    public Object execute(ExecutionEvent event) throws ExecutionException {
        // 获取当前活动的窗口
        String message = "Hello, Eclipse Plugin World!";
        // 弹出一个消息对话框
        MessageDialog.openInformation(
            HandlerUtil.getActiveShell(event),
            "My Plugin",
            message
        );
        return null;
    }
}

AbstractHandler: 这是处理命令的标准基类。
ExecutionEvent: 包含了触发命令的上下文信息，比如是哪个按钮、哪个菜单被点击了。
HandlerUtil.getActiveShell(event): 获取当前活动的 Shell（窗口）,用于定位对话框。
MessageDialog.openInformation(...): 一个简单的静态方法,用于显示信息对话框。

步骤 3：配置命令

回到 plugin.xml 的 "Extensions" 视图，确保你的 command 节点已经被 handler 扩展了。

步骤 4：运行和测试

在 HelloHandler.java 文件上右键，选择 Run As -> Eclipse Application。
Eclipse 会启动一个新的、干净的 Eclipse 实例（称为“Runtime Workbench”）。
在这个新的 Eclipse 窗口中，你应该能在菜单栏看到你定义的 "MyPlugin" 菜单，点击它，然后选择 "Say Hello"，就会弹出 "Hello, Eclipse Plugin World!" 的对话框。

恭喜！你已经成功创建并运行了你的第一个 Eclipse 插件！

常用扩展点和开发模式

除了菜单,你还会用到很多其他扩展点：

扩展点	作用	示例
`org.eclipse.ui.views`	定义新的视图	创建一个资源管理器、一个自定义的文件列表视图
`org.eclipse.ui.editors`	定义新的编辑器	创建一个用于编辑 `.properties` 文件的专用编辑器
`org.eclipse.ui.perspectives`	定义新的透视图	为你的插件组合一组特定的视图和编辑器，创建一个工作区
`org.eclipse.ui.preferencePages`	定义首选项页面	在 `Window` -> `Preferences` 中添加一个配置页面
`org.eclipse.core.resources.builders`	定义构建器	在项目构建时自动执行某些任务（如代码生成）
`org.eclipse.ui.commands`	定义命令（与 `handlers` 配合使用）	定义一个可以被多个地方（菜单、工具栏、快捷键）触发的动作

开发模式

以 Eclipse Application 运行 (Run As -> Eclipse Application)：这是最常用的模式，用于测试 UI 相关的功能，如视图、菜单、对话框等，它会启动一个完整的、可交互的 Eclipse 环境。
以 OSGi Framework 运行 (Run As -> OSGi Framework)：这个模式启动一个没有 UI 的后台 OSGi 容器，适合测试纯后台逻辑、服务、扩展等,启动速度更快。
JUnit 插件测试 (Run As -> JUnit Plugin Test)：用于编写和运行插件单元测试，确保你的代码在 Eclipse 环境中能正确工作。

重要提示和最佳实践

依赖管理是关键：MANIFEST.MF 中的 Import-Package 是最重要的部分，你需要明确声明你的代码需要用到哪些外部包（如 org.eclipse.jface, org.eclipse.core.resources），PDE 的 "Dependencies" 标签页可以帮你自动管理。
使用 Activator：每个插件都应该有一个 BundleActivator 实现（通常命名为 Activator.java），它在插件启动和停止时被调用，是获取和注册服务、初始化资源的入口点，你可以通过 BundleContext 获取到插件的上下文。
善用 PDE 工具：
- Manifest Editor: MANIFEST.MF 的可视化编辑器,可以方便地添加依赖。
- Dependencies Tab: 清晰地展示了插件的依赖关系。
- Runtime Workbench: 测试 UI 的利器。
学习 Eclipse 源码：Eclipse 本身是最好的学习材料，你可以下载 Eclipse 源码，在你自己的插件项目中关联这些源码，当你调用 Eclipse API 时,可以直接看到它的实现。
版本兼容性：在创建项目时选择合适的 Target Platform,可以避免因版本不匹配导致的各种奇怪问题。

进阶主题

当你掌握了基础后,可以探索更高级的主题：

Eclipse RCP (Rich Client Platform)：不仅仅是开发插件，而是用 Eclipse 框架构建一个完全独立的应用程序，这通常涉及自定义产品配置、启动程序等。
Eclipse Services：使用 OSGi 的 Declarative Services (DS) 或 Blueprint,可以更优雅地管理服务的生命周期和依赖注入。
Eclipse 4 (e4)：这是 Eclipse 的新一代 UI 框架，采用了更灵活的基于 DI (依赖注入) 的架构（如 @Inject），虽然目前仍有大量基于 3.x 的插件，但了解 e4 对于开发现代化的 Eclipse 应用至关重要。
Tycho：一个 Maven 插件，用于构建 Eclipse 插件和 RCP 产品，如果你习惯使用 Maven，Tycho 是构建插件项目的标准选择。

学习资源

Eclipse 官方文档：Eclipse Plug-in Development,这是最权威的资料。
Eclipse 示例项目：Eclipse Examples,包含了大量官方示例代码。
EclipseCon 演讲：在 YouTube 上搜索 "EclipseCon"，有很多关于插件开发和 RCP 的高质量演讲。

希望这份指南能帮助你顺利开启 Eclipse 插件开发之旅！从一个小功能开始，逐步构建，你会发现 Eclipse 框架的强大和灵活。

Eclipse Java插件开发如何入门？

核心概念：Eclipse 插件是什么？

开发环境准备

创建你的第一个插件项目