分类:
2008-10-17 14:27:40
摘要:这篇文章描述了在Eclipse RCP中引入依赖注射机制的一个简单方法。为了避免污染Eclipse平台的基础设施并且透明的为RCP添加IoC框架,我们使用了动态字节码操作(使用ObjectWeb ASM类库),类加载agent以及标注技术的组合。
Eclipse胖客户端平台(Rich Client Platform,RCP)是一个功能强大的软件基础(software foundation),它基于相互联系并协作的插件,允许开发人员创建通用的应用程序。RCP使得开发人员可以更加关注应用程序的业务逻辑而不是花大量时间来重新发明轮子去编写大量的应用程序管理逻辑。
控制翻转(IOC)和依赖注射是一种减少程序耦合性的设计模式。它们遵循了一个简单的原则:你不必自己创建对象,你只需要描述如何创建对象。你不必去实例化或者定位你的组件需要的服务,你只需要去描述哪个组件需要哪个服务,其他组件(通常是容器)来负责将它组装好。这也就是著名的好莱坞原则:不要打电话给我们,我们会打给你。
这篇文章描述了在Eclipse RCP中引入依赖注射机制的一个简单方法。为了避免污染Eclipse平台的基础设施并且透明的为RCP添加IoC框架,我们使用了动态字节码操作(使用ObjectWeb ASM类库),Java类加载agent以及Java标注技术的组合。
什么是Eclipse胖客户端平台?
简单来说,Eclipse胖客户端平台是一组类库,软件框架以及运行环境,它可以用来创建独立运行并且经常需要与网络交互的应用程序。
尽管Eclipse是作为一个集成开发环境(IDE)框架设计的,但是,从3.0版本开始,整个项目已经被重构成各种独立的组件,以便于可以使用这些组件的一个子集来构建任意的应用程序。这个子集构成了RCP,它包含以下几种组件:基本运行环境,用户接口组件(SWT和JFace),插件以及OSGi层。图1展示了Eclipse平台的主要组件。
整个Eclipse平台是基于插件和扩展点(extensions points)这样一个关键概念的。一个插件是可以独立开发和发布的功能的最小单元。它一般会打包成一个jar文件并且通过增加功能来扩充Eclipse平台(例如,增加一个编辑器,工具栏按钮或者一个编译器)。整个平台就是一组互相联系并通讯的一组插件的集合。一个扩展点是一个已经存在的互相联系的端点,可以被其他插件用来添加功能(功能:在Eclipse术语中叫做扩展)。扩展和扩展点通过XML配置文件定义并绑定在插件中。
尽管插件已经使用了关注点分离这样一个重要的模式,但是插件之间的强相互联系和通讯会导致他们之间的强依赖关系。一个典型的例子就是需要定位应用程序需要的各种单例(Singleton)服务,例如数据库连接池,日志处理器,或者用户偏爱(preference)的设置信息的保存等。控制反转和依赖注射是消除这些依赖的可行解决方案。
控制反转和依赖注射
+控制反转是一种设计模式,它主要关注如何将服务(或者应用程序组件)的定义和服务如何定位它们依赖的服务进行分离。为了完成这种分离,一般都会依赖一个容器,或者定位框架(locator framework),维护现存服务的列表+提供一种方法来将组件和它们依赖的服务绑定在一起。
+提供一种方法让应用程序代码可以请求一个已经配置好的对象(例如,一个所有依赖都已经满足的对象),这样就可以保证该对象所有相关的服务都已经可用了。
现存的框架一般都使用下面三种基本技术的组合来绑定服务和组件:
+类型一(基于接口):服务对象需要实现一个专门的接口,这个接口为这些服务对象提供了一个对象,服务可以通过这个对象来查询它们的依赖。这是一些早期的容器使用的模式,例如Excalibur. +类型二(基于setter):通过JavaBean属性的setter方法将依赖的服务赋值给服务对象。HiveMind和Spring都是通过这种方式来实现的。
+类型三(基于构造函数):依赖的服务通过构造函数的参数提供(不通过JavaBean属性暴露)。这是PicoContainer使用的唯一方式。HiveMind和Spring也使用了这种方式。
我们将采用第二种方式的变种,通过带标注的方法来提供服务。(示例应用的源代码在资源中可以找到)。声明依赖可以采用以下方式:
@Injected public void aServicingMethod( Service s1, AnotherService s2) { // save s1 and s2 into class variables // to use them when needed}
控制反转容器会查找Injected标注并且使用需要的参数来调用这个方法。在我们为Eclipse平台引入IoC的过程中,在服务和可服务对象间建立绑定关系的代码被封装在一个Eclipse插件中。这个插件定义了一个扩展点(com.onjava.servicelocator.servicefactory),用来为应用程序提供服务工厂。当一个可服务对象需要配置时,插件会向工厂请求服务的实例。正如下面的代码,ServiceLocator类将会完成所有的工作。(我们会跳过那些处理扩展点解析的代码,因为这些代码会很简单)
/** * Injects the requested dependencies into the * parameter object. It scans the serviceable * object looking for methods tagged with the * Injected} annotation.Parameter types are * extracted from the matching method. An instance * of each type is created from the registered * factories (see IServiceFactory})。 When * instances for all the parameter types have been * created the method is invoked and the next one * is examined. * * @param serviceable the object to be serviced * @throws ServiceException */
public static void service(Object serviceable) throws ServiceException {
ServiceLocator sl = getInstance();
if (sl.isAlreadyServiced(serviceable)) {
// prevent multiple initializations due to
// constructor hierarchies
System.out.println( "Object " + serviceable + " has already been configured ");
return; }
System.out.println("Configuring " + serviceable);
// Parse the class for the requested services
for (Method m : serviceable.getClass()。getMethods()) {
boolean skip=false;
Injected ann=m.getAnnotation(Injected.class)
; if (ann != null) {
Object[] services = new Object[m.getParameterTypes()。length];
int i = 0;
for(Class<?> klass :m.getParameterTypes()){
IServiceFactory factory = sl.getFactory(klass,ann.optional());
if (factory == null) {
skip = true;
break; }
Object service = factory.getServiceInstance();
// sanity check: verify that the returned
// service's class is the expected one
// from the method
assert(service.getClass()。equals(klass) || klass.isAssignableFrom(service.getClass()));
services[i++] = service ; }
try {
if (!skip)
m.invoke(serviceable, services); }
catch(IllegalAccessException iae) {
if (!ann.optional())
throw new ServiceException( "Unable to initialize services on " + serviceable + ": " + iae.getMessage(),iae); }
catch(InvocationTargetException ite) {
if (!ann.optional())
throw new ServiceException( "Unable to initialize services on " + serviceable + ": " + ite.getMessage(),ite); } } }
sl.setAsServiced(serviceable);}
既然这个服务工厂返回的服务同样可以是一个可服务对象,这个策略允许定义一种服务层次(但是,目前并不提供对循环依赖的支持)。
[1]