开发Eclipse插件(Plug-ins)

原创 2005年02月28日 09:05:00

Eclipse最有魅力的地方就是它的插件体系结构。在这个体系中重要的概念是扩展点(extension points),也就是为插件提供的接口。每一个插件都是在现有的扩展点上开发,并可能还留有自己的扩展点,以便在这个插件上继续开发。

由于有了插件,Eclipse系统的核心部分在启动的时候要完成的工作十分简单:启动平台的基础部分和查找系统的插件。在Eclipse中实现的绝大部分功能是由相应的插件完成的,比如WrokBench UI插件完成界面的外观显示,Resource Management插件完成维护或生成项目或文件等资源管理工作(在下面的第二个例子就会用到这个插件),而Version and Configuration Management (VCM)插件则负责完成版本控制功能,等等。虽然以上提到的每一个功能都是绝大多数IDE环境所必备的功能,Eclipse却也把它们都做成了插件模式,甚至用来开发Java程序的开发环境(Java development tooling,JDT)也只不过是Eclipse系统中的一个普通插件而已。整个Eclipse体系结构就象一个大拼图,可以不断的向上加插件,同时,现有插件上还可以再加插件。下面的插件开发示例就是在WorkBench UI插件中的观察窗口扩展点上开发的。

本文第一部分介绍过Eclipse的开发界面其中之一就是观察窗口,它通常配合编辑窗口显示一些有用的信息,在这里我们只简单生成一个显示欢迎信息的观察窗口,假设新插件的名子叫Welcome。

第一步,先用向导新建一个Java项目。我们可以在菜单栏选择FileàNew,或用工具栏的向导按键,或是在资源窗口用鼠标右键菜单中的New,打开向导对话框,然后用缺省方式创建项目。并在项目中建立一个Welcome.java文件,代码如下:


package com.nidapeng.eclipse.plugin;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.SWT;
import org.eclipse.ui.part.ViewPart;
public class Welcome extends ViewPart {
	Label label;
	public Welcome() {
	}
	public void createPartControl(Composite parent) {
		label = new Label(parent, SWT.WRAP);
		label.setText("Welcome to Eclipse");
	}
	public void setFocus() {
	}
}

为使这个程序能正常编译,要配置它的编译环境,即指定所需的CLASSPATH。在Eclipse中可以用几种方法,常用的是两种:第一是在资源窗口或Java包窗口选中该项目,点击鼠标右键,在打开的菜单中选择属性(Properties),之后在属性对话框中选择Java Build PathàLibraries,用Add External JARs功能添加三个包,它们都是Eclipse的现有插件的类包,可以在"你的Eclipse安装路径/plugins"下面的相应路径中找到。分别是org.eclipse.core.runtime插件中的runtime.jar,org.eclipse.swt中的swt.jar和org.eclipse.ui中的workbench.jar。第二种指定CLASSPATH的方法是先将以上提到的三个包直接导入到Eclipse中的某下一个项目中。如果导入到和Welcome.java相同的项目中,则无需进一步指定CLASSPATH,否则需要在项目的属性菜单中选择Java Build PathàProjects,然后选中这三个包所在的项目。

在我们的项目中还要生成一个XML文件,它的名字必须plugin.xml。代码如下:


<?xml version="1.0" encoding="UTF-8"?>
<plugin
   id="com.nidapeng.eclipse.plugin"
   name="Welcome to Eclipse"
   version="1.0"
   provider-name="Ni Dapeng">
<requires>
   <import plugin="org.eclipse.ui"/>
</requires>
<runtime>
   <library name="welcome.jar"/>
</runtime>
<extension
      point="org.eclipse.ui.views">
   <category
         name="Welcome"
         id="com.nidapeng.eclipse.plugin.category1">
  </category>
   <view
         name="Welcome to Eclipse"
         category="com.nidapeng.eclipse.plugin.category1"
         class="com.nidapeng.eclipse.plugin.Welcome"
         id="com.nidapeng.eclipse.plugin.view1">
  </view>
</extension>
</plugin>

在plugin.xml中一共有四个主要的标签:plugin,requires,runtime,extension。其中plugin标签的属性提供的是我们要开发的Welcome插件的基本信息,除了name,version,provider-name等,最重要的是id,它要求不能和现有的Eclipse插件id有冲突,因此我们用包名作为插件的id。requires标签中所列出的是需要的插件,这里我们要用到Eclipse Workbench和SWT API,因此导入了org.eclipse.ui插件。runtime标签指明的是我们开发的插件所在JAR包的文件名。extension标签是插件扩展点的信息。org.eclipse.ui.views是Eclipse系统提供的观察窗口扩展点,我们的例子是一个观察窗口(View),这表明我们是要在 org.eclipse.ui.views扩展点上进一步开发。extension中还包括category和view两个标签,在后续的启动Welcome插件步骤中,我们就会知道这两个标签的含义。要注意的是category和view标签的id的唯一性,并且在view的属性中声明了Welcome插件的类名。

在Eclipse中为plugin.xml提供了缺省可视化的编辑器,在编写plugin.xml过程中可以借助这个编辑器完成一些工作。如果你直接录入了plugin.xml文件源代码,还可以用这个编辑器校验你的代码:如果编辑器不能正确读入,就表明你的plugin.xml有一些问题。

在确认Weclome.java和plugin.xml都正确无误之后,可以用Eclipse菜单栏中的Export命令将Weclome.java导出为JAR文件,它的名子应该和plugin.xml中runtime声明的JAR相一致。同时导出plugin.xml。安装Welcome插件的方法和本文第一部分介绍的安装Tomcat插件方法是一样的:首先在"Eclipse的安装路径/plugins"路径下面建立一个com.nidapeng.eclipse.plugin路径,然后将Weclome.jar和plugin.xml拷到这个路径下。之后必需重新启动Eclipse,在Eclipse启动的时候,它会搜索所有在插件路径下的插件并注册它们(仅仅是注册,只有在需要某个插件的时候,Eclipse才会启动它)。在重新启动的Eclipse的菜单栏中选择PerspectiveàShow ViewàOthers,在打开的对话框中我们会找到在plugin.xml中extension的category标签中声明的name属性:Welcome。在Welcome的支结点中包含了view标签name属性:Welcome to Eclipse。选中它并确认,Welcome窗口就会显示在Eclipse Workbench上的某个位置 。如果在执行了以上操作,但没有显示新窗口,可以再次打开Show View菜单,此时在菜单中应该有新一顶选择:Welcome to Eclipse,然后选中它。

上面我们完成了一个观察窗口的插件,但这个操作过程对开发稍微复杂一些的插件就显得不太方便了:每次测试都要将代码打包,发布,再重新启动Eclipse系统!为此Eclipse提供了一个专门为开发插件而做插件(有点绕嘴):Plug-in Development Environment(PDE)。本文前面曾提到,目前Eclipse的Release或Stable版本缺省提供了这个插件,因此如果安装的Eclipse是这两个版本中的一个就可以直接进行下面的步骤。下面我们再用PDE环境开发一个稍微复杂一些的插件。

第一步仍然要新建一个项目,只是在向导中不是用Java项目,而是Plug-in Development中的Plug-in Project。在应用向导生成新项目的时候,要注意两点:第一是PDE的项目名称就是plugin的id,因此要保证它的唯一性,这里我们的项目名是com.nidapeng.eclipse.plugin.pde。其次为了进一步说明Eclipse插件的结构,在Plug-in Code Generators中,选择用向导模板生成一个缺省的插件,如图六:

图六
图六

这个用缺省方式生成的插件类对于我们将要的代码并不是必需的,也可以用生成空插件的方式建立我们的项目,这样做只是为进一步说明Eclipse的插件结构。

项目生成之后,在我们的项目中会包含一个PdePlugin.java文件,它就是以缺省方式生成的插件类。注意到它继承了AbstractUIPlugin类,而AbstractUIPlugin类实现了org.eclipse.ui.plugin接口。事实上,所有的Eclipse插件都会有一个相应的实现plugin接口的类,这个类将是新插件的主类(类似于有main()函数的Java类),它负责管理插件的生存期。在我们的AbstractUIPlugin继承子类中,可以用singleton模式来保存在Eclipse中的生成的该插件的第一个也是唯一实例,一般来说,在该继承子类中也要实现一个getDefault()方法以返回当前插件的实例。而且,当Eclipse首次使用该插件的时候,这个主类将是第一个被调用的类,因此我们也可以在它的代码中执行一些初始化的工作。而且如果插件需要使用Preferences,Dialogs或Images资源,也可以通过这个类中的相应方法来得到它们的实例,如用其中的getDialogSettings(),getPreferenceStore(),getImageRegistry()方法。

但是象前面提到的,PdePlugin.java对下面的例子并不是必需的,我们不用对它进行任何修改。在我们第一个例子中的Weclome插件,根本就没有生成AbstractUIPlugin的继承子类,此时系统会自动为Weclome插件生成一个缺省的主类(类似于Java类构造函数,如果没有声明,系统会指定一个默认的构造函数)。

下面的代码是才真正实现了我们新插件的功能,假设这个插件名子是NoticeView:


package com.nidapeng.eclipse.plugin.pde;
import org.eclipse.core.resources.*;
import org.eclipse.core.resources.IResourceChangeEvent;
import org.eclipse.core.runtime.CoreException;
import java.util.ResourceBundle;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.ui.part.ViewPart;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Display;
public class NoticeView extends ViewPart implements 
Runnable,IResourceChangeListener ,IResourceDeltaVisitor{
	private ResourceBundle resourceBundle;
	private Label label;
	private Display disp; 
	private String dispTxt;
	public NoticeView() {
    ResourcesPlugin.getWorkspace().addResourceChangeListener(this,
      IResourceChangeEvent.PRE_CLOSE
      | IResourceChangeEvent.PRE_DELETE
      | IResourceChangeEvent.PRE_AUTO_BUILD
      | IResourceChangeEvent.POST_AUTO_BUILD
      | IResourceChangeEvent.POST_CHANGE);
	}
	public static IWorkspace getWorkspace() {
		//ResourcesPlugin插件的主类!
 		return ResourcesPlugin.getWorkspace();
 	}
	public void createPartControl(Composite parent) {
   		label = new Label(parent, SWT.WRAP);
		label.setText("change your project status...");
         disp = Display.getDefault();
 	}
	public void setFocus() {
 	}
	// 实现IResourceChangeListener接口中的resourceChanged方法
	public void resourceChanged(IResourceChangeEvent event) {
  		IResource res = event.getResource();
  		switch (event.getType()) {
   			case IResourceChangeEvent.PRE_CLOSE :
    				dispTxt = res.getFullPath() + " is about to closed!";
    				break;
   			case IResourceChangeEvent.PRE_DELETE :
    				dispTxt = res.getFullPath() + " is about to be deleted!";
   				break;
   			case IResourceChangeEvent.POST_CHANGE :
    				try {
     				event.getDelta().accept(this);
    				} catch (CoreException e) {
    					 e.printStackTrace();
    				}
    				break;
   			case IResourceChangeEvent.PRE_AUTO_BUILD :
    				try {
     				event.getDelta().accept(this);
    				} catch (CoreException e) {	
     				e.printStackTrace();
    				}
    				break;
   			case IResourceChangeEvent.POST_AUTO_BUILD :
    				try {
     				event.getDelta().accept(this);
    				} catch (CoreException e) {
     					e.printStackTrace();
    				}
    				break;
  		}
  		disp.syncExec(this);
 	}
 	// 实现IResourceDeltaVisitor接口中的visit方法
 	public boolean visit(IResourceDelta delta) {
  		IResource res = delta.getResource();
  		switch (delta.getKind()) {
   		case IResourceDelta.ADDED :
    			dispTxt = "Resource "+res.getFullPath()+" was added.";
    			break;
   		case IResourceDelta.REMOVED:
    			dispTxt = "Resource "+res.getFullPath()+" was removed.";
   			break;
   		case IResourceDelta.CHANGED :
    			dispTxt = "Resource "+res.getFullPath()+" has changed.";
   			break;
  		}
  		return true; // visit the children
 	}
	// 实现Runnable接口中的run方法
 	public void run() {
  		try {
   			label.setText(dispTxt); 
  		} catch (Exception e) {
   			e.printStackTrace();
  		}
	}
}

象上面的第一个Welcome插件,这个新插件同样继承了ViewPart,不同的是实现了三个接口:Runnable,IResourceChangeListener ,IResourceDeltaVisitor。其中的Runnable大家应该很熟悉:多线程的接口。而IResourceChangeListener和IResourceDeltaVisitor是Eclipse系统中的资源接口,这里的资源是指Eclipse中的项目或文件等。在下面运行NoticeView插件的过程中你可以通过添加、打开、删除项目或文件来触发这两个接口中的事件,并在我们的观察窗口中显示相关信息。

在程序中比较奇怪部分的是在resourceChanged()函数里面,并没有象大家想象的那样直接调用label.setText()方法来显示信息,而是调用了disp.syncExec(this),其中的disp是Display类型的对象。这是因为resourceChanged()方法运行的线程和lable所在插件运行的Eclipse主线程并不是同一个线程,如果直接调用label.setText()方法,会抛出一个异常。

下面还需要对项目中的plugin.xml进行一些改动,主要就是加上扩展点声明:


<?xml version="1.0" encoding="UTF-8"?>
<plugin
   id="com.nidapeng.eclipse.plugin.pde"
   name="Pde Plugin"
   version="1.0.0"
   provider-name="NIDAPENG"
   class="com.nidapeng.eclipse.plugin.pde.PdePlugin">
<requires>
   <import plugin="org.eclipse.core.runtime"/>
   <import plugin="org.eclipse.core.resources"/>
   <import plugin="org.eclipse.ui"/>
</requires>
<runtime>
   <library name="pde.jar"/>
</runtime>
<extension
      id="NoticeView"
      name="Notice View"
      point="org.eclipse.ui.views">
   <category
         name="Notice"
         id="com.nidapeng.eclipse.plugin.pde.category1">
   </category>
   <view
         name="Notice Resource View"
         category="com.nidapeng.eclipse.plugin.pde.category1"
         class="com.nidapeng.eclipse.plugin.pde.NoticeView"
         id="com.nidapeng.eclipse.plugin.pde.view1">
  </view>
</extension>
</plugin>

这个xml文件和Welcome插件的plugin.xml非常接近,这里就不做过多的说明了。

要运行这个插件,可以直接用Eclipse中的运行按钮,因为这个项目是一个Plug-in Project,此时项目会自动以Run-time Workbench方式运行。运行后,会生成一个和当前Eclipse完全一致的平台,在这个平台上可以直接运行NoticeView插件,查看这个插件到底会执行什么功能,也可以用直接Run-time Workbench方式调试插件。这里省去了安装插件,重启动Eclipse等过程,可以看到用PDE开发插件的过程比直接用Java开发环境简洁了很多!

Eclipse的开发不仅仅限于插件的开发,它还可以取代Java中的标准Swing,进行基于Java的独立应用程序GUI开发。它带来的好处是显而易见的:高速,资源占用低,跨平台,代码开放,有大公司的支持等等。

由于Eclipse目前还在开发阶段,笔者在用它调试程序时发现有些性能还不是十分的稳定,一些地方会遇到奇怪的问题,要求使用者能想一些办法解决。不过,以现在Eclipse的开发速度,相信过不了多久,它的各种功能会逐步完善。目前Eclipse虽然有种种不足,但瑕不掩玉,笔者对Eclipse的总体印象还是非常不错的,运行速度,资源占用都要好于IVJ,操作起来也大多顺手,而且即使在现阶段也很少有意外退出等重大的Bug发生,希望未来的Eclipse能真正达到IVJ的功能,VisualCafe的速度,成为广大程序员开发软件的一大利器!

相关文章推荐

查看Eclipse插件的几种方法

最笨的方法,到Eclipse的安装目录下的plugins文件夹里面看看。在Eclipse中,Window-》Show View-》Plug-in Registry在Eclipse中,Help-》Abo...
  • jubincn
  • jubincn
  • 2009年12月01日 10:04
  • 5149

Delphi7高级应用开发随书源码

  • 2003年04月30日 00:00
  • 676KB
  • 下载

怎样卸载Eclipse中已经安装的plugin

转自:http://wiki.eclipse.org/FAQ_How_do_I_remove_a_plug-in%3F 新版Eclipse: Help > About Eclipse > ...
  • yasi_xi
  • yasi_xi
  • 2013年10月14日 18:56
  • 6865

eclipse plug-in 的开发-- Rich Client 教程

zhuan zi: http://www.benisoft.com/cn/java/index.htmRich Client 教程 第一部分Rich Client Platform (RCP)是一种全...
  • it_man
  • it_man
  • 2006年10月26日 12:30
  • 9153

Delphi7高级应用开发随书源码

  • 2003年04月30日 00:00
  • 676KB
  • 下载

Eclipse插件开发流程

Eclipse插件开发流程 最近工作比较繁忙,都没有时间写技术博客了,最近工作中用gradle管理项目,每次更改了模块关系或者更新了SVN,都要重新gradle和重新刷新和编译,每次要做这些操作都要切...

Eclipse 开发plug-in 引用其它项目时 导出plug-in的方法

现象描述:plug-in项目如果引用了其它的项目,在调试时是正常的,但是在导出时可能会报错。 引用的库会提示找不到: 处理方法:原因分析问题原因是ToErpLib不是eclipse 的plugin...
  • xundh
  • xundh
  • 2015年09月03日 14:34
  • 1490

Delphi7高级应用开发随书源码

  • 2003年04月30日 00:00
  • 676KB
  • 下载

Hadoop之——HDFS操作实例

本文通过两种方式来讲解hadoop中对HDFS文件系统的操作,第一种方式是命令行,第二种方式是通过java代码来实现。       一、命令行方式:hadoop fs xxx          had...

Hadoop2.6.4版本64位编译

安装过程中遇到的问题 安装依赖包 1 安装jdk17版本 2 安装配置maven 3 安装Ant 4 安装protobuf 5 安装依赖包 6 下载Hadoop源码 编译Hadoop 1 编译Hado...
  • sl1992
  • sl1992
  • 2017年01月11日 17:29
  • 909
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:开发Eclipse插件(Plug-ins)
举报原因:
原因补充:

(最多只允许输入30个字)