zoukankan      html  css  js  c++  java
  • eclipse 插件编写(一)

    由于项目开发进程中有一些重复性的代码进行编写,没有任何业务逻辑,粘贴复制又很麻烦且容易出错,故想起做一个eclipse插件来满足一下自己的工作需要,同时记录一下,以供以后参考与共同学习。本文主要讲解一步一步开发eclipse插件的过程,没有对每一步进行详细的讲解,如需查看详细介绍请自行百度、Google。

    参考网站:

    http://www.ibm.com/developerworks/cn/java/os-ecplug/

    开发环境:window7、jdk1.6、eclipse4.4

    1、新建eclipse插件 File > New > Project

    QQ截图20160216092153

    选择 Plug-in Project ,新建一个eclipse插件工程,填入工程名称 TestPlugin,使用默认路径、默认项目设置,选择插件运行在eclipse的版本。

    image

    点击下一步进入插件项目的详细设置页面,

    image

    ID: 插件的ID

    Version: 插件版本号

    Name: 插件名称

    Vendor: 插件的作者信息

    Execution Environment: 插件的执行环境

    option中的 Generate an activator, a Java class that controls the plug-in's life cycle ,下面紧跟着有一个 Activator的输入框,这儿选中后代表生成一个启动器,这个java类用来控制插件的声明周期,这个启动器类似java的main方法,Activator后面输入框内的内容代表要生成启动器的java类名称

    进入下一步后有一些模板可以选择,为了方便选择Hello,World实例项目。

    image

    image

    点击完成,项目新建成功。目录如下:

    image

    src : 项目源代码目录

    icons:项目图片资源目录

    META-INF/MANIFEST.MF: 项目基本配置信息,版本、名称、启动器等

    build.properties: 项目的编译配置信息,包括,源代码路径、输出路径、

    plugin.xml:插件的操作配置信息,包含弹出菜单及点击菜单后对应的操作执行类等,

    2、代码分析

    MANIFEST.MF:

    包含了版本、名称、启动器类、必须加载的插件、运行环境等

    Manifest-Version: 1.0
    
    Bundle-ManifestVersion: 2
    
    Bundle-Name: TestPlugin
    
    Bundle-SymbolicName: TestPlugin;singleton:=true
    
    Bundle-Version: 1.0.0.qualifier
    
    Bundle-Activator: testplugin.Activator
    
    Require-Bundle: org.eclipse.ui,
    
     org.eclipse.core.runtime
    
    Bundle-RequiredExecutionEnvironment: JavaSE-1.6
    
    Bundle-ActivationPolicy: lazy
    
    
    
    对应的在通过Plug-in Manifest Editor中打开如下:
    image
     
    build.properties
    文件包含了源文件路径、编译输出路径及编译包含的目录等
    source.. = src/
    
    output.. = bin/
    
    bin.includes = plugin.xml,
    
                   META-INF/,
    
                   .,
    
                   icons/

    对应的在通过Plug-in Manifest Editor中打开如下:

    image

    plugin.xml

    相对来讲 plugin.xml 是内容最多也最容易更改的地方,包含了插件的操作集合,内容如下:

    <?xml version="1.0" encoding="UTF-8"?>
    
    <?eclipse version="3.4"?>
    
    <plugin>
    
    
    
       <extension
    
             point="org.eclipse.ui.actionSets">
    
          <actionSet
    
                label="Sample Action Set"
    
                visible="true"
    
                id="TestPlugin.actionSet">
    
             <menu
    
                   label="Sample &amp;Menu"
    
                   id="sampleMenu">
    
                <separator
    
                      name="sampleGroup">
    
                </separator>
    
             </menu>
    
             <action
    
                   label="&amp;Sample Action"
    
                   icon="icons/sample.gif"
    
                   class="testplugin.actions.SampleAction"
    
                   tooltip="Hello, Eclipse world"
    
                   menubarPath="sampleMenu/sampleGroup"
    
                   toolbarPath="sampleGroup"
    
                   id="testplugin.actions.SampleAction">
    
             </action>
    
          </actionSet>
    
       </extension>
    
    
    
    </plugin>

    extension: 代表一个扩展点, point=org.eclipse.ui.actionSets 代表改扩展点用来添加菜单、工具栏按钮

    actionSet : 一组工具集

    menu: 菜单

    action: 菜单项,这里的action中有一个属性class=”testplugin.actions.SampleAction”代表在点击该菜单项时将触发此action类的run方法。

     
    SimpleAction:

    SimpleAction 为自动生成的一个类,里面包含了一个简单的实现hello world的程序代码,如下:

    package testplugin.actions;
    
    
    import org.eclipse.jface.action.IAction;
    import org.eclipse.jface.viewers.ISelection;
    import org.eclipse.ui.IWorkbenchWindow;
    import org.eclipse.ui.IWorkbenchWindowActionDelegate;
    import org.eclipse.jface.dialogs.MessageDialog;
    
    
    /**
     * Our sample action implements workbench action delegate.
     * The action proxy will be created by the workbench and
     * shown in the UI. When the user tries to use the action,
     * this delegate will be created and execution will be 
     * delegated to it.
     * @see IWorkbenchWindowActionDelegate
     */
    public class SampleAction implements IWorkbenchWindowActionDelegate {
    	private IWorkbenchWindow window;
    	/**
    	 * The constructor.
    	 */
    	public SampleAction() {
    	}
    
    
    	/**
    	 * The action has been activated. The argument of the
    	 * method represents the 'real' action sitting
    	 * in the workbench UI.
    	 * @see IWorkbenchWindowActionDelegate#run
    	 */
    	public void run(IAction action) {
    		MessageDialog.openInformation(
    			window.getShell(),
    			"TestPlugin",
    			"Hello, Eclipse world");
    	}
    
    
    	/**
    	 * Selection in the workbench has been changed. We 
    	 * can change the state of the 'real' action here
    	 * if we want, but this can only happen after 
    	 * the delegate has been created.
    	 * @see IWorkbenchWindowActionDelegate#selectionChanged
    	 */
    	public void selectionChanged(IAction action, ISelection selection) {
    	}
    
    
    	/**
    	 * We can use this method to dispose of any system
    	 * resources we previously allocated.
    	 * @see IWorkbenchWindowActionDelegate#dispose
    	 */
    	public void dispose() {
    	}
    
    
    	/**
    	 * We will cache window object in order to
    	 * be able to provide parent shell for the message dialog.
    	 * @see IWorkbenchWindowActionDelegate#init
    	 */
    	public void init(IWorkbenchWindow window) {
    		this.window = window;
    	}
    }
    在点击工具栏的按钮时会自动调用此类的run方法,该方法弹出一个提示框,提示Hello, Eclipse world;
     
    Activator:

    此类为插件的启动类,控制插件的生命周期,内容如下:

    package testplugin;
    
    
    
    import org.eclipse.jface.resource.ImageDescriptor;
    
    import org.eclipse.ui.plugin.AbstractUIPlugin;
    
    import org.osgi.framework.BundleContext;
    
    
    
    /**
    
     * The activator class controls the plug-in life cycle
    
     */
    
    public class Activator extends AbstractUIPlugin {
    
    	// The plug-in ID
    
    	public static final String PLUGIN_ID = "TestPlugin"; //$NON-NLS-1$
    
    
    
    	// The shared instance
    
    	private static Activator plugin;
    
    	/**
    
    	 * The constructor
    
    	 */
    
    	public Activator() {
    
    	}
    
    
    
    	/*
    
    	 * (non-Javadoc)
    
    	 * @see org.eclipse.ui.plugin.AbstractUIPlugin#start(org.osgi.framework.BundleContext)
    
    	 */
    
    	public void start(BundleContext context) throws Exception {
    
    		super.start(context);
    
    		plugin = this;
    
    	}
    
    
    
    	/*
    
    	 * (non-Javadoc)
    
    	 * @see org.eclipse.ui.plugin.AbstractUIPlugin#stop(org.osgi.framework.BundleContext)
    
    	 */
    
    	public void stop(BundleContext context) throws Exception {
    
    		plugin = null;
    
    		super.stop(context);
    
    	}
    
    
    
    	/**
    
    	 * Returns the shared instance
    
    	 *
    
    	 * @return the shared instance
    
    	 */
    
    	public static Activator getDefault() {
    
    		return plugin;
    
    	}
    
    
    
    	/**
    
    	 * Returns an image descriptor for the image file at the given
    
    	 * plug-in relative path
    
    	 *
    
    	 * @param path the path
    
    	 * @return the image descriptor
    
    	 */
    
    	public static ImageDescriptor getImageDescriptor(String path) {
    
    		return imageDescriptorFromPlugin(PLUGIN_ID, path);
    
    	}
    
    }
    
     

    3、运行一下,看看效果

    首先在项目名称上点击右键 > Run as > Eclipse Application 会新打开一个eclipse窗口,在里面可以看到刚刚新建的插件,如图:

    image

    把鼠标移入插件图标的上面会出现提示文字,点击查看效果:

    image

    最简单的插件就这样了,后面会在里面添加一些其他的功能,以完成一个代码生成器的基本功能,由于刚接触eclipse插件,文中如有不正确的地方敬请指正。

  • 相关阅读:
    javaTemplates-学习笔记三
    索引
    WTForms
    session权限限制
    vue-cli脚手架项目中组件的使用
    vue补充
    表单输入绑定
    vue指令系统介绍
    vue-cli脚手架安装和webpack-simple模板项目生成
    rest-framework之视图
  • 原文地址:https://www.cnblogs.com/haifeng1990/p/5192804.html
Copyright © 2011-2022 走看看