java

位置:IT落伍者 >> java >> 浏览文章

开源技术:在Eclipse中构建备忘单


发布日期:2022年06月29日
 
开源技术:在Eclipse中构建备忘单

Eclipse提供了一种用于显示迷你型指南的内置机制称为备忘单(cheat sheet)备忘单可以快速而有效地指导您如何在Eclipse中执行包含多个步骤的过程它显示在工作台的边角处您可以容易且快速地查看它们

本教程演示了如何为Eclipse构造备忘单构造完毕之后它们还可以运行在BEA Workshop StudioBEA Workshop for WebLogic和其他任何Eclipse系统之上或许能对您现有的工具和插件进行补充示例下载中提供了个准备好的备忘单其中一个备忘单用于说明如何构建您自己的备忘单

简介

Eclipse为备忘单这个小而精致的功能提供了本地支持备忘单可以为标准而又详细的任务提供快速指导为了在Eclipse环境中显示可用的备忘单可以单击Help > Cheat Sheets or Window > Show View > Other > Cheat Sheets > Cheat Sheets > OK

备忘单以视图的形式出现在工作台的右侧便于用户同时阅读和执行备忘单中的指导下面给出了一个示例

备忘单视图

使用备忘单的目的是引导您完成一个过程所以在完成备忘单中的某一个步骤之后可以单击该步骤底部的图标下一个步骤就会自动出现单击 图标可以打开与备忘单中当前步骤有关的帮助页面

您可以使用其他人提供的备忘单也可以创建自己的备忘单是一种理想的方式可以让团队中的每个人了解如何进行标准但不是很频繁的操作比如访问内部(inhouse)API或连接到遗留应用程序您在便条上记下的一系列步骤也可以作为备忘单的候选内容备忘单保存在JAR文件中您可以很容易地与其他人共享它们

正如您期望的那样Eclipse还提供了一些简单的工具用于将备忘单组装成插件并将得到的JAR文件放入当前安装中简言之在一个插件项目中可以创建许多备忘单(每个备忘单都在它们自己的XML文件中)然后以JAR文件的形式导出它们最后将它们放入本地eclipse/plugins文件夹中

您可以在支持插件开发功能的任意Eclipse实例中创建备忘单比如BEA Workshop for WebLogic

编写自己的备忘单

本教程将引导您遍历在Eclipse中从头到尾创建一个备忘单的整个过程总的说来必须执行以下步骤

建立一个用于创建备忘单文件的项目

创建一个包含备忘单文本的XML文件

定义备忘单属性

将备忘单导出为JAR文件

将JAR文件复制到Eclipse文件夹中

访问备忘单

以上步骤均十分简单请打开您的Eclipse让我们开始吧

步骤 建立一个用于创建备忘单文件的项目

一开始选择File > New > Project并从New Project wizard展开PlugIn Development然后选择Plugin Project如图所示使用BEA Workshop for WebLogic 必须单击Show All Wizards选项来查看这些项目类型

创建一个插件项目

在下一个对话框上指定项目名称确保没有选中Create a Java project选项如图所示在创建涉及Java动作的更加复杂的备忘单时必须选中这个选项而对于只做启动向导这类简单工作的备忘单则不需要创建Java项目

新的插件项目

在下一个对话框上使用您或您公司的名称填写provider字段(参见图单击Finish便可创建项目

插件内容

向导还会提示您转到Plugin Development您应该单击Yes

至此您已经创建了一个空的备忘单项目现在可以开始给它填充内容了

步骤 创建一个备忘单XML文件

您创建的每个备忘单都必须有自己的XML文件这些文件包含备忘单的文本内容备忘备结构十分简单一个<intro>块后面跟着多个<item>块每个<item>块分别对应着备忘单中的每一个步骤格式选项被限制为<b></b>和<br />

以下示例提供了一个由两个步骤组成的备忘单

<?xml version= encoding=UTF?><cheatsheet title=Demo Cheat Sheet> <intro > <description> This cheat sheet is a demo </description> </intro> <item title=Hello world! > <description> This is the <b>first</b> step in this cheat sheet <br /> </description> </item> <item title=Hello world again! > <description> This is the <b>second</b> step in this cheat sheet <br /> </description> </item></cheatsheet>

在您的Eclipse插件项目中创建一个XML文件然后将备忘单的文本内容复制到其中该XML文件可以位于任何位置但最简单的做法是将它放在项目的根文件夹中

步骤 定义备忘单属性

完成备忘单XML文件的创建之后必须给项目添加Eclipse备忘单扩展因为它不是必需的插件因此默认情况下没有安装它接着必须给备忘单创建一个分组并将您的备忘单插入该组中访问备忘单时可以看到分组/分类名称当您单击展开它时可以看到所有的备忘单(在本教程中仅有一个备忘单)

在PlugIn Development透视图中主视图提供了一组用于设置插件属性和选项的选项卡

步骤 给项目添加备忘单扩展

用于支持备忘单的Eclipse功能(扩展)在默认情况下没有被选中在可以创建备忘单之前必须指定备忘单与该扩展有关要给项目添加备忘单扩展请单击视图底部的Extensions选项卡然后单击Add

接着在New Extension对话框中确保Show only extension points from the required plugins选项是禁用的单击orgeclipseuicheatsheetscheatSheetContent然后单击Finish(参见图

创建一个新扩展

您将会被请求确认是否想把这个扩展点添加为插件依赖项单击Yes进行确认

步骤 给备忘单添加类别

创建的所有备忘单都将统一分组成一个类别(顶级分组)要创建该类别请在Extensions选项卡上右击Cheat Sheet扩展然后选择New> category如下所示

新建类别

一个新的类别会出现而且您可以自定义这些设置一定要指定类别的name值因为这个名称将会出现在描述该类别的Eclipse中

扩展元素细节

要特别注意id因为您需要在备忘单的定义中指定ID字符串

步骤 将备忘单添加到类别中(每个备忘单一次)

要添加备忘单请右击Extensions选项卡上的Cheat Sheet扩展然后选择New > Cheat Sheet

新建备忘单

一定要指定备忘单的名称类别的类别ID以及包含备忘单内容的XML文件的名称

对于每个希望添加到类别中的备忘单只需重复这个步骤即可

至此您已经创建了备忘单的内容并完成了使备忘单在Eclipse中可见的虚拟过程

步骤 导出备忘单JAR文件

要使用备忘单必须将它导出为JAR文件并将此JAR文件复制到Eclipse插件目录下以便下一次启动Eclipse时能够找到它们

在导出备忘单之前通过单击Build选项卡并确保在Binary Build部分中选中了所有的XML文件确保构建过程中包含所有的备忘单XML文件确保选中了除project和buildproperties之外的所有属性因为这两个属性与Eclipse插件项目结构相关而不是与备忘单的内容相关

另外选择 File > Save All 来确保所有文件和设置得到保存

要创建备忘单JAR文件请在Overview选项卡上单击Export Wizard链接您需要做的只是指定应该用来存放JAR文件的位置并选中Package plugins as individual JAR archives选项单击Finish便可导出该文件如图所示

导出JAR文件

步骤 将JAR文件复制到Eclipse插件文件夹中

对于Eclipse用户需要将JAR文件复制到ECLIPSE_HOME/plugins文件夹中

对于 BEA Workshop for WebLogic 用户需要将JAR文件放入WORKSHOP_HOME/workshop/workshopWP/eclipse/plugins文件夹中

对于 Workshop Studio用户需要将JAR文件放入STUDIO_HOME/Workshop/eclipse/plugins文件夹中

现在重新启动Eclipse以便找到这些备忘单JAR文件

步骤 : 访问备忘单

单击Help > Cheat Sheets来显示Cheat Sheets 视图

如果Help > Cheat Sheets命令不可用单击Window > Show View > Other然后选择Cheat Sheets > Cheat Sheets单击OK现在通过单击位于Cheat Sheet顶部的下拉式菜单并选择Launch Other就可以打开您的备忘单您的备忘单类别将显示在组的列表中而且您可以展开这个类别并选择您的备忘单

结束语

本教程提供了创建一个备忘单的基本步骤事实上也没有更多可以说的内容备忘单提供的格式选项不多因为它们的目标就是引导您完成一系列步骤我们没有讨论到的内容是如何让备忘单启动一个向导(例如创建一个新的项目)或者Eclipse中的一些其他动作如果大家有足够的兴趣我们以后还会发布有关这个主题的更多内容

上一篇:Spring工作原理探秘

下一篇:Hibernate中po对象的三种状态分析