在OSGi容器外和OSGi进行交互

在使用OSGi时,有些时候会需要在OSGi容器外获取OSGi服务,加载OSGi容器加载的class,或者说需要内嵌OSGi容器,本篇blog以一个简单的例子来说明如何基于equinox实现OSGi容器的内嵌,或者说通过程序来启动equinox,同时也通过此例子展示下如何在容器外来获取OSGi服务以及加载OSGi容器里面其他插件的class,同时还会附送一个如何让OSGi容器里的插件能加载到OSGi容器外的类的方法。

对于用过equinox的同学,或者看过我之前那两篇OSGi opendoc附带的例子的同学而言,都会知道通过命令行来启动equinox的方式,常见的一种脚本为:java -jar plugins/org.eclipse.osgi_3.2.1.R32x_v20060919.jar -configuration configuration -console,然后在当前目录的configuration目录下放置一个config.ini,在此config.ini中通过osgi.bundles=来配置需要加载和启动的插件,例如osgi.bundles=a.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中提供了一个getSystemBundleContext的方法,通过这个方法可以轻松的拿到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等,不过在动态化这块就没有那么好处理了,除非外部的容器也能提供相应的动态的机制,具体在下一篇的blog中再来细致的讨论下OSGi的动态化。

posted on 2009-04-24 21:10 BlueDavy 阅读(6725) 评论(11)  编辑  收藏 所属分类: OSGi、SOA、SCA

评论

# re: 在OSGi容器外和OSGi进行交互 2009-04-25 02:21 Link

好文!

这里,我有一个问题,假如我做一个RCP程序或者一个Eclipse插件,然后把你的用EclipseStarter.run()来启动一个OSGi框架的代码放在插件中,总会产生错误。

java.lang.IllegalStateException: Platform already running
at org.eclipse.core.runtime.adaptor.EclipseStarter.run(EclipseStarter.java:172)

我猜想RCP程序与一般的应用程序不同,在RPC程序中,RPC程序其于OSGi,OSGi平台已经启动,在插件中EclipseStart对应的是已经运行的这个RCP程序自身的OSGi框架,在RCP插件中再使用EclipseStarter.run()来启动另外一个OSGi框架的时候,就会出现“Platform already running"的错误。

之所以我需要这么做,我是想做基于RCP界面的一个OSGi框架运行的监控程序,在RCP界面上控制OSGi框架上各个Bundle的启动停止等,相当于OSGi控制台的可视化版本。这里的问题好象就归结到如何在一个OSGi框架内使用代码启动另一个OSGi框架,并返回被启动OSGi框架的BundleContext对象。

请问BlueDavy,就这个问题,能给我一些帮助和建议吗?  回复  更多评论   

# re: 在OSGi容器外和OSGi进行交互 2009-04-26 00:02 BlueDavy

@Link
恩,如果是在RCP里再调用EclipseStarter来启动肯定是不行的,因此如果是在RCP里的话,你可以通过直接调用EclipseStarter.getSystemBundleContext,然后在界面上也可以通过这个BundleContext获取到所有的bundle,进而通过Bundle接口控制Bundle的生命周期。  回复  更多评论   

# re: 在OSGi容器外和OSGi进行交互 2009-04-26 00:42 Link

@BlueDavy
看来真的没有办法启动另一个程序。如果按你回复中的做法,将得到RCP程序本身的OSGi总线上的交互信息,返回的BundleContext得到的bundle也是RCP程序本身总线上的bundle。里面加杂了也许我并不需要监控的bundle,没有办法达到我所说的:可视化的OSGi控制台的效果。  回复  更多评论   

# re: 在OSGi容器外和OSGi进行交互 2009-04-26 19:23 BlueDavy

@Link
另外一个做法是:可以自己通过context来install插件,这些插件就可以自己来管理了,具体可以参见我以前写过的一篇TPF的文章。
  回复  更多评论   

# re: 在OSGi容器外和OSGi进行交互 2009-04-27 20:35 Link

@BlueDavy 刚刚看了TPF的源代码,大概知道了你开发TPF的思路。TPF作为了一个本身独立的程序,自身也运行在OSGi总线上。安装于OSGi总线上的TPF bundle再去管理OSGi总线上的其他bundle,并提供start/stop等控制功能。事实上,TPF Web界面显示的已安装的bundle列表只是TPF内部维护的一个列表,在界面显示的bundle后面,OSGi总线实际上已经安装了16个bundle。这些先期安装的bundle在某些情况下是有可能影响本身希望在总结上部署的bundles的,比如某些版本冲突。
TPF利用了自己运行的总线,作为一个希望以RCP做界面的类TPF程序,如果也希望利用自己的总线,即使不使用EclipseStart的方法,按TPF的思路,先期安装的bundle的数目更多,可能的影响也许更大。一直想找一个另起一个OSGi总线的办法而不得其解。曾经想运用Runtime.exec()另起一个“干净”的总线,但同时要拿到总线的BundleContext也不可行。 :(
  回复  更多评论   

# re: 在OSGi容器外和OSGi进行交互 2009-04-27 21:39 BlueDavy

@Link
如果这样的话,或者可以考虑下自己做个OSGi Service,然后让所有的bundle都实现下这个标识性质的service...不太优雅的做法,:)
另外一个方法,就是基于扩展点模式来做。  回复  更多评论   

# re: 在OSGi容器外和OSGi进行交互 2009-04-30 01:50 Link

@BlueDavy
突然间有一个想法,Eclipse插件开发时,从开发的Eclipse平台运行一个包含正在开发的插件的运行时的平台,这个好象就是从一个OSGi总线启动另一个OSGi总线的例子。不知道它是怎么做的?  回复  更多评论   

# re: 在OSGi容器外和OSGi进行交互 2009-04-30 09:15 BlueDavy

@Link
那应该是外部启进程了,猜测而已...
  回复  更多评论   

# re: 在OSGi容器外和OSGi进行交互 2009-06-04 16:33 shuhao

link 你好,我现在也在做一个rcp使用osgi的开发,希望能与你交流。  回复  更多评论   

# re: 在OSGi容器外和OSGi进行交互 2009-06-04 16:35 shuhao

呵呵,刚忘记了留联系方式,qq:546187553
也希望做过这个方面的高手指点。  回复  更多评论   

# re: 在OSGi容器外和OSGi进行交互 2009-06-23 13:20 zjg_robin

如何在config.ini中指定目录格式的bundle?如何写法?我的写法如下:
file\:bundles/org.eclipse.core.runtime.compatibility.registry_3.2.200.v20080610@start

启动时报错,ZipError:error in opening zip file

谢谢!  回复  更多评论   


只有注册用户登录后才能发表评论。


网站导航:
 

公告

 









feedsky
抓虾
google reader
鲜果

导航

<2009年4月>
2930311234
567891011
12131415161718
19202122232425
262728293012
3456789

统计

随笔分类

随笔档案

文章档案

Blogger's

搜索

最新评论

阅读排行榜

评论排行榜