CN104346144A - Eclipse RCP扩展点配置方法及装置 - Google Patents

Abstract

本发明公开了一种Eclipse RCP扩展点配置方法及装置，所述方法包括：对扩展类增加可依据具体对象转换出符合配置文件规范的规范文件的自描述符，以及对已增加自描述符的扩展类增加可对符合配置文件规范的规范文件进行转换的接口；程序启动前，搜索系统中的目标扩展类，并将其反射成具体扩展类对象；依据目标扩展类的自描述符以及接口将具体扩展类对象转换成规范文件，并调用富客户机平台RCP的扩展功能注册管理类ExtensionRegistry的注册扩展功能方法addContribution将该规范文件注册至RCP核心。本发明在整个Eclipse RCP扩展点实现过程中，只需编写扩展类，不需要人工编写配置文件。因此，采用本发明可以简化开发人员的开发步骤，提高软件的开发效率，降低维护成本，并且不易出错。

Description

Eclipse RCP扩展点配置方法及装置

技术领域

本发明涉及软件开发技术领域，具体而言，尤其涉及一种集成开发环境Eclipse RCP（Rich Client Platform，富客户机平台）扩展点配置方法及装置。 

背景技术

集成开发环境Eclipse 是一个开放源代码的、基于Java的可扩展开发平台。就其本身而言，它只是一个框架和一组服务，用于通过插件组件构建开发环境。Eclipse RCP是一种基于Eclipse核心的Java 跨平台图形用户界面开发技术。由于继承了Eclipse的插件体系，RCP开发出来的程序都具有良好的扩展性，因此，RCP一般被广泛地用来构建跨平台的管理工具或系统。 

在RCP中，功能扩展是通过扩展点来实现的。通常，其主插件只关心某个扩展点的ID，并不关心具体有哪些扩展。具体功能插件在扩展时，先编写扩展类，然后在对应插件的配置文件plugin.xml中按照规则进行配置。当程序运行后，具体的扩展功能可以被动态加载。 

下面以主菜单的扩展为例，对传统的Eclipse RCP扩展点实现方法进行简单说明。假设已有一个名称为“文件”的主菜单，其扩展点ID为A。现需要在“文件”菜单中新增一个“保存”菜单项，传统的扩展点配置实现步骤如下： 

步骤1、定义一个新扩展类，定义“保存”菜单项的业务逻辑。 

步骤2、在配置文件plugin.xml中进行人工配置，主要将扩展类的全限定名、功能名称、功能图标文件名、以及所属扩展点ID等信息在plugin.xml中进行描述。 

可见，传统的Eclipse RCP扩展点配置是一种采用人工方式进行配置的方法，这种传统方法存在以下问题： 

（1）每次新增扩展功能，都需要开发人员人工编写配置文件plugin.xml，由此增加了开发人员的工作量，除此之外，扩展功能的配置文件编写必须遵 循一定的规则，且由于不同的扩展点拥有不同的XML（Extensible Markup Language，可扩展标记语言）规则，而XML规则往往难以记忆，这就导致开发人员的开发效率进一步降低。 

（2）当开发人员需要修改扩展类时，需要人工同步修改配置文件plugin.xml。另外，由于具体需要，扩展类可能会被修改，如类名、包名可能被修改，甚至类文件被删除，此时，由于扩展类被修改，则配置文件plugin.xml也必须同时由开发人员手工地进行适应性修改，由此便加大了开发人员的工作繁琐程度，且由于需要开发人员手工地进行配置文件plugin.xml的修改，在修改过程中可能会出现错误，从而导致扩展点配置失败。 

发明内容

为了解决现有技术中存在的上述问题的至少其中之一，本发明实施例的目的在于提供一种Eclipse RCP扩展点配置方法及装置。 

为了达到本发明的目的，本发明采用以下技术方案实现： 

本发明实施例提供的一种Eclipse RCP扩展点配置方法，其包括： 

对扩展类增加可依据具体对象转换出符合配置文件规范的规范文件的自描述符，以及对已增加自描述符的扩展类增加可对符合配置文件规范的规范文件进行转换的接口； 

程序启动前，搜索系统中的目标扩展类，并将其反射成具体扩展类对象； 

依据目标扩展类的自描述符以及接口将具体扩展类对象转换成规范文件，并调用富客户机平台RCP的扩展功能注册管理类ExtensionRegistry的注册扩展功能方法addContribution将该规范文件注册至RCP核心。 

优选地，对扩展类增加可依据具体对象转换出符合配置文件规范的规范文件的自描述符的步骤包括： 

对于需要自动配置的目标扩展点，根据其对应的配置文件规范，得到配置文件所需要的该扩展点的描述信息； 

为目标扩展点的扩展类分别增加与相应描述信息相对应的自描述符，使得目标扩展点的扩展类能够依据具体对象转换出符合配置文件规范的规范文件。 

优选地，对已增加自描述符的扩展类增加可对符合配置文件规范的规范文件进行转换的接口的方法为： 

对已增加自描述符的扩展类统一继承自动搜索自动配置功能扩展AutoConfigExtension抽象类，该AutoConfigExtension抽象类要求其子类均提供转换为规范文件toPluginXml()方法，其中，所述配置文件为RCP插件开发框架规范中的plugin.xml，所述规范文件为可扩展标记语言XML文件。 

优选地，程序启动前搜索系统中的目标扩展类并将其反射成具体扩展类对象的步骤包括： 

获取系统中的所有Bundle插件； 

使用Bundle对象的获取资源getResources("/")方法，获取每个Bundle插件对应的绝对路径； 

获取每个Bundle插件中包含的全部类文件，得到所有类的全限定名； 

根据类的全限定名，使用Bundle对象的加载类loadClass方法，依次加载Class对象，判断该Class对象是否继承了AutoConfigExtension抽象类，若是，则将其反射成具体扩展类对象，加入返回集合中，否则丢弃。 

优选地，所述扩展点包括但不限于工具栏扩展点、主菜单扩展点、弹出菜单扩展点、编辑器扩展点、视图扩展点、透视图扩展点。 

本发明实施例提供的一种Eclipse RCP扩展点配置装置，其包括： 

配置单元，用于对扩展类增加可依据具体对象转换出符合配置文件规范的规范文件的自描述符，以及进一步用于对已增加自描述符的扩展类增加可对符合配置文件规范的规范文件进行转换的接口； 

搜索单元，用于在程序启动前，搜索系统中的目标扩展类，并将其反射成具体扩展类对象； 

处理单元，用于依据目标扩展类的自描述符以及接口将具体扩展类对象转换成规范文件，并调用富客户机平台RCP的扩展功能注册管理类ExtensionRegistry的注册扩展功能方法addContribution将该规范文件注册至RCP核心。 

优选地，所述配置单元包括： 

第一配置模块，用于对于需要自动配置的目标扩展点，根据其对应的配 置文件规范，得到配置文件所需要的该扩展点的描述信息； 

第二配置模块，用于为目标扩展点的扩展类分别增加与相应描述信息相对应的自描述符，使得目标扩展点的扩展类能够依据具体对象转换出符合配置文件规范的规范文件。 

更为优选地，所述配置单元还包括： 

第三配置模块，用于对已增加自描述符的扩展类统一继承自动搜索自动配置功能扩展AutoConfigExtension抽象类，该AutoConfigExtension抽象类要求其子类均提供转换为规范文件toPluginXml()方法，其中，所述配置文件为RCP插件开发框架规范中的plugin.xml，所述规范文件为可扩展标记语言XML文件。 

优选地，所述搜索单元包括： 

第一获取模块，用于获取系统中的所有Bundle插件； 

第二获取模块，用于使用Bundle对象的获取资源getResources("/")方法，获取每个Bundle插件对应的绝对路径； 

第三获取模块，用于获取每个Bundle插件中包含的全部类文件，得到所有类的全限定名； 

加载模块，用于根据类的全限定名，使用Bundle对象的加载类loadClass方法，依次加载Class对象； 

判断处理模块，用于判断该Class对象是否继承了AutoConfigExtension抽象类，若是，则将其反射成具体扩展类对象，加入返回集合中，否则丢弃。 

优选地，所述扩展点包括但不限于工具栏扩展点、主菜单扩展点、弹出菜单扩展点、编辑器扩展点、视图扩展点、透视图扩展点。 

本发明使用自动的扩展点配置代替传统的手工配置方式， 在整个Eclipse RCP扩展点实现过程中，只需编写扩展类，不需要人工编写配置文件。因此，采用本发明可以简化开发人员的开发步骤，提高软件的开发效率，降低维护成本，并且不易出错。 

另外，本发明在自动生成规范文件，例如XML文件之后，通过RCP内部扩展功能注册管理类进行统一管理和生效，因此本自动配置方式能够与传统手工配置方式相兼容，在需要的场合下，可以支持两种方式的混合使用。 

附图说明

图1为本发明实施例提供的一种Eclipse RCP扩展点配置方法流程示意图； 

图2为本发明实施例中搜索分布于各个Bundle插件中的全部扩展类的方法流程示意图； 

图3为本发明实施例提供的一种Eclipse RCP扩展点配置装置结构示意图。 

本发明目的的实现、功能特点及优异效果，下面将结合具体实施例以及附图做进一步的说明。 

具体实施方式

下面结合附图和具体实施例对本发明所述技术方案作进一步的详细描述，以使本领域的技术人员可以更好的理解本发明并能予以实施，但所举实施例不作为对本发明的限定。 

如图1所示，本发明实施例提供的一种Eclipse RCP扩展点配置方法，其包括如下具体步骤： 

S10、对扩展类增加可依据具体对象转换出符合配置文件规范的规范文件的自描述符，以及对已增加自描述符的扩展类增加可对符合配置文件规范的规范文件进行转换的接口； 

S20、程序启动前，搜索系统中的目标扩展类，并将其反射成具体扩展类对象； 

S30、依据目标扩展类的自描述符以及接口将具体扩展类对象转换成规范文件，并调用富客户机平台RCP的扩展功能注册管理类ExtensionRegistry的注册扩展功能方法addContribution将该规范文件注册至RCP核心。 

具体地，本实施例中，对于所述步骤S10，通常Eclipse RCP包含的扩展点类型非常繁多，但在实际应用中，一般只用到其中一部分扩展点。例如，常用的扩展点有：工具栏扩展点、主菜单扩展点、弹出菜单扩展点、编辑器扩展点、视图扩展点、透视图扩展点等。在本实施例中，所述配置文件为 plugin.xml，所述规范文件为可扩展标记语言XML文件 

在本实施例中，对需要自动配置的扩展点增加自描述符的步骤如下： 

步骤1，对于每种需要自动配置的扩展点，根据其对应的plugin.xml文件规范，得到配置文件所需要的该扩展点的全部描述信息。 

例如，工具栏扩展点的plugin.xml文件规范类似于下面的XML配置代码： 

这表明，工具栏扩展点对应的配置文件包含的全部描述信息有：扩展类全限定名class，扩展功能唯一ID，扩展功能图标文件名icon，扩展功能显示名称label。 

步骤2，对于每种扩展点，根据配置文件plugin.xml的上述描述信息，相应地为对应的扩展类分别增加描述方法。由于每种扩展点对应的xml描述信息不完全相同，不同扩展类需要增加的描述方法也不完全相同。以工具栏扩展点为例，相应地，扩展类应增加获取扩展功能唯一ID的方法getID、获取扩展功能图标文件名的方法getIcon、获取扩展功能显示名称的方法getLabel等描述方法。其中，扩展类的全限定名不需要单独增加描述方法，可以通过类Class对象的获取类全限定名的getName方法直接获取当前类的全限定名。 

步骤3，通过为各种扩展类增加描述方法，使得扩展类能够完全实现自描述。其中，完全实现自描述是指，给定一个扩展类的具体对象，在一定条件下，有能力转换出符合plugin.xml文件规范的XML。 

进一步地，在所述步骤S10中，对于得到的已增加自描述符的扩展类， 分别为其增加转换为符合plugin.xml文件规范的XML的接口。 

为了较好地区分自动配置与手工配置的扩展类，使需要自动配置的扩展类统一继承AutoConfigExtension抽象类，该AutoConfigExtension抽象类要求子类均提供toPluginXml()方法。该AutoConfigExtension抽象类根据本扩展类所包含的各种信息，输出符合plugin.xml文件规范的XML文件。 

对于不同类型的扩展点，转换接口的具体处理也不相同，因此需要为每种自动配置的扩展点，分别实现toPluginXml()方法。 

对于给定的一个扩展类的对象，调用该转换接口toPluginXml()，能够得到与传统手工配置方法一致的符合plugin.xml文件规范的XML文件。 

在所述步骤S20中，程序启动前，搜索本系统中的需要自动配置的全部扩展类，即全部继承了AutoConfigExtension抽象类的扩展类，并反射成对象。 

在Eclipse RCP中，功能模块的基本单位是Bundle插件。由于RCP遵循OSGI（Open Service Gateway Initiative）规范，每个Bundle插件都具有单独的类加载器，这使得不能通过类加载器ClassLoader对象直接搜索出本系统的全部扩展类。 

如图2所示，本发明实施例中，搜索分布于各个Bundle插件中的全部扩展类的步骤如下： 

步骤S1、获取本系统中的所有Bundle插件。使用WorkbenchPlugin.getDefault().getBundleContext()的方式，获取本系统中的所有Bundle插件。为了加快启动速度，可以由开发人员定义业务插件的搜索范围，如定义业务插件Bundle ID的前缀，只有符合对应的搜索范围的Bundle插件，才进行下面的步骤，否则不处理。 

步骤S2、通过使用Bundle对象的getResources("/")方法，获取每个Bundle插件对应的绝对路径。 

步骤S3、获取每个Bundle插件中包含的全部类文件，得到所有的类的全限定名。Bundle插件对应的物理形式可能为jar包或文件夹，按照这两种情况分别进行遍历，获取该Bundle插件包含的全部类文件，进而得到所有的类的全限定名。 

步骤S4、根据类的全限定名，使用Bundle对象的loadClass方法，依次加载Class对象。判断该Class对象是否为需要进行自动配置的扩展类，即是 否继承了AutoConfigExtension类型，若是，则将其反射成对象，加入返回集合中。否则，丢弃。 

在所述步骤S30中，对于上述得到的每个需要自动配置的AutoConfigExtension抽象类对象，依次调用其toPluginXml方法，得到符合plugin.xml文件规范的XML。然后调用RCP内部的扩展功能注册管理类ExtensionRegistry的addContribution接口，将XML注册至RCP核心，使其生效。 

至此，RCP应用程序即可可以按照正常方式继续启动，RCP内部的核心类ExtensionRegistry统一管理了所有自动配置的扩展点、以及传统手工配置的扩展点，因此，本发明的自动配置方式，可以与传统手工方式相兼容，在需要的场合下，可以支持两种方式的混合使用。 

下面通过一个例子说明本发明实施例提供的Eclipse RCP扩展点配置方法与传统的扩展点开发方法的区别。 

例如，对于这样的一种需求：在某Eclipse RCP系统的工具栏上增加一个名为“浏览视频”的功能按钮。 

一、按照传统的扩展点实现方法，需要采取以下两个步骤来实现，其分别为： 

步骤1、编写扩展类，伪代码如下。 

步骤2、在plugin.xml中增加XML配置，基本格式如下。 

可见，每增加一个扩展功能，都需要增加扩展类、编写配置文件两个步骤，且配置文件格式复杂，难以记忆，开发工作量较大。 

二、而按照本发明实施例提供的扩展点配置实现方法，其实现步骤如下： 

步骤1、编写扩展类，继承AutoToolItemAction。这里假设AutoToolItemAction已经继承AutoConfigExtension类型，并实现了toPluginXml方法。该扩展类VideoAction的伪代码如下： 

可见，这种方式不需要人工编写任何配置文件，因此，可以简化开发步骤，提高开发效率，减少工作量，不易出错。 

如图3所示，本发明实施例提供的一种Eclipse RCP扩展点配置装置，其 包括： 

配置单元10，用于对扩展类增加可依据具体对象转换出符合配置文件规范的规范文件的自描述符，以及进一步用于对已增加自描述符的扩展类增加可对符合配置文件规范的规范文件进行转换的接口； 

搜索单元20，用于在程序启动前，搜索系统中的目标扩展类，并将其反射成具体扩展类对象； 

处理单元30，用于依据目标扩展类的自描述符以及接口将具体扩展类对象转换成规范文件，并调用富客户机平台RCP的扩展功能注册管理类ExtensionRegistry的注册扩展功能方法addContribution将该规范文件注册至RCP核心。 

本实施例中，继续参考图3，所述配置单元包括： 

第一配置模块101，用于对于需要自动配置的目标扩展点，根据其对应的配置文件规范，得到配置文件所需要的该扩展点的描述信息； 

第二配置模块102，用于为目标扩展点的扩展类分别增加与相应描述信息相对应的自描述符，使得目标扩展点的扩展类能够依据具体对象转换出符合配置文件规范的规范文件。 

继续参考图3，本实施例中，更为优选地，所述配置单元还包括： 

第三配置模块103，用于对已增加自描述符的扩展类统一继承自动搜索自动配置功能扩展AutoConfigExtension抽象类，该AutoConfigExtension抽象类要求其子类均提供转换为规范文件toPluginXml()方法，其中，所述配置文件为plugin.xml，所述规范文件为可扩展标记语言XML文件。 

继续参考图3，本实施例中，所述搜索单元包括： 

第一获取模块201，用于获取系统中的所有Bundle插件； 

第二获取模块202，用于使用Bundle对象的获取资源getResources("/")方法，获取每个Bundle插件对应的绝对路径； 

第三获取模块203，用于获取每个Bundle插件中包含的全部类文件，得到所有类的全限定名； 

加载模块204，用于根据类的全限定名，使用Bundle对象的加载类loadClass方法，依次加载Class对象； 

判断处理模块205，用于判断该Class对象是否继承了AutoConfigExtension抽象类，若是，则将其反射成具体扩展类对象，加入返回集合中，否则丢弃。 

继续参考图3，本实施例中，所述扩展点包括但不限于工具栏扩展点、主菜单扩展点、弹出菜单扩展点、编辑器扩展点、视图扩展点、透视图扩展点。 

以上所述仅为本发明的优选实施例，并非因此限制本发明的专利范围，凡是利用本发明说明书及附图内容所作的等效结构或等效流程变换，或直接或间接运用在其他相关的技术领域，均同理包括在本发明的专利保护范围内。 

Claims (10)

1.一种Eclipse RCP扩展点配置方法，其特征在于，包括：

对扩展类增加可依据具体对象转换出符合配置文件规范的规范文件的自描述符，以及对已增加自描述符的扩展类增加可对符合配置文件规范的规范文件进行转换的接口；

程序启动前，搜索系统中的目标扩展类，并将其反射成具体扩展类对象；

依据目标扩展类的自描述符以及接口将具体扩展类对象转换成规范文件，并调用富客户机平台RCP的扩展功能注册管理类ExtensionRegistry的注册扩展功能方法addContribution将该规范文件注册至RCP核心。

2.如权利要求1所述的Eclipse RCP扩展点配置方法，其特征在于，对扩展类增加可依据具体对象转换出符合配置文件规范的规范文件的自描述符的步骤包括：

对于需要自动配置的目标扩展点，根据其对应的配置文件规范，得到配置文件所需要的该扩展点的描述信息；

为目标扩展点的扩展类分别增加与相应描述信息相对应的自描述符，使得目标扩展点的扩展类能够依据具体对象转换出符合配置文件规范的规范文件。

3.如权利要求1所述的Eclipse RCP扩展点配置方法，其特征在于，对已增加自描述符的扩展类增加可对符合配置文件规范的规范文件进行转换的接口的方法为：

对已增加自描述符的扩展类统一继承自动搜索自动配置功能扩展AutoConfigExtension抽象类，该AutoConfigExtension抽象类要求其子类均提供转换为规范文件toPluginXml()方法，其中，所述配置文件为RCP插件开发框架规范中的plugin.xml，所述规范文件为可扩展标记语言XML文件。

4.如权利要求1所述的Eclipse RCP扩展点配置方法，其特征在于，程序启动前搜索系统中的目标扩展类并将其反射成具体扩展类对象的步骤包括：

获取系统中的所有Bundle插件；

使用Bundle对象的获取资源getResources("/")方法，获取每个Bundle插件对应的绝对路径；

获取每个Bundle插件中包含的全部类文件，得到所有类的全限定名；

根据类的全限定名，使用Bundle对象的加载类loadClass方法，依次加载Class对象，判断该Class对象是否继承了AutoConfigExtension抽象类，若是，则将其反射成具体扩展类对象，加入返回集合中，否则丢弃。

5.如权利要求1所述的Eclipse RCP扩展点配置方法，其特征在于，所述扩展点包括但不限于工具栏扩展点、主菜单扩展点、弹出菜单扩展点、编辑器扩展点、视图扩展点、透视图扩展点。

6.一种Eclipse RCP扩展点配置装置，其特征在于，包括：

配置单元，用于对扩展类增加可依据具体对象转换出符合配置文件规范的规范文件的自描述符，以及进一步用于对已增加自描述符的扩展类增加可对符合配置文件规范的规范文件进行转换的接口；

搜索单元，用于在程序启动前，搜索系统中的目标扩展类，并将其反射成具体扩展类对象；

处理单元，用于依据目标扩展类的自描述符以及接口将具体扩展类对象转换成规范文件，并调用富客户机平台RCP的扩展功能注册管理类ExtensionRegistry的注册扩展功能方法addContribution将该规范文件注册至RCP核心。

7.如权利要求6所述的Eclipse RCP扩展点配置装置，其特征在于，所述配置单元包括：

第一配置模块，用于对于需要自动配置的目标扩展点，根据其对应的配置文件规范，得到配置文件所需要的该扩展点的描述信息；

第二配置模块，用于为目标扩展点的扩展类分别增加与相应描述信息相对应的自描述符，使得目标扩展点的扩展类能够依据具体对象转换出符合配置文件规范的规范文件。

8.如权利要求7所述的Eclipse RCP扩展点配置装置，其特征在于，所述配置单元还包括：

第三配置模块，用于对已增加自描述符的扩展类统一继承自动搜索自动配置功能扩展AutoConfigExtension抽象类，该AutoConfigExtension抽象类要求其子类均提供转换为规范文件toPluginXml()方法，其中，所述配置文件为RCP插件开发框架规范中的plugin.xml，所述规范文件为可扩展标记语言XML文件。

9.如权利要求6所述的Eclipse RCP扩展点配置装置，其特征在于，所述搜索单元包括：

第一获取模块，用于获取系统中的所有Bundle插件；

第二获取模块，用于使用Bundle对象的获取资源getResources("/")方法，获取每个Bundle插件对应的绝对路径；

第三获取模块，用于获取每个Bundle插件中包含的全部类文件，得到所有类的全限定名；

加载模块，用于根据类的全限定名，使用Bundle对象的加载类loadClass方法，依次加载Class对象；

判断处理模块，用于判断该Class对象是否继承了AutoConfigExtension抽象类，若是，则将其反射成具体扩展类对象，加入返回集合中，否则丢弃。

10.如权利要求6所述的Eclipse RCP扩展点配置装置，其特征在于，所述扩展点包括但不限于工具栏扩展点、主菜单扩展点、弹出菜单扩展点、编辑器扩展点、视图扩展点、透视图扩展点。