本文将通过一个收藏夹插件来演示一个插件从创建,到运行,以及测试和卸载这个插件的全过程,相信通过这篇文章,你能对eclipse插件的整个开发流程有一个初步的认识。
文章目录
1 创建一个插件项目
首先,打开eclipse,选择一个空的工作区(此处选择的是默认的工作区)。
可以通过点击关闭按钮或者点击Hide关闭欢迎界面(如果存在欢迎界面则关闭,不存在则可以无视这一步)。
点击File -> New -> Other打开新建项目编辑页面。
在搜索栏输入Plug-in Project,点击下方的Plug-in Project,然后点击Next。
1.1 定义项目名称等基本信息
在Project name字段输入项目名称,此处定义的项目名称为com.qualityeclipse.favorites,按图中完成各项配置后点击Next。
1.2 配置项目环境及其他参数
按下图完成相关参数的配置
其中,Version字段去掉quality的原因是避免后期导出jar包时出现问题;
Execution environment选择JavaSE-11的原因是目前eclipse支持的jdk版本为11版本,过低版本可能导致代码测试运行存在问题,过高的版本则可能导致代码不能正常编译。
完成参数的配置后点击Next。
1.3 选择插件模型
勾选Create a plug-in using a template,选择View contribution using 3.x API,点击Next。
1.4 定义视图
此页是定义视图相关信息的界面,按照下图中的配置进行调整即可,配置完点击Finish。
选择Open Perspective。
创建完成。
2 调整收藏夹视图(选做)
注意:本节只是将FavoriteView.java下的代码进行替换,方便后续章节的讲解和学习,若无后续学习的需求可以跳过此节,并不影响本篇文章后续步骤的进行。
使用以下代码替换FavoriteView.java下的代码。
package com.qualityeclipse.favorites.views;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.ui.part.*;
import org.eclipse.jface.viewers.*;
import org.eclipse.swt.graphics.Image;
import org.eclipse.jface.action.*;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.ui.*;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.swt.SWT;
public class FavoritesView extends ViewPart {
private TableViewer viewer;
class ViewContentProvider implements IStructuredContentProvider {
public void inputChanged(Viewer v, Object oldInput, Object newInput) {}
public void dispose() {}
public Object[] getElements(Object parent) {
return new String[] { "One", "Two", "Three"};
}
}
class ViewLabelProvider extends LabelProvider implements ITableLabelProvider {
public String getColumnText(Object obj, int index) {
return getText(obj);
}
public Image getColumnImage(Object obj, int index) {
return getImage(obj);
}
public Image getImage(Object obj) {
return PlatformUI.getWorkbench()
.getSharedImages()
.getImage(ISharedImages.IMG_OBJ_ELEMENT);
}
}
public FavoritesView() {}
public void createPartControl(Composite parent) {
viewer = new TableViewer(parent, SWT.MULTI | SWT.H_SCROLL | SWT.V_SCROLL);
viewer.setContentProvider(new ViewContentProvider());
viewer.setLabelProvider(new ViewLabelProvider());
viewer.setInput(getViewSite());
}
public void setFocus() {
viewer.getControl().setFocus();
}
}
3 构建项目
此节将讲述如何将项目进行构建,以生成可以被安装运行的文件夹或压缩包。
3.1 手动构建
点击File -> Export,打开项目导出界面。
选择Plug-in Development文件夹下方的Deployable plug-ins and fragments,点击Next。
勾选需要构建的项目,选择Directory会打包成一个文件夹,本文在此处选择的是Archive file,将项目打保成一个压缩包,路径则选择放置在桌面。
选择Options选项卡,勾选Export source并且在下拉选项中选择Include source in exported plug-ins,再勾选Save as Ant script,此项设置的内容为是否导出Ant脚本,Ant脚本可以用于自动构建操作,此处选择的Ant脚本导出路径为桌面(如果你知道项目文件夹在哪里的话可以直接将路径指到项目文件夹下),勾选完成后点击Finish。
等待导出进度100%后,即可在刚刚设置的路径下找到对应导出文件。
3.2 自动构建
想要自动构建的话首先需要在手动构建过程中生成的ANT脚本(xml格式文件),找到该脚本后将其复制。
在IDE中右键项目com.qualityeclipse.favorites,点击Paste(粘贴)。
右键项目文件夹下刚刚粘贴过来的ANT脚本,选择Run As,选择External Tools Configurations,打开配置界面。
点击右侧的>>按钮,点击JRE,进到JRE设置界面。
勾选Run in the same JRE as the workspace,点击Apply,然后点击Close。
右键项目文件夹下刚刚粘贴过来的ANT脚本,选择Run As,选择Ant Build
等待右下进度执行完成。
结果是按照之前手动构建的配置,在指定位置重新生成了一个部署压缩包,你可以将这个压缩包删除,然后再执行一次自动构建来验证是否生成了新的压缩包。
4 安装并运行产品
4.1 安装产品
将第3节构建的项目压缩包在当前目录下解压,获得一个名为plugins的文件夹(若在3.1节中未选择构建成压缩包,则会直接产生该文件夹)。
在解压出的文件夹中找到com.qualityeclipse.favorites_1.0.0.jar这个jar包(其中下划线前的是你的项目名,下划线后是你项目的版本号),右键该jar包选择复制。
找到eclipse编译器的安装路径,找到该路径下的plugins文件夹。
将刚刚复制的jar包粘贴到plugins文件夹下。
4.2 运行产品
注意:一定要关闭你所有启动的eclipse编译器再执行此步骤
重新打开你的eclipse编译器,点击Window -> Show View -> Other进入视图设置界面。
找到QualityEclipse文件夹,展开该文件夹,在其下拉内容中找到Favorites,选中后点击Open即可打开之前部署的插件。
注意:此处的文件夹名称和视图名称为在1.4节定义的名称。
正常出现Favorites视图即为部署和运行成功。
5 卸载插件
先关闭所有在运行的Eclipse编译器。
在4.1节提到的Eclipse安装目录下的文件夹中找到想要卸载的插件,此处卸载的是刚刚安装的收藏夹插件,右键点击该jar包选择删除。
重新启动Eclipse编译器,退出前若未关闭Favorites视图,则之前视图存在的位置将产生如下报错。
点击Window -> Show View -> Other进入视图设置界面。
在show View配置下输入Favorites进行查找,发现查找不到之前安装的插件即为卸载成功。
6 小结
本文讲解了Eclipse简单插件示例的创建、安装、运行和卸载,相信通过这篇文章,你可以对Eclipse插件有一个初步的认识,对Eclipse插件开发有一个初步的了解。