eclipse 插件模型

Eclipse是一个可扩展的平台，它提供了一些核心的服务，使一系列的工具集协作完成软件开发的任务。工具设计师通过将它们的工具包装成可拔插的组件来扩展eclipse的功能。这些可拔插的组件被称为“eclipse插件”，它们遵循eclipse的插件规范。eclipse的基本扩展机制是：通过核心插件来提供的平台，新的插件可以增加处理部件到现有的插件。

尽管ecliipse平台以构建IDE著称，但它是由许多不同开发者开发的一系列的插件共同组成的。

 

一、eclipse的插件模型

在eclipse中，插件是在eclipse工作平台上的一个能提供某种服务的组件。一个组件就是一个对象，该对象能够在运行前被配置到一个系统中。eclipse的运行时系统就提供了这样的功能，支持组件的激活，并使一些插件集协作来提供一个无缝的开发环境。在一个eclipse实例中，一个插件被一个或一些插件运行时类或插件类所管理。也就是说，插件类提供了配置和管理插件实例的功能。一个插件类必须扩展自org.eclipse.core.runtime.Plugin,该类是一个提供了基本插件管理功能的抽象类。

eclipse安装目录下含plugins文件夹，该处就是插件所在位置。一个插件被一个plugin.xml文件所描述,它告诉eclipse运行时如何激活该插件。

最基本的plugin.xml文件如下：

<?xml version="1.0" encoding="UTF-8"?>

<plugin

  name="JUnit Testing Framework"

  id="org.junit"

  version="3.7"

  provider-name="Eclipse.org">

  <runtime>

    <library name="junit.jar">

      <export name="*"/>

    </library>

  </runtime>

</plugin>

每个插件有一个全局唯一的标识符id,用于标识该插件。

 

二、插件的配置和激活

插件的安装很简单，只需将插件文件夹拷贝到plugins文件夹内，这样该插件就可以在适当的时候被eclipse运行时系统激活。激活意味着加载它的运行时类并将其实例化。插件类就是在插件激活startup或反激活shutdown时完成一些特殊工作的类。

eclipse包含一个插件管理核心，称为”eclipse平台“或”eclipse运行时“。每次启动时会自动加载一些核心插件。其它非核心插件只有在有需求时，才被激活。

eclipse模型中，一个插件可能和其它插件有下列两种关系：

1.依赖require  ：该插件的运行需要其它插件的支持。

2.扩展extension：该插件扩展了原插件的功能。

如：

<?xml version="1.0" encoding="UTF-8"?>

<plugin

   id="com.bolour.sample.eclipse.demo"

   name="Extension Processing Demo"

   version="1.0.0">

   <runtime>

      <library name="demo.jar"/>

   </runtime>

   <requires>

      <import plugin="org.eclipse.ui"/>

   </requires>

</plugin>

三、扩展Extension

当一个插件提供给用户使用时，一些UI元素将被加到基本的eclipse工作台。

增加一些处理部件到一个插件的过程称为扩展extension，这个过程并不限于UI元素。

一个扩展由一个扩展器插件extender plug-in定义，该扩展会引起主插件host plug-in在行为上的改变。典型情况是，包括向主插件中增加处理部件（例如，向eclipse工作台上增加新的菜单），自定义新增部件的行为（例如，自定义菜单项的处理句柄）。

简单情况下，扩展的一个单独行为将会增加一个单独的回调对象到该环境中，callback对象是主插件和扩展插件的交流桥梁。callback对象不同于主插件和扩展插件（它们都自动被eclipse平台实例化并管理），它是一个plain-old-java-object，它通过开发者提供的特殊代码来实例化和管理。

扩展的一个单独行为也能够增加多个callback对象到环境中。例如，eclipse允许通过一个单一的扩展增加多个菜单。

然而，从本质上来说，扩展模型并非必须要求扩展器插件提供一个自定义的callback对象。比如说，以下的情况是可能的：主插件所需的行为变化能够完全由某些类提供，这些类在编译时就可以被主插件识别，这样一来，该扩展声明仅仅会引起实例化这些内建的对象。

类似地，扩展模型也不要求主插件直接地将其扩展的各个部分暴露出来。例如，一个扩展仅仅要求在主插件发生某些特定事件时通知扩展器插件，在主插件的UI上无需任何的改变。

 

一个插件可能容许自己被各种不同的extension所扩展。例如，工作台UI容许它的菜单和编辑器被扩展。不论哪种扩展，extension都必须遵循一系列特殊的配置规范和行为需求。因此，一个可扩展的插件提供了许多不同类型的”空位slot“来让extension插入。这些空位的类型被称为“扩展点extension-point”。

 

 

可见，存在两种类型的插件角色：host和extender。通用角色callback对象，以及与每个扩展点对应的特定的callback对象。

Host插件提供扩展点，并充当协调和管理一些extension扩展的角色。在主插件的plugin.xml文件中，扩展点由extension-point XML元素来定义，

<?xml version="1.0" encoding="UTF-8"?>

<plugin

id="org.eclipse.ui"

    name="Eclipse UI"

    version="2.1.0"

    provider-name="Eclipse.org"

    class="org.eclipse.ui.internal.UIPlugin">

 

<extension-point id="actionSets" name="Action Sets"

      schema="schema/actionSets.exsd"/>

    <!-- Other specifications omitted. -->

</plugin>

 

Extender角色的插件定义了extension，一般是使自己的某些方面对主插件来说可用，除此之外，使主插件增加一些processing elements到它的环境。一个extension是通过扩展器插件的plug-in.xml文件中的“extension XML元素”来说明的。

<plugin

        id="org.eclipse.help.ui"

        name="Help System UI"

        version="2.1.0"

        provider-name="Eclipse.org"

        class="org.eclipse.help.ui.internal.WorkbenchHelpPlugin">

    <!-- ... -->

    <!-- Action Sets -->

    <extension

        point="org.eclipse.ui.actionSets"> //使用完全限定名来指定待扩展的扩展点

        <actionSet

                label="Help"

                visible="true"

                id="org.eclipse.help.internal.ui.HelpActionSet">

        <action

                label="&Help Contents"

                icon="icons/view.gif"

                helpContextId="org.eclipse.help.ui.helpContentsMenu"

                tooltip="Open Help Contents"

                class="org.eclipse.help.ui.internal.HelpContentsAction"

                menubarPath="help/helpEnd"

                id="org.eclipse.help.internal.ui.HelpAction">

            </action>

            <!-- ... other actionSet elements -->

        <action

                label="&Help..."

                icon="icons/search_menu.gif"

                helpContextId="org.eclipse.help.ui.helpSearchMenu"

                   class="org.eclipse.help.ui.internal.OpenHelpSearchPageAction"// callback类

                menubarPath="org.eclipse.search.menu/dialogGroup"

                id="org.eclipse.help.ui.OpenHelpSearchPage">

            </action>

        </actionSet>

    </extension>

<!-- ... -->

</plugin>

 

一个回调对象是一个plain old java object(not a plug-in)，当扩展点约定中定义的特定事件发生并被主插件识别时，该回调对象将被主插件调用。回调对象的界面由主插件提供。一个回调对象的实现一般是对应于特定extension的自定义类，且由扩展器插件提供。因为回调对象的实现引用了回调接口，因此一般来说和主插件放在同一包中，且扩展器插件一般依赖主插件。

每个回调对象（不同extension-point对应的回调对象）充当一个特定的extension角色，它由XML元素的属性描述，

 

一个主插件设计者创建一个扩展点时，除了在plugin.xml文件中说明扩展点外，还需要在.exsd文件（扩展点规范extension-point schema）中详细定义extension扩展该扩展点的语法。该文件告诉扩展插件的设计者们如何参数化扩展。