&

Eclipse WTP Projects Facets實(shí)戰(zhàn)指南(1)

2010-01-14 23:04:49 作者: 來源:

這個(gè)文章基本是"Building Project Facets"的中文版

在WTP中創(chuàng)建Dynamic Web Project工程的時(shí)候提供了Project Facets的功能,它讓用戶在創(chuàng)建web項(xiàng)目的時(shí)候,可以像搭積木一下給我們創(chuàng)建的project添加各種功能模塊,下面我們通過一個(gè)例子來講解一下WTP中的Project Facets的用法

通常我們給創(chuàng)建的工程可能添加以下元素:資源文件, Builder, Nature標(biāo)識(shí)等, 我們知道Eclipse本身提供了一個(gè)Nature的功能,但是Facets跟Nature是有區(qū)別的, 給工程添加Nature是用來給Eclipse底層的工具使用的,而Facets是用來給最終用戶使用的, 通常Facets提供的模塊都是自描述的,這樣可以保證用戶在使用的時(shí)候,避免添加不必要的Facet模塊, 而且對(duì)于我們開發(fā)者而言也避免了在新建向?qū)е胁迦胄碌膚izard page以及避免通過右鍵菜單來給工程添加或者去掉某模塊,從而大大簡化了開發(fā)人員的工作量, 因此Facets對(duì)用戶和開發(fā)者來說都是一個(gè)不錯(cuò)的選擇

下面我們結(jié)合一個(gè)名為FormGen的實(shí)例來介紹, FormGen用來在我們創(chuàng)建的web工程中,加入一些我們自己的jar包以及修改web.xml文件

廢話少說,先在插件工程中添加org.eclipse.wst.common.project.facet.core.facets 擴(kuò)展點(diǎn), 當(dāng)然這里需要在依賴中加入org.eclipse.wst.common.project.facet.core引用,該擴(kuò)展點(diǎn)包羅萬象,這里我們遵循循序漸進(jìn)的原則,從最最簡單的內(nèi)容開始:

xml 代碼

<extension point="org.eclipse.wst.common.project.facet.core.facets">
<project-facet id="{string}"> (0 or more)
<label>{string}label>
<description>{string}description> (optional)
project-facet>
<project-facet-version facet="{string}" version="{string}"/> (0 or more)
extension>

這里加入了兩個(gè)節(jié)點(diǎn):project-facet是我們要加入的facet, project-facet-version用來制定我們的facet版本, 每一個(gè)facet至少需要給它指定一個(gè)版本,否則不可用, 后面大家就會(huì)知道,實(shí)際上我們大部分工作都集中在project-facet-version中配置, 配置后的代碼如下:

xml 代碼

<extension point="org.eclipse.wst.common.project.facet.core.facets">
<project-facet id="formgen.core">
<label>FormGen Corelabel>
<description>
Enables generation of HTML forms based on XML definition files.
description>
project-facet>
<project-facet-version facet="formgen.core" version="1.0"/>
<project-facet id="formgen.ext">
<label>FormGen Extensionslabel>
<description>
Enables additional FormGen widgets.
description>
project-facet>
<project-facet-version facet="formgen.ext" version="1.0"/>
extension>

設(shè)置好后運(yùn)行我們的插件項(xiàng)目,創(chuàng)建一個(gè)Dynamic Web Project, 在向?qū)е械谝粋€(gè)頁面的Target Runtime設(shè)置為none,繼續(xù)進(jìn)入到下一個(gè)頁面,這時(shí)在下面的列表中就會(huì)出現(xiàn)我們添加的兩個(gè)facet

接下來的工作就是給facet指定約束
由于我們的FormGen是基于Servlet的,因此它應(yīng)該適用于所有的Java EE項(xiàng)目.下面我們通過增加約束讓FormGen facet也能在EJB項(xiàng)目向?qū)е惺褂?
下面是我們將要用到的擴(kuò)展節(jié)點(diǎn)的相關(guān)說明:

xml 代碼

<extension point="org.eclipse.wst.common.project.facet.core.facets">
<project-facet-version>
<constraint> (optional)
[expr]
constraint>
project-facet-version>
extension>
[expr] =
<requires facet="{string}" version="{version.expr}" soft="{boolean}"/> or
<conflicts facet="{string}" version="{version.expr}"/> or
<conflicts group="{string}"/> or
<and>
[expr] (1 or more)
and> or
<or>
[expr] (1 or more)
or>

約束由樹狀結(jié)構(gòu)的表達(dá)式組成, 它包括4個(gè)部分,這里我們分別來加以說明:

requires:是用的最多的部分,它表示當(dāng)前的facet還需要依賴的其他facet, 如果對(duì)所依賴的facet沒有版本要求,那么不用設(shè)置version屬性, version可以設(shè)置為表達(dá)式, soft屬性用來創(chuàng)建一種特定類型的依賴,即如果依賴facet不存在,那么當(dāng)前facet將不會(huì)在選項(xiàng)列表中出現(xiàn),其本facet必須在引用facet之后被安裝

conflicts:沖突約束用來制定如果在同一個(gè)工程中已經(jīng)存在了這里指定的facet,那么當(dāng)前聲明的facet將不可用,它用兩種形式:可以指定單個(gè)沖突或組(group)沖突的facet.對(duì)于組沖突,這里需要解釋一下, 組沖突用來指定當(dāng)前的facet與沒有在facet列表中列出的某一類facet有沖突,比如說, WTP自己的moudule facet都屬于moudules組, 而這些facet在定義的時(shí)候,都將組沖突設(shè)置為modules, 這樣就可以保證兩個(gè)module不會(huì)同時(shí)安裝在同一個(gè)工程中

要讓一個(gè)facet屬于某個(gè)組,需要這樣定義擴(kuò)展點(diǎn):

<extension point="org.eclipse.wst.common.project.facet.core.facets">
<project-facet-version>
<group-member id="{string}"/> (0 or more)
project-facet-version>
extension>

and & or 是用來做邏輯判斷的,寫程序的都知道,這里不做介紹

下面是我們的FormGen的facet定義,為了讓我們創(chuàng)建的項(xiàng)目是一個(gè)Java EE項(xiàng)目,這里我們?cè)O(shè)置FormGen Core依賴jst.web facet. FormGen Ext facet需要建立在 FormGen Core的基礎(chǔ)上

xml 代碼

<extension point="org.eclipse.wst.common.project.facet.core.facets">
<project-facet-version id="formgen.core" version="1.0">
<constraint>
<requires facet="jst.web" version="2.2,2.3,2.4"/>
constraint>
project-facet>
<project-facet-version id="formgen.ext" version="1.0">
<constraint>
<requires facet="formgen.core" version="1.0"/>
constraint>
project-facet>
extension>

實(shí)現(xiàn)Action
經(jīng)過了上面的設(shè)置之后,運(yùn)行插件,在新建工程向?qū)Ю锩孢x擇FormGen Core會(huì)出現(xiàn)錯(cuò)誤提示信息,這是因?yàn)槲覀冞€沒有實(shí)現(xiàn)對(duì)應(yīng)的Action,這里所說的Action是指facet所要執(zhí)行的操作,這里有三種類型的action:INSTALL, UNINSTALL, and VERSION_CHANGE,下面的工作就是實(shí)現(xiàn)FormGen Core的action

下面是action對(duì)應(yīng)的擴(kuò)展點(diǎn)設(shè)置格式:

xml 代碼

<extension point="org.eclipse.wst.common.project.facet.core.facets">
<action id="{string}" facet="{string}" version="{version.expr}" type="INSTALL|UNINSTALL|VERSION_CHANGE">
<delegate class="{class:org.eclipse.wst.common.project.facet.core.IDelegate}"/>
<property name="{string}" value="{string}"/> (0 or more)
action>
extension>

下面我們對(duì)上述設(shè)置進(jìn)行一下說明:
version屬性可以是單個(gè)值也可以是表達(dá)式,如果action使用所有的facet,那么不設(shè)置

id屬性可選,如果不制定,系統(tǒng)將以"[facet-id]#[version-expression]#[action-type](#[prop-name]=[prop-value])*"格式創(chuàng)建一個(gè), 為了可讀性,最好自己制定id

在action內(nèi)部還可以在project-facet-version元素內(nèi)部中使用,如果是這樣的話,那么facet和version屬性將被忽略,如果同一個(gè)action delegate實(shí)現(xiàn)被多個(gè)facet 版本使用,那么最好在外面單獨(dú)設(shè)置一個(gè)action節(jié)點(diǎn),這樣系統(tǒng)會(huì)進(jìn)行優(yōu)化

對(duì)于VERSION_CHANGE類型的Action而言, 那么制定了version信息之后,其行為將會(huì)收到一些限制, 我們只需要在action下的property中制定from.versions屬性即可,其值可以是單個(gè),也可以是表達(dá)式

我們的FormGen Core的action要做兩件事:(1)copy formgen-core.jar 到項(xiàng)目的WEB-INF/lib 目錄下;(2)將FormGen servlet添加到web.xml中.而FormGen Ext會(huì)將copy formgen-ext.jar 到WEB-INF/lib 目錄下

xml 代碼

<extension point="org.eclipse.wst.common.project.facet.core.facets">
<project-facet-version facet="formgen.core" version="1.0">
<action type="INSTALL">
<delegate class="com.formgen.eclipse.FormGenCoreFacetInstallDelegate"/>
action>
project-facet-version>
<project-facet-version facet="formgen.ext" version="1.0">
<action type="INSTALL">
<delegate class="com.formgen.eclipse.FormGenExtFacetInstallDelegate"/>
action>
project-facet-version>
extension>

java 代碼

package com.formgen.eclipse;
import org.eclipse.core.resources.IFolder;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.Path;
import org.eclipse.wst.common.project.facet.core.IDelegate;
import org.eclipse.wst.common.project.facet.core.IProjectFacetVersion;
public final class FormGenCoreFacetInstallDelegate implements IDelegate
{
public void execute( final IProject pj,
final IProjectFacetVersion fv,
final Object config,
final IProgressMonitor monitor )
throws CoreException
{
monitor.beginTask( "", 2 );
try
{
final IFolder webInfLib = Utils.getWebInfLibDir( pj );
Utils.copyFromPlugin( new Path( "libs/formgen-core.jar" ),
webInfLib.getFile( "formgen-core.jar" ) );
monitor.worked( 1 );
Utils.registerFormGenServlet( pj );
monitor.worked( 1 );
}
finally
{
monitor.done();
}
}
}

java 代碼

package com.formgen.eclipse;
import org.eclipse.core.resources.IFolder;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.Path;
import org.eclipse.wst.common.project.facet.core.IDelegate;
import org.eclipse.wst.common.project.facet.core.IProjectFacetVersion;
public final class FormGenExtFacetInstallDelegate implements IDelegate
{
public void execute( final IProject pj,
final IProjectFacetVersion fv,
final Object config,
final IProgressMonitor monitor )
throws CoreException
{
monitor.beginTask( "", 1 );
try
{
final IFolder webInfLib = Utils.getWebInfLibDir( pj );
Utils.copyFromPlugin( new Path( "libs/formgen-ext.jar" ),
webInfLib.getFile( "formgen-ext.jar" ) );
monitor.worked( 1 );
}
finally
{
monitor.done();
}
}
}

xml 代碼

<extension point="org.eclipse.wst.common.project.facet.core.facets">
<category id="{string}">
<label>{string}label>
<description>{string}description> (optional)
category>
<project-facet>
<category>{string}category> (optional)
project-facet>
extension>

設(shè)置如下:

xml 代碼

<extension point="org.eclipse.wst.common.project.facet.core.facets">
<category id="formgen.category">
<label>FormGenlabel>
<description>Enables generation of HTML forms based on XML definition files.description>
category>
<project-facet id="formgen.core">
<category>formgen.categorycategory>
project-facet>
<project-facet id="formgen.ext">
<category>formgen.categorycategory>
project-facet>
extension>

效果如圖

安徽新華電腦學(xué)校專業(yè)職業(yè)規(guī)劃師為你提供更多幫助【在線咨詢】

上一篇：也說關(guān)于WizardPage的動(dòng)態(tài)生成 下一篇：Eclipse WTP Projects Facets實(shí)戰(zhàn)指南(1)

相關(guān)熱詞搜索：實(shí)戰(zhàn) 指南