Eclipse插件开发中对于Jar包和类文件引用的处理(彻底解决插件开发中的NoClassDefFoundError问题)
目的:Eclipse插件开发中,经常要引用第三方包或者是引用其他插件中的类,由于插件开发环境引用类路径的设置和运行平台引用类路径的设置不同,经常导致开发过程OK,一旦运行则出现NoClassDefFoundError的问题。本文的目的是全面分析各种情况下类路径的设置,以避免这个问题的出现。
说明:Jar包和类路径实际上是一个概念,比如类com.bbebfe.Test.class打包为test.jar包,添加类引用就直接添加test.jar包。而如果是添加类文件路径,则添加包目录的上级目录,比如lib/com/bbebfe/Test.class,则添加lib文件夹,而不是com文件夹。在此后的例子中都只说明Jar包的形式。
分析:Eclipse插件开发对于Jar包的引用主要有三种原因:
1. 插件引用第三方包(普通的jar包或者类文件,不是插件)。
a) 开发环境引用配置,在prject -> properties -> Java build path中设置。
b) 运行环境引用配置,在plugin manifest编辑器的Runtime选项卡下的classpath中添加tset.jar包的引用(在MANIFEST.MF中表现为Bundle-ClassPath: lib/test.jar, 在plugin.xml表现为<runtime>节下的引用
i. 类文件在lib目录下,如下的设置导出lib目录下所有目录:
<runtime>
<library name="lib/">
<export name="*"/>
</library>
</runtime>
ii. test.jar在lib目录下:
<runtime>
<library name="lib/test.jar">
<export name="*"/>
</library>
</runtime>
iii. 实际上上面的设置可以简化为:
<runtime>
<library name="lib/"/>
</runtime>
或者
<runtime>
<library name="lib/test.jar"/>
</runtime>
默认即导出lib目录下的所有包和jar下的所有包
实际上,执行b)项设置后,会自动执行a)项设置,使开发环境和运行环境同时有效。
2. 插件B引用插件工程A(非Eclipse插件,而是自己另外一个插件项目中的类)
a) 首先必须将A中的B需要的类暴露(export)出来
i. 如果有MANIFEST.MF文件,则表现为plugin manifest编辑器中runtime节的exported packages,通过这里添加需要export的包。在manifest.mf文件中是Export-Package: com.bbebfe
ii. 如果只有plugin.xml,则表现为plugin manifest编辑器中runtime节的library visibility。在plugin.xml文件中表现为
<runtime>
<library>
<export name=”com.bbebfe.*”/>
...
b) 在B插件工程的plugin manifest编辑器中的dependencies选项卡中添加对A插件的引用(这要求运行对话框中的plugins列表的workspace plugins中必须包含A插件)。
c) 如果B工程是一个RCP工程,则必须在product编辑器的configuration选项卡中包含A插件工程。
3. 插件B引用Eclipse插件A的类。
a) Eclipse插件中的类都是Exported,因此这步省略。
b) 在B插件工程的plugin manifest编辑器中的dependencies选项卡中添加对A插件的引用(这要求preferences -> plugin development -> target目标平台必须包含A插件,且运行对话框的plugins列表中的target platform中必须选中A插件)。
总结:如果B插件引用的A也是一个插件,则A必须出现在B插件的plugin dependencies引用中,而不是其他地方,否则肯定会出现运行时NoClassDefFoundError问题(因此必须在plugin manifest编辑器的dependencies选项卡下进行设置)。而且只需要在这里设置的设置对开发环境和运行环境同时有效)
举例 :
开发一个SQL的编辑器插件,扩展名为sql,但运行后,用file -> open file...打开test.sql文件,Activator能够构造,但编辑器打不开,添加调试信息,发现ZSqlEditor类根本没有构造。也没有任何错误信息提示。因此判断错误发生在系统加载插件类的过程中(Eclipse用Java反射从磁盘动态加载插件的类文件)。
打开runtime workbench下的.log文件,发现Eclipse在加载插件时出现NoClassDefFoundError,如下:
java.lang.NoClassDefFoundError: org/eclipse/jface/text/source/ISourceViewer
但是开发过程中并没有提示错误,打开目标平台设置,org.eclipse.jface.text插件也在列表中选中。
经过检查发现,开发过程中在project->properties中对org.eclipse.jface.text_3.2.2.r322_v20070104.jar(插件)的引用是定位到磁盘的硬引用。而不是出现在plugin dependencies中,造成了运行时找不到类的错误。解决方法如下:
a) 将这个硬引用删除。
b) 使用plugin manifest编辑器下的dependencies选项卡添加对org.eclipse.jface.text插件的引用。问题解决。(或者在plugin.xml的节中或者在MANIFEST.MF的require-bundle节中添加对org.eclipse.jface.text插件的引用也可)