前面,我们都是通过Eclipse启动我们的Bundle。但是,在有些时候,我们希望自己来控制OSGi的容器的启动,并且在OSGi的容器外部获取OSGi的服务,甚至是把OSGi的容器内嵌到我们的应用之中。下面我们就来看一下如何把Equinox 嵌入到应用中。由应用来启动Equinox 、获取OSGi的服务,以及加载OSGi容器中的其他插件的类。并且也会演示OSGi容器中的插件如何加载OSGi容器外的类的方法。
我们在前面演示了如何通过命令行来启动Equinox , 常见的一种脚本为:java-jar plugins/org.eclipse.osgi_3.4.3.R34x_v20081215-1030.jar -configuration configuration -console,然后在当前的configuration目录下放置一个config.ini,在此config.ini中通过 osgi.bundles=来配置要加载和启动的插件,例如osgi.bundles=example.jar@start ,那么要在程序中启动Equinox 容 器,其实是做差不多的事情。
通过查看Equinox 的代码,会看到调用上面的org.eclipse.osgi.jar后执行的是EclipeStarter中的静态run方法,因此只须在外部传入合适的参数,并调用此run方法即可完成Equinox 的启动,在程序中启动Equinox ,通常希望做到的是能够指定config.ini 的配置信息及插件的位置,而不是由Equinox 去决定。如果不进行设置,默认情况下EclipseStarter 将会在工作路径下产生 configuration,并以该configuration目录下的config.ini作为Equinox 启动的配置。对于 osgi.bundles配置的bundle的路径,默认则为当前EclipseStarter 代码所在的目录,例如上面的命令行,Equinox 在启动时就会从plugins目录中去加载插件,这通常是无法满足在程序中启动Equinox 的需求的。如果想自定义Equinox 启动的配置信息,而不是通过加载指定的configuration中的config.ini,那么可以在程序中调用 FrameworkProperties.setProperty来设置启动Equinox 的配置信息。如希望指定osgi.bundles中指定加载的bundle的相对路径,那么可以在Equinox 启动的配置信息中增加osgi.syspath的设定:FrameworkProperties.setProperty("osgi.syspath",你希望指定的bundle所在的路径)。Equinox 启动的配置信息还有很多种,有具体需要的话可以查看EclipseStarter 中processCommandLine的方法。通过这样的方式,就可以启动Equinox :EclipseStarter .run(new String[]{"-console"},null);按照上面的方式就可以实现在外部程序中启动equinox 了。
OSGi通过BundleContext来获取OSGi服务,因此想在OSGi容器外获取OSGi服务,首要的问题就是要在OSGi容器外获取到BundleContext,EclipseStarter 中 提供了一个getSystemBundle- Context的方法,通过这个方法可以轻松拿到BundleContext,而通过BundleContext则可以轻易拿到OSGi服务的实例。不过 这个时候要注意的是,如果想执行这个OSGi 服务实例的方法,还是不太好做的,因为容器外的classloader和OSGi服务实例的class所在的classloader并不相同,因此不太好 按照java对象的方式直接去调用,更靠谱的是通过反射去调用。
如果想在容器外获取到OSGi容器里插件的class,一个可选的做法是通过BundleContext获取到Bundle,然后通过Bundle 来加载 class,采用这样的方法加载的class就可以保证是相同的。否则会出现容器外的一个A.class不等于容器里插件的A.class,其中原因对于 稍微知道java classloader机制的人都是理解的。
按照上面的说法,一个简单的启动Equinox 及与OSGi容器交互的类可以这么写:
/** * 启动并运行equinox容器 */ public static void start() throws Exception{ // 根据要加载的bundle组装出类似a.jar@start,b.jar@3:start这样格式的 osgibundles字符串来 String osgiBundles=""; // 配置Equinox的启动 FrameworkProperties.setProperty("osgi.noShutdown", "true"); FrameworkProperties.setProperty("eclipse.ignoreApp", "true"); FrameworkProperties.setProperty("osgi.bundles.defaultStartLevel", "4"); FrameworkProperties.setProperty("osgi.bundles", osgiBundlesBuilder.toString()); // 根据需要设置bundle所在的路径 String bundlePath=""; // 指定要加载的plugins所在的目录 FrameworkProperties.setProperty("osgi.syspath", bundlePath); // 调用EclipseStarter,完成容器的启动,指定configuration目录 EclipseStarter.run(new String[]{"-configuration","configuration", "-console"}, null); // 通过EclipeStarter获得BundleContext context=EclipseStarter.getSystemBundleContext(); } /** * 停止equinox容器 */ public static void stop(){ try { EclipseStarter.shutdown(); context=null; } catch (Exception e) { System.err.println("停止equinox容器时出现错误:"+e); e.printStackTrace(); } } /** * 从equinox容器中获取OSGi服务instance 还可以基于此进一步处理多服务接口实现的状况 * * @param serviceName 服务名称(完整接口类名) * * @return Object 当找不到对应的服务时返回null */ public static Object getOSGiService(String serviceName){ ServiceReference serviceRef=context.getServiceReference (serviceName); if(serviceRef==null) return null; return context.getService(serviceRef); } /** * 获取OSGi容器中插件的类 */ public static Class<?> getBundleClass(String bundleName, String className) throws Exception{ Bundle[] bundles=context.getBundles(); for (int i = 0; i < bundles.length; i++) { if(bundleName.equalsIgnoreCase(bundles[i].getSymbolicName())){ return bundles[i].loadClass(className); } }
在实现了OSGi容器外与OSGi交互之后,通常会同时产生一个需求,就是在OSGi容器内的插件要加载OSGi容器外的类,例如OSGi容器内提供了一 个mvc框架,而Action类则在OSGi容器外由其他的容器负责加载,那么这个时候就会产生这个需求了,为了做到这点,有一个比较简单的解决方法,就 是编写一个Bundle,在该Bundle中放置一个允许设置外部ClassLoader的OSGi服务,例如:
public class ClassLoaderService{ public void setClassLoader(ClassLoader classloader); }
基于上面的方法,在外部启动Equinox 的 类中去反射执行ClassLoaderService这个OSGi服务的setClassLoader方法,将外部的classloader设置进来,然 后在OSGi容器的插件中要加载OSGi容器外的类的时候就调用下面这个ClassLoaderService去完成类的加载。
基于以上说的这些方法,基本上可以较好地实现OSGi容器与其他容器的结合,例如在tomcat中启动OSGi等,或者在我们自身的应用中来控制OSGi的容器。到这里,我们基本上完成了对于Equinox 的介绍,下面来看另外一个应用也较广泛的OSGi的容器--Felix。