基于Eclipse开发轻量级Spring插件

摘要本文介绍如何在Eclipse中利用Spring框架作为一个平台来创建轻量级的能够与你的现有J2EE应用程序无缝集成的插件。

　　一. 引言

　　一般地，企业软件产品都要求在客户端具有定制能力，而且当客户必须修改核心产品的配置来引入他们自己的定制时一般都要求进行更新操作。借助于易于扩展和可升级的高度模块化的软件，插件技术能够提供针对这种典型场所下的完美解决方案。

　　注释1-什么是插件呢？一个插件是使用什么样的代码构成的？

　　在众多的定义当中，我认为最好的定义当属Eclipse工程中所定义的：插件是一种代码贡献，它能够把代码添加到一个系统中的众所周知的扩展点处。也就是说，一个插件是一个良好定义的代码包（例如一个jar文件或目录），它提供足够的配置能力来实现在系统中的一个特定的众所周知的位置插入和激活自身。

　　插件本身还可以定义另外的其它插件能够扩展的扩展点。一个扩展点定义了一个语言接口（该插件将提供它的一个实现）和使用该被发现的插件的组件。一个扩展点能够接受被动态地发现和在运行时刻配置的插件。

　　借助于一种拥有清楚定义的扩展点的插件环境，核心产品可以自由升级，而且插件本身可以根据独立的计划发行和升级。例如，借助于我的开源Classpath助理工程（基于Eclipse的插件框架），我可以按常规来升级我的Eclipse，而且还可以轻松地发行我自己的插件的更新版本。

　　非凡对于Java开发者来说，与现有J2EE组件（参考"注释2-J2EE组件不是插件吗？"）相比，插件提供了一种更好的升级技术。可以设想你的许多EJB是由不同的开发小组构建的；然后，在了解它们能够良好工作的情况下，就可以把它们整合到一个应用程序中。一个插件架构应该是答应进行这种级别的组件化的。

　　注释2-J2EE组件不是插件吗？

　　是的，J2EE组件，例如EJB和Servlet，都不是插件。尽管它们都具有一定程度的"可插入性"（这是指，你能够交换一个EJB或Servlet实现），但是配置它们并不那么清楚明快，而且它们缺乏一个插件所具有的轻易的升级能力。例如，Servlet无法把代码与配置结合到一起。因此，尽管你能够在其自己的jar文件中打包一个servlet实现；但是，此时你往往需要修改web.XML以便servlet容器能够识别它。

　　乍看上去，EJB似乎更象插件-它们包含提供有关自己信息的发布描述符。然而，EJB也不是插件，因为，典型情况下，它们都要求外部配置(一种在EAR的application.xml中的引用)；并且，典型地，它们在其各自的发布描述符中进行彼此参考。这两种特征都使一个EJB无法成为"插件式可发布的"。

　　借助于流行的Spring框架的BeanFactoryPostProcessor接口，开发者可以轻松地创建一个轻量级插件框架。本文正是想讨论如何实现这一点；同时，还要向你展示一个使用轻量级插件的工作示例。

　　二. 预备你的插件平台

　　在你的平台能够支持可插入的组件前，它需要满足下列两个标准：

　　· 组件必须是自发现的。你已经了解到J2EE组件不能成为真正插件的准确理由。典型情况下，你应该找到一个需要升级的外部配置文件以便该平台能够感知新的代码。

　　· 组件必须包含足够信息以便在应用程序内部集成或配置其本身。

　　假如你仅是添加一些不需要与系统进行协作的代码（也就是说，松耦合的），那么自动发现就是很简单的。真正的挑战是结合有紧密集成的自发现。

　　三. Spring中的自发现功能

　　事实证实，Spring实际上为支持插件开发作了比较好的预备。Spring已经能够在若干种bean上下文文件中存储配置，并且它使得自发现配置文件非常简单。例如，下面的Spring语句自动发现以ctx.xml结尾的存在于classpath的META-INF/services目录下的任何文件：

＜import resource="classpath*:META-INF/services/*.ctx.xml" /＞
　　这种现成的功能正是当构建轻量级插件框架时你要利用的一个特色。

　　注重，Spring并不关心它自己的代码自动发现功能。这通常不是一个问题，因为大多数J2EE容器都提供一个lib目录，存放于这个目录下的任何jar文件将被自动地添加到classpath中。这意味着，假如你想以jar文件形式捐献你的代码的话，那么在任何一种J2EE容器中实现自发现都会是相当轻易的事情。

　　在一个应用程序服务器外，使用例如ant这样的工具来实现jar文件的自发现也是非常轻易的。下列的Apache Ant XML以一种与一个应用程序服务器类似的方式检测所有的存在于lib目录下的jar文件：

＜path id="classpath"＞
＜fileset dir="${basedir}/lib"＞
＜include name="**/*.jar"/＞
＜/fileset＞
＜/path＞

＜target name="start.server" description="launches the server process"＞
＜java classname="platform.bootstrap.Server"＞
＜classpath refid="classpath" /＞
＜/java＞
＜/target＞

　　因此，尽管Spring并不直接支持自发现功能，但是通过使用标准技术，你仍然可以使你的代码轻易地实现自发现。这一点，与Spring的能够自动检测配置的能力相结合，就可以使你既能够实现代码捐献的目的也能够使你的代码在系统中被发现和激活。 四. 在Spring中实现自配置

　　你需要进一步实现的是，使插件具有自配置能力。尽管Spring并不直接支持这种功能，但是，借助于它提供的一些工具，实现这一目标也是相当直接的。实现自配置的要害部分是BeanFactoryPostProcessor，这是一个Spring调用的接口（该调用应该是在所有配置被发现和加载到一个内存描述之后，但在创建实际的对象之前发生）。

　　通过使用BeanFactoryPostProcessor，你可以动态地把所有的bean组合到一起而不必修改原始的文件系统配置。下列代码是我的BeanFactoryPostProcessor实现的核心部分：PluginBeanFactoryPostProcessor(下载源码中提供了完整的类)：

private String extensionBeanName;//经由spring设置（在此没有显示setter)
private String propertyName;//经由spring设置（在此没有显示setter)
private String pluginBeanName;//经由spring设置（在此没有显示setter)
/*
*(非Javadoc)
*@请参考BeanFactoryPostProcessor#postProcessBeanFactory(ConfigurableListableBeanFactory)
*/
public void postProcessBeanFactory(
ConfigurableListableBeanFactory beanFactory)
throws BeansException {