ANT build.xml文件詳解(一)
Ant的概念
可能有些讀者並不連接什么是Ant以及入可使用它,但只要使用通過Linux系統得讀者,應該知道
make這個命令。當編譯Linux內核及一些軟件的源程序時,經常要用這個命令。Make命令其實就
是一個項目管理工具,而Ant所實現功能與此類似。像make,gnumake和nmake這些編譯工具都有
一定的缺陷,但是Ant卻克服了這些工具的缺陷。最初Ant開發者在開發跨平台的應用時,用樣也
是基於這些缺陷對Ant做了更好的設計。
Ant 與 makefile
Makefile有一些不足之處,比如很多人都會碰到的煩人的Tab問題。最初的Ant開發者多次強調”
只是我在Tab前面加了一個空格,所以我的命令就不能執行”。有一些工具在一定程度上解決了
這個問題,但還是有很多其他的問題。Ant則與一般基於命令的工具有所不同,它是Java類的擴
展。Ant運行需要的XML格式的文件不是Shell命令文件。它是由一個Project組成的,而一個
Project又可分成可多target,target再細分又分成很多task,每一個task都是通過一個實現特
定接口的java類來完成的。
Ant的優點
Ant是Apache軟件基金會JAKARTA目錄中的一個子項目,它有以下的優點。
跨平台性。Ant是存Java語言編寫的,所示具有很好的跨平台性。
操作簡單。Ant是由一個內置任務和可選任務組成的。Ant運行時需要一個XML文件(構建文件)。
Ant通過調用target樹,就可以執行各種task。每個task實現了特定接口對象。由於Ant構建文件
時XML格式的文件,所以和容易維護和書寫,而且結構很清晰。
Ant可以集成到開發環境中。由於Ant的跨平台性和操作簡單的特點,它很容易集成到一些開發環
境中去。
Ant 開發
Ant的構建文件
當開始一個新的項目時,首先應該編寫Ant構建文件。構建文件定義了構建過程,並被團隊開發
中每個人使用。Ant構建文件默認命名為build.xml,也可以取其他的名字。只不過在運行的時候
把這個命名當作參數傳給Ant。構建文件可以放在任何的位置。一般做法是放在項目頂層目錄中
,這樣可以保持項目的簡潔和清晰。下面是一個典型的項目層次結構。
(1) src存放文件。
(2) class存放編譯后的文件。
(3) lib存放第三方JAR包。
(4) dist存放打包,發布以后的代碼。
Ant構建文件是XML文件。每個構建文件定義一個唯一的項目(Project元素)。每個項目下可以定
義很多目標(target元素),這些目標之間可以有依賴關系。當執行這類目標時,需要執行他們所
依賴的目標。
每個目標中可以定義多個任務,目標中還定義了所要執行的任務序列。Ant在構建目標時必須調
用所定義的任務。任務定義了Ant實際執行的命令。Ant中的任務可以為3類。
(1) 核心任務。核心任務是Ant自帶的任務。
(2) 可選任務。可選任務實來自第三方的任務,因此需要一個附加的JAR文件。
(3) 用戶自定義的任務。用戶自定義的任務實用戶自己開發的任務。
1.<project>標簽
每個構建文件對應一個項目。<project>標簽時構建文件的根標簽。它可以有多個內在屬性,
就如代碼中所示,其各個屬性的含義分別如下。
(1) default表示默認的運行目標,這個屬性是必須的。
(2) basedir表示項目的基准目錄。
(3) name表示項目名。
(4) description表示項目的描述。
每個構建文件都對應於一個項目,但是大型項目經常包含大量的子項目,每一個子項目都可以有
自己的構建文件。
2.<target>標簽
一個項目標簽下可以有一個或多個target標簽。一個target標簽可以依賴其他的target標簽。例
如,有一個target用於編譯程序,另一個target用於聲稱可執行文件。在生成可執行文件之前必
須先編譯該文件,因策可執行文件的target依賴於編譯程序的target。Target的所有屬性如下。
(1).name表示標明,這個屬性是必須的。
(2).depends表示依賴的目標。
(3)if表示僅當屬性設置時才執行。
(4)unless表示當屬性沒有設置時才執行。
(5)description表示項目的描述。
Ant的depends屬性指定了target的執行順序。Ant會依照depends屬性中target出現順序依次執行
每個target。在執行之前,首先需要執行它所依賴的target。程序中的名為run的target的
depends屬性compile,而名為compile的target的depends屬性是prepare,所以這幾個target執
行的順序是prepare->compile->run。
一個target只能被執行一次,即使有多個target依賴於它。如果沒有if或unless屬性,target總
會被執行。
3.<mkdir>標簽
該標簽用於創建一個目錄,它有一個屬性dir用來指定所創建的目錄名,其代碼如下:
<mkdir dir=”${class.root}”/>
通過以上代碼就創建了一個目錄,這個目錄已經被前面的property標簽所指定。
4<jar>標簽
該標簽用來生成一個JAR文件,其屬性如下。
(1) destfile表示JAR文件名。
(2) basedir表示被歸檔的文件名。
(3) includes表示別歸檔的文件模式。
(4) exchudes表示被排除的文件模式。
5.<javac標簽>
該標簽用於編譯一個或一組java文件,其屬性如下。
(1).srcdir表示源程序的目錄。
(2).destdir表示class文件的輸出目錄。
(3).include表示被編譯的文件的模式。
(4).excludes表示被排除的文件的模式。
(5).classpath表示所使用的類路徑。
(6).debug表示包含的調試信息。
(7).optimize表示是否使用優化。
(8).verbose 表示提供詳細的輸出信息。
(9).fileonerror表示當碰到錯誤就自動停止。
6.<java>標簽
該標簽用來執行編譯生成的.class文件,其屬性如下。
(1).classname 表示將執行的類名。
(2).jar表示包含該類的JAR文件名。
(3).classpath所表示用到的類路徑。
(4).fork表示在一個新的虛擬機中運行該類。
(5).failonerror表示當出現錯誤時自動停止。
(6).output 表示輸出文件。
(7).append表示追加或者覆蓋默認文件。
7.<delete>標簽
該標簽用於刪除一個文件或一組文件,去屬性如下。
(1)/file表示要刪除的文件。
(2).dir表示要刪除的目錄。
(3).includeEmptyDirs 表示指定是否要刪除空目錄,默認值是刪除。
(4).failonerror 表示指定當碰到錯誤是否停止,默認值是自動停止。
(5).verbose表示指定是否列出所刪除的文件,默認值為不列出。
8.<copy>標簽
該標簽用於文件或文件集的拷貝,其屬性如下。
(1).file 表示源文件。
(2).tofile 表示目標文件。
(3).todir 表示目標目錄。
(4).overwrite 表示指定是否覆蓋目標文件,默認值是不覆蓋。
(5).includeEmptyDirs 表示制定是否拷貝空目錄,默認值為拷貝。
(6).failonerror 表示指定如目標沒有發現是否自動停止,默認值是停止。
(7).verbose 表示制定是否顯示詳細信息,默認值不顯示。
Ant的數據類型
在構建文件中為了標識文件或文件組,經常需要使用數據類型。數據類型包含在
org.apache.tool.ant.types包中。下面鏡簡單介紹構建文件中一些常用的數據類型。
1. argument 類型
由Ant構建文件調用的程序,可以通過<arg>元素向其傳遞命令行參數,如apply,exec和java任
務均可接受嵌套<arg>元素,可以為各自的過程調用指定參數。以下是<arg>的所有屬性。
(1).values 是一個命令參數。如果參數種有空格,但又想將它作為單獨一個值,則使用此屬性
。
(2).file表示一個參數的文件名。在構建文件中,此文件名相對於當前的工作目錄。
(3).line表示用空格分隔的多個參數列表。
(4).path表示路徑。
2.ervironment 類型
由Ant構建文件調用的外部命令或程序,<env>元素制定了哪些環境變量要傳遞給正在執行的系
統命令,<env>元素可以接受以下屬性。
(1).file表示環境變量值得文件名。此文件名要被轉換位一個絕對路徑。
(2).path表示環境變量的路徑。Ant會將它轉換為一個本地約定。
(3).value 表示環境變量的一個直接變量。
(4).key 表示環境變量名。
注意 file path 或 value只能取一個。
3.filelist類型
Filelist 是一個支持命名的文件列表的數據類型,包含在一個filelist類型中的文件不一定是
存在的文件。以下是其所有的屬性。
(1).dir是用於計算絕對文件名的目錄。
(2).files 是用逗號分隔的文件名列表。
(3).refid 是對某處定義的一個<filelist>的引用。
注意 dir 和 files 都是必要的,除非指定了refid(這種情況下,dir和files都不允許使用)。
4.fileset類型
Fileset 數據類型定義了一組文件,並通常表示為<fileset>元素。不過,許多ant任務構建成了
隱式的fileset,這說明他們支持所有的fileset屬性和嵌套元素。以下為fileset 的屬性列表。
(1).dir表示fileset 的基目錄。
(2).casesensitive的值如果為false,那么匹配文件名時,fileset不是區分大小寫的,其默認
值為true.
(3).defaultexcludes 用來確定是否使用默認的排除模式,默認為true。
(4).excludes 是用逗號分隔的需要派出的文件模式列表。
(5).excludesfile 表示每行包含一個排除模式的文件的文件名。
(6).includes 是用逗號分隔的,需要包含的文件模式列表。
(7).includesfile 表示每行包括一個包含模式的文件名。
5.patternset 類型
Fileset 是對文件的分組,而patternset是對模式的分組,他們是緊密相關的概念。
<patternset>支持4個屬性:includes excludex includexfile 和 excludesfile,與fileset相
同。Patternset 還允許以下嵌套元素:include,exclude,includefile 和 excludesfile.
6.filterset 類型
Filterset定義了一組過濾器,這些過濾器將在文件移動或復制時完成文件的文本替換。
主要屬性如下:
(1).begintoken 表示嵌套過濾器所搜索的記號,這是標識其開始的字符串。
(2).endtoken表示嵌套過濾器所搜索的記號這是標識其結束的字符串。
(3).id是過濾器的唯一標志符。
(4).refid是對構建文件中某處定義一個過濾器的引用。
7.Path類型
Path元素用來表示一個類路徑,不過它還可以用於表示其他的路徑。在用作揖個屬性時,路經中
的各項用分號或冒號隔開。在構建的時候,此分隔符將代替當前平台中所有的路徑分隔符,其擁
有的屬性如下。
(1).location 表示一個文件或目錄。Ant在內部將此擴展為一個絕對路徑。
(2).refid 是對當前構建文件中某處定義的一個path的引用。
(3).path表示一個文件或路徑名列表。
8.mapper類型
Mapper類型定義了一組輸入文件和一組輸出文件間的關系,其屬性如下。
(1).classname 表示實現mapper類的類名。當內置mapper不滿足要求時,用於創建定制mapper.
(2).classpath表示查找一個定制mapper時所用的類型路徑。
(3).classpathref是對某處定義的一個類路徑的引用。
(4).from屬性的含義取決於所用的mapper.
(5).to屬性的含義取決於所用的mapper.
(6).type屬性的取值為identity,flatten glob merge regexp 其中之一,它定義了要是用的
內置mapper的類型。
Ant 的運行
安裝好Ant並且配置好路徑之后,在命令行中切換到構建文件的目錄,輸入Ant命令就可以運行
Ant.若沒有指定任何參數,Ant會在當前目錄下查詢build.xml文件。如果找到了就用該文件作為
構建文件。如果使用了 –find 選項,Ant 就會在上級目錄中找構建文件,直至到達文件系統得
跟目錄。如果構建文件的名字不是build.xml ,則Ant運行的時候就可以使用 –buildfile file
,這里file 指定了要使用的構建文件的名稱,示例如下:
Ant
如下說明了表示當前目錄的構建文件為build.xml 運行 ant 執行默認的目標。
Ant –buildfile test.xml
使用當前目錄下的test.xml 文件運行Ant ,執行默認的目標
ant的build.xml文件詳解(二)
以build_for_ejb_templet.xml為示例,講解Ant中常用的元素和任務。
約定: "…"表示這里有很多代碼,未列出
build_for_ejb_templet.xml任務的分為以下幾大部分
i. 開始
ii. 初始化
iii. 定義classpath
iv. 為編譯作准備
v. 編譯EJB部分
vi. 編譯WEB部分
vii. 編譯J2EE Application
viii. 部署Application
ix. 創建組件的API
x. 確定build的目標
build_for_ejb_templet.xml的講解
開始
<?xml version="1.0" encoding="UTF-8"?> 講解:encoding="UTF-8"表示XML文件采用UTF-8編碼格式,如果要使用GBK編碼,需定義為encodeing="GBK"。 <!-- Build file for 'componentName' Creation date : $Date: yyyy-m-d $ Updated date : $Date: yyyy-m-d $ Author: developerName Copyright 2002 CompanyName, Inc. All rights reserved. -->
講解:此部分為文件內容的簡介,包括文件名稱、創建日期、最后修改日期、創建文件的作者、版權。
componentName 表示 文件名稱
yyyy-m-dd 表示 創建日期、最后修改日期的格式,如2002-5-1
developerName 表示 創建文件的作者
CompanyName 表示 公司名稱或URL
<project name="componentName" default="core" basedir=".">
…
</project>
講解:此部分定義了一個名稱為componentName的項目元素,缺省的任務為"core"任務,根目錄為當前目錄。componentName表示組件的名稱,這里指EJB的名稱。
初始化
<target name="init">
…
</target>
講解:此部分用於初始化所有的變量
<property file="../../build.properties" />
講解:導入項目根目錄下build.properties中的全局變量,開發人員也可以在此文件中重新定義全局變量。
<property name="jboss.lib" value="${jboss.home}/lib" /> <property name="jboss.client" value="${jboss.home}/client" /> <property name="jboss.deploy" value="${jboss.home}/server/${jboss.configuration}/deploy" /> … <property name="jboss.dir" value="${jboss.home}" /> … <property name="deploy.ormi" value=""/> <property name="deploy.username" value=""/> <property name="deploy.password" value=""/>
講解:定義和Jboss Application Server有關的變量,包括lib目錄、client目錄、
deploy目錄和J2EE Application部署要用到的一些變量。
<property name="name" value="componentName"/>
講解:定義組件的名稱
<property name="src.dir" value="${basedir}/src"/>
講解:定義源代碼目錄路徑
<property name="etc.dir" value="${basedir}/etc"/>
講解:定義資源目錄路徑
<property name="lib.dir" value="${basedir}/lib"/>
講解:定義庫目錄路徑
<property name="build.dir" value="${basedir}/build"/>
講解:定義build目錄路徑
<property name="src.main.dir" value="${src.dir}/main"/>
講解:定義源代碼的主目錄路徑
<property name="src.ejb.dir" value="${src.main.dir}/ejb"/>
講解:定義存放EJB的源代碼目錄路徑
<property name="src.javabean.dir" value="${src.main.dir}/javabean"/>
講解:定義存放JavaBean的源代碼目錄路徑
<property name="src.servlet.dir" value="${src.main.dir}/servlet"/>
講解:定義存放Servlet的源代碼目錄路徑
<property name="src.web.dir" value="${src.main.dir}/web"/>
講解:定義存放WEB部分文件(包括JSP程序、HTML文件、圖片、CSS文件、JS腳本等)的目錄路徑
<property name="javadoc.dir" value="${lib.dir}/docs/api"/>
講解:定義存放組件API的開發文件目錄路徑
<property name="ejb-classes.dest" value="${lib.dir}/ejb"/>
講解:定義存放EJB的編譯代碼目錄路徑
<property name="javabean-classes.dest" value="${lib.dir}/javabean"/>
講解:定義存放JavaBean的編譯代碼目錄路徑
<property name="web-classes.dest" value="${lib.dir}/web/WEB-INF/classes" />
講解:定義WEB目錄的類目錄路徑
<property name="web-lib.dest" value="${lib.dir}/web/WEB-INF/lib" />
講解:定義WEB目錄的庫目錄名稱
<property name="pkg-dist.name" value="${name}-pkg"/>
講解:定義壓縮文檔的名稱
<property name="ProjectName.components.home" value="../../components" />
講解:定義項目的組件目錄路徑
<!-- Define componentName Component -->
講解:這段為注釋,說明以下是定義當前組件的變量
<property name="ProjectName.componentName.name" value="componentName"/>
講解:定義當前組件的名稱
<property name="ProjectName.componentName.home" value="${ProjectName.components.home}/componentName"/>
講解:定義當前組件的目錄路徑
<property name="ProjectName.componentName.classbindir" value="${ProjectName.componentName.home}/lib/ejb"/>
講解:定義當前組件的EJB編譯目錄路徑
<property name="ProjectName.componentName.ejbjar" value="${ProjectName.componentName.home}/build/componentName-ejb.jar"/>
講解:定義當前組件內的EJB包的路徑
<property name="ProjectName.componentName.ejbjar.client" value="${ProjectName.componentName.home}/build/componentName-ejb-client.jar"/>
講解:定義當前組件內的EJB客戶端包的路徑
<!-- Define referencesComponentName Component -->
講解:這段為注釋,說明以下是定義引入其它組件的變量
<property name="ProjectName.referencesComponentName.name" value="referencesComponentName"/>
講解:定義指定組件的名稱
<property name="ProjectName.referencesComponentName.home" value="${ProjectName.components.home}/referencesComponentName"/>
講解:定義指定組件的目錄路徑
<property name="ProjectName.referencesComponentName.classbindir" value="${ProjectName.referencesComponentName.home}/lib/ejb"/>
講解:定義指定組件的EJB編譯目錄路徑
<property name="ProjectName.referencesComponentName.ejbjar" value="${ProjectName.referencesComponentName.home}
/build/referencesComponentName-ejb.jar"/>
講解:定義指定組件內的EJB包的路徑
<property name="ProjectName.referencesComponentName.ejbjar.client" value="${ProjectName.referencesComponentName.home} /build/referencesComponentName-ejb-client.jar"/>
講解:定義指定組件內的EJB客戶端包的路徑
<property name="build.classpath" value="${jboss.client}/jboss-j2ee.jar:${jboss.client} /jnp-client.jar:${jboss.client}/jnp-client.jar:${jboss.client} /jbossmq-client.jar:${jboss.client}/jbosssx-client.jar:${jboss.client} /concurrent.jar:${jboss.client}/jaas.jar:${jboss.lib} /jboss-jmx.jar:${jboss.home}/server/${jboss.configuration} /lib/jbosssx.jar:${jboss.home}/server/${jboss.configuration} /lib/mail.jar:${servlet-lib.path}:${ejb-classes.dest}: ${web-classes.dest}:${ProjectName.componentName.classbindir}: ${ProjectName.componentName.ejbjar.client}: ${ProjectName.referencesComponentName.classbindir}: ${ProjectName.referencesComponentName.ejbjar.client}" />
講解:定義classpath,編譯bean時要用到。這是定義classpath的一種方法,下面還有另一種方法。
定義classpath
<!-- ================================================================== --> <!-- Define the classpath for compile the component --> <!-- ================================================================== --> <path id="base.path"> <pathelement location="${jboss.client}/jboss-j2ee.jar" /> <pathelement location="${jboss.client}/jnp-client.jar" /> <pathelement location="${jboss.client}/jbossmq-client.jar" /> <pathelement location="${jboss.client}/jbosssx-client.jar" /> <pathelement location="${jboss.client}/concurrent.jar" /> <pathelement location="${jboss.client}/jaas.jar" /> <pathelement location="${jboss.lib}/jboss-jmx.jar" /> <pathelement location="${jboss.home}/server/${jboss.configuration}/lib/jbosssx.jar" /> <pathelement location="${jboss.home}/server/${jboss.configuration}/lib/mail.jar" /> </path>
講解:此段定義應用服務器中包文件,如支持ejb的jboss-j2ee.jar、支持客戶端程序的jnp-client.jar、jbossmq-client.jar、jbosssx-client.jar、支持JavaMail的mail.jar等。
<path id="project.path"> <path refid="base.path"/> <pathelement location="${ProjectName.componentName.classbindir}"/> <pathelement location="${ProjectName.componentName.ejbjar.client}"/> <pathelement location="${ProjectName.referencesComponentName.classbindir}"/> <pathelement location="${ProjectName.referencesComponentName.ejbjar.client}"/> </path>
講解:此段定義項目中要用到的包文件。
<path id="web.path"> <path refid="project.path"/> <pathelement location="${servlet-lib.path}"/> <pathelement location="${ejb-classes.dest}"/> </path>
講解:此段定義在編譯servlet時的classpath,${ servlet-lib.path }是系統指定的Servlet引擎包。
為編譯作准備工作
<!--=============================================================== --> <!-- Removes all created files and directories --> <!-- ============================================================== --> <target name="clean" depends="init"> <delete dir="${lib.dir}" /> <delete dir="${build.dir}" /> </target>
講解:清除build、lib目錄下的所有文件和目錄。
<!-- ================================================================ --> <!-- Makes sure the needed directory structure is in place --> <!-- ================================================================ --> <target name="prepare" depends="init,clean"> <mkdir dir="${lib.dir}" /> <mkdir dir="${lib.dir}/ejb" /> <mkdir dir="${lib.dir}/ejb/META-INF" /> <mkdir dir="${lib.dir}/web" /> <mkdir dir="${lib.dir}/web/WEB-INF" /> <mkdir dir="${lib.dir}/web/WEB-INF/classes" /> <mkdir dir="${lib.dir}/web/WEB-INF/lib" /> <mkdir dir="${lib.dir}/j2ee" /> <mkdir dir="${lib.dir}/META-INF" /> <mkdir dir="${lib.dir}/docs/api" /> <mkdir dir="${build.dir}" /> </target>
講解:創建build中要用到的所有目錄,根據需要可以加入自定義的目錄如:
<mkdir dir="${lib.dir}/javabean/ " />
編譯EJB部分
<!-- ================================================================ --> <!-- Compilation of the EJB part of the application --> <!-- ================================================================ --> <target name="ejb-classes" depends="prepare"> <javac srcdir="${src.ejb.dir}" destdir="${ejb-classes.dest}" includes="com/**" classpathref="base.path" /> </target>
講解:此小段用來完成編譯ejb和其它help classes。根據需要可以加入一個非常有用的元素:
encoding="${javac.encoding}" <target name="ejb-meta-inf" depends="prepare"> <copy file="${etc.dir}/ejb-jar.xml" tofile="${lib.dir}/ejb/META-INF/ejb-jar.xml" /> <copy file="${etc.dir}/jaws.xml" tofile="${lib.dir}/ejb/META-INF/jaws.xml" /> <copy file="${etc.dir}/jboss.xml" tofile="${lib.dir}/ejb/META-INF/jboss.xml" /> <copy file="${etc.dir}/jbosscmp-jdbc.xml" tofile="${lib.dir}/ejb/META-INF/jbosscmp-jdbc.xml" /> </target>
講解:此小段用來拷貝EJB部署文件,在JAS中EJB部署文件有jaws.xml、jboss.xml、jbosscmp-jdbc.xml。
<target name="ejb-jar" depends="ejb-classes,ejb-meta-inf"> <jar jarfile="${build.dir}/${name}-ejb.jar" basedir="${lib.dir}/ejb" /> </target>
講解:此小段用來把class和部署文件壓縮成包文件,這個包文件就是一個EJB組件。
<target name="ejbclientjar" depends="ejb-jar,web-classes"> <copy file="${ProjectName.referencesComponentName.home}/build/ ${ProjectName.referencesComponentName.name}-ejb-client.jar" tofile="${build.dir}/${ProjectName.referencesComponentName.name} -ejb-client.jar" /> <jar jarfile="${build.dir}/${name}-ejb-client.jar" basedir="${lib.dir}/ejb" excludes="com/ProjectName/componentName/ejb/ComponentNameEJB.class" /> </target>
講解:此小段用來把class和部署文件壓縮成包文件,以支持客戶端運行。
編譯WEB部分
<!-- ================================================================== --> <!-- Compilation of the web part of the application --> <!-- ================================================================== --> <target name="web-classes" depends="prepare,ejb-jar"> <javac srcdir="${src.servlet.dir}" destdir="${lib.dir}/web/WEB-INF/classes" includes="com/**" classpath="${build.classpath}" /> </target>
講解:此小段用來完成編譯servlet。
<target name="web-web-inf" depends="prepare"> <copy file="${etc.dir}/jboss-web.xml" tofile="${lib.dir}/web/WEB-INF/jboss-web.xml" /> <copy file="${etc.dir}/web.xml" tofile="${lib.dir}/web/WEB-INF/web.xml" /> </target>
講解:此小段用來拷貝WEB部署文件,在JAS中WEB部署文件有jboss-web.xml。
<target name="war" depends="web-classes,web-web-inf"> <copy todir="${lib.dir}/web" > <fileset dir="${src.web.dir}"/> </copy> <copy file="${build.dir}/${ProjectName.referencesComponentName.name}-ejb-client.jar" tofile="${lib.dir}/web/WEB-INF/lib/${ProjectName.referencesComponentName.name} -ejb-client.jar" /> <jar jarfile="${build.dir}/${name}-web.war" basedir="${lib.dir}/web" /> </target>
講解:此小段用來把所有的JSP程序、Html、Css、圖片和部署文件等壓縮成WAR文件。
編譯J2EE Application
<!-- ================================================================== --> <!-- Compilation of the complete J2EE application (both web and EJB) --> <!-- ================================================================== --> <target name="j2ee-meta-inf" depends="prepare"> <copy file="${etc.dir}/application.xml" tofile="${lib.dir}/j2ee/META-INF/application.xml" /> </target>
講解:此小段用來拷貝Application的部署文件。
<target name="ear" depends="ejb-jar,war,j2ee-meta-inf"> <copy file="${build.dir}/${name}-ejb.jar" tofile="${lib.dir}/j2ee/${name}-ejb.jar" /> <copy file="${build.dir}/${name}-web.war" tofile="${lib.dir}/j2ee/${name}-web.war" /> <jar jarfile="${build.dir}/${name}.ear" basedir="${lib.dir}/j2ee" /> </target>
講解:此小段用來把EJB組件、支持客戶端運行的包和部署文件壓縮成EAR文件,它就是一個J2EE Application。這里要說明,在進行build時,根據需要可以不生成EAR文件。
部署Application
<!-- ================================================================ --> <!-- Deploy EAR file --> <!-- ================================================================ --> <target name="deploy-server" depends="ear,war"> <copy todir="${jboss.deploy}"> <fileset dir="${build.dir}" includes="*.ear"> </fileset> </copy> </target>
講解:此小段用來部署Application,在JAS3.0中${jboss.deploy}是JAS的熱部署目錄。
創建組件的API
<!-- =================================================================== --> <!-- Create class and package usage pages --> <!-- =================================================================== --> <target name="docs" depends="init"> <javadoc locale="${javadoc.locale}" packagenames="${package.names}.${name}.*" destdir="${javadoc.dir}" classpath="${build.classpath}" encoding="${javadoc.encoding}" author="${javadoc.author}" version="${javadoc.version}" use="${javadoc.usage}" windowtitle="${project.name} ${name} Component API" doctitle="${project.name} ${name} Component" bottom="Copyright ${sign.copyright} ${project.date} ${company.signature}. All Rights Reserved."> <classpath > <pathelement path="${lib.dir}/ejb"/> </classpath> <sourcepath> <pathelement path="${src.main.dir}/ejb"/> </sourcepath> </javadoc> </target>
講解:此小段用來創建組件的API。這里強烈要求類設計人員和編碼人員按照Javadoc定義的標簽對源代碼進行注釋。
確定build的目標
<target name="startbanner"> <echo>+---------------------------------------+</echo> <echo>+ Building ${name} Component +</echo> <echo>+---------------------------------------+</echo> </target> <target name="endbanner" depends="main" > <echo>+---------------------------------------+</echo> <echo>+ Finished ${name} Component +</echo> <echo>+---------------------------------------+</echo> </target> <target name="main" depends="startbanner, ejb-jar, ejbclientjar" /> <target name="main2" depends="startbanner, ejb-jar, ejbclientjar,war" /> <target name="main3" depends="startbanner, ejb-jar, ejbclientjar,war,ear,deploy-server" /> <target name="core" depends="ejb-war" /> <target name="ejb-war" depends="main2,endbanner" /> <target name="deploy" depends="main3,endbanner" /> <target name="all" depends="core, docs" />
講解:此小段用來確定build的目標。缺省目錄為core,所以在build不加參數時,系統將只生成jar文件和war文件。如果 build時加上參數,系統將根據需要來生成文件,例如:在命令行輸入ant deploy,系統將生成jar文件、war文件、ear文件,同時將ear文件進行部署。
ant build.xml 詳解(三)
在Eclipse中使用Ant Ant是Java平台下非常棒的批處理命令執行程序,能非常方便地自動完成編譯,測試,打包,部署等等一系列任務,大大提高開發效率。如果你現在還沒有開始使用Ant,那就要趕快開始學習使用,使自己的開發水平上一個新台階。
Eclipse中已經集成了Ant,我們可以直接在Eclipse中運行Ant。
以前面建立的Hello工程為例,創建以下目錄結構:
新建一個build.xml,放在工程根目錄下。build.xml定義了Ant要執行的批處理命令。雖然Ant也可以使用其它文件名,但是遵循標准能更使開發更規范,同時易於與別人交流。
通常,src存放Java源文件,classes存放編譯后的class文件,lib存放編譯和運行用到的所有jar文件,web存放JSP等web文件,dist存放打包后的jar文件,doc存放API文檔。
然后在根目錄下創建build.xml文件,輸入以下內容:
Xml代碼
<?xml version="1.0"?> <project name="Hello world" default="doc"> <!-- properies --> <property name="src.dir" value="src" /> <property name="report.dir" value="report" /> <property name="classes.dir" value="classes" /> <property name="lib.dir" value="lib" /> <property name="dist.dir" value="dist" /> <property name="doc.dir" value="doc"/> <!-- 定義classpath --> <path id="master-classpath"> <fileset file="${lib.dir}/*.jar" /> <pathelement path="${classes.dir}"/> </path> <!-- 初始化任務 --> <target name="init"> </target> <!-- 編譯 --> <target name="compile" depends="init" description="compile the source files"> <mkdir dir="${classes.dir}"/> <javac srcdir="${src.dir}" destdir="${classes.dir}" target="1.4"> <classpath refid="master-classpath"/> </javac> </target> <!-- 測試 --> <target name="test" depends="compile" description="run junit test"> <mkdir dir="${report.dir}"/> <junit printsummary="on" haltonfailure="false" failureproperty="tests.failed" showoutput="true"> <classpath refid="master-classpath" /> <formatter type="plain"/> <batchtest todir="${report.dir}"> <fileset dir="${classes.dir}"> <include name="**/*Test.*"/> </fileset> </batchtest> </junit> <fail if="tests.failed"> *********************************************************** **** One or more tests failed! Check the output ... **** *********************************************************** </fail> </target> <!-- 打包成jar --> <target name="pack" depends="test" description="make .jar file"> <mkdir dir="${dist.dir}" /> <jar destfile="${dist.dir}/hello.jar" basedir="${classes.dir}"> <exclude name="**/*Test.*" /> <exclude name="**/Test*.*" /> </jar> </target> <!-- 輸出api文檔 --> <target name="doc" depends="pack" description="create api doc"> <mkdir dir="${doc.dir}" /> <javadoc destdir="${doc.dir}" author="true" version="true" use="true" windowtitle="Test API"> <packageset dir="${src.dir}" defaultexcludes="yes"> <include name="example/**" /> </packageset> <doctitle><![CDATA[<h1>Hello, test</h1>]]></doctitle> <bottom><![CDATA[<i>All Rights Reserved.</i>]]></bottom> <tag name="todo" scope="all" description="To do:" /> </javadoc> </target> </project>
以上xml依次定義了init(初始化),compile(編譯),test(測試),doc(生成文檔),pack(打包)任務,可以作為模板。
選中Hello工程,然后選擇“Project”,“Properties”,“Builders”,“New…”,選擇“Ant Build”:
填入Name:Ant_Builder;Buildfile:build.xml;BaseDirectory:${workspace_loc: /Hello}(按“BrowseWorkspace”選擇工程根目錄),由於用到了junit.jar包,搜索Eclipse目錄,找到 junit.jar,把它復制到Hello/lib目錄下,並添加到Ant的Classpath中:
然后在Builder面板中鈎上Ant_Build,去掉Java Builder:
再次編譯,即可在控制台看到Ant的輸出:
Buildfile: F:\eclipse-projects\Hello\build.xml
init:
compile:
[mkdir] Created dir: F:\eclipse-projects\Hello\classes
[javac] Compiling 2 source files to F:\eclipse-projects\Hello\classes
test:
[mkdir] Created dir: F:\eclipse-projects\Hello\report
[junit] Running example.HelloTest
[junit] Tests run: 1, Failures: 0, Errors: 0, Time elapsed: 0.02 sec
pack:
[mkdir] Created dir: F:\eclipse-projects\Hello\dist
[jar] Building jar: F:\eclipse-projects\Hello\dist\hello.jar
doc:
[mkdir] Created dir: F:\eclipse-projects\Hello\doc
[javadoc] Generating Javadoc
[javadoc] Javadoc execution
[javadoc] Loading source files for package example...
[javadoc] Constructing Javadoc information...
[javadoc] Standard Doclet version 1.4.2_04
[javadoc] Building tree for all the packages and classes...
[javadoc] Building index for all the packages and classes...
[javadoc] Building index for all classes...
[javadoc] Generating F:\eclipse-projects\Hello\doc\stylesheet.css...
[javadoc] Note: Custom tags that could override future standardtags: @todo. To avoid potential overrides, use at least one periodcharacter (.) in custom tag names.
[javadoc] Note: Custom tags that were not seen: @todo
BUILD SUCCESSFUL
Total time: 11 seconds
Ant依次執行初始化,編譯,測試,打包,生成API文檔一系列任務,極大地提高了開發效率。將來開發J2EE項目時,還可加入部署等任務。並且,即使脫離了Eclipse環境,只要正確安裝了Ant,配置好環境變量ANT_HOME=<Ant解壓目錄>, Path=…;%ANT_HOME%\bin,在命令行提示符下切換到Hello目錄,簡單地鍵入ant即可。
Ant 的最完整build.xml之標簽:
Ant 開發
Ant的構建文件
當開始一個新的項目時,首先應該編寫Ant構建文件。構建文件定義了構建過程,並被團隊開發中每個人使用。Ant構建文件默認命名為 build.xml,也可以取其他的名字。只不過在運行的時候把這個命名當作參數傳給Ant。構建文件可以放在任何的位置。一般做法是放在項目頂層目錄中,這樣可以保持項目的簡潔和清晰。下面是一個典型的項目層次結構。
(1) src存放文件。
(2) class存放編譯后的文件。
(3) lib存放第三方JAR包。
(4) dist存放打包,發布以后的代碼。
Ant構建文件是XML文件。每個構建文件定義一個唯一的項目(Project元素)。每個項目下可以定義很多目標(target元素),這些目標之間可以有依賴關系。當執行這類目標時,需要執行他們所依賴的目標。每個目標中可以定義多個任務,目標中還定義了所要執行的任務序列。Ant在構建目標時必須調用所定義的任務。任務定義了Ant實際執行的命令。Ant中的任務可以為3類。
(1) 核心任務。核心任務是Ant自帶的任務。
(2) 可選任務。可選任務實來自第三方的任務,因此需要一個附加的JAR文件。
(3) 用戶自定義的任務。用戶自定義的任務實用戶自己開發的任務。
1.<project>標簽
每個構建文件對應一個項目。<project>標簽時構建文件的根標簽。它可以有多個內在屬性,就如代碼中所示,其各個屬性的含義分別如下。
(1) default表示默認的運行目標,這個屬性是必須的。
(2) basedir表示項目的基准目錄。
(3) name表示項目名。
(4) description表示項目的描述。
每個構建文件都對應於一個項目,但是大型項目經常包含大量的子項目,每一個子項目都可以有自己的構建文件。
2.<target>標簽
一個項目標簽驢梢雜幸桓齷蚨喔?/span>target標簽。一個target標簽可以依賴其他的target標簽。例如,有一個target用於編譯程序,另一個target用於聲稱可執行文件。在生成可執行文件之前必須先編譯該文件,因策可執行文件的target依賴於編譯程序的 target。Target的所有屬性如下。
(1).name表示標明,這個屬性是必須的。
(2).depends表示依賴的目標。
(3)if表示僅當屬性設置時才執行。
(4)unless表示當屬性沒有設置時才執行。
(5)description表示項目的描述。
Ant的depends屬性指定了target的執行順序。Ant會依照depends屬性中target出現順序依次執行每個target。在執行之前,首先需要執行它所依賴的target。程序中的名為run的target的depends屬性compile,而名為compile的target的 depends屬性是prepare,所以這幾個target執行的順序是prepare->compile->run。一個target只能被執行一次,即使有多個target依賴於它。如果沒有if或unless屬性,target總會被執行。
3.<mkdir>標簽
該標簽用於創建一個目錄,它有一個屬性dir用來指定所創建的目錄名,其代碼如下:
<mkdir dir=”${class.root}”/>
通過以上代碼就創建了一個目錄,這個目錄已經被前面的property標簽所指定。
4<jar>標簽
該標簽用來生成一個JAR文件,其屬性如下。
(1) destfile表示JAR文件名。
(2) basedir表示被歸檔的文件名。
(3) includes表示別歸檔的文件模式。
(4) exchudes表示被排除的文件模式。
5.<javac標簽>
該標簽用於編譯一個或一組java文件,其屬性如下。
(1).srcdir表示源程序的目錄。
(2).destdir表示class文件的輸出目錄。
(3).include表示被編譯的文件的模式。
(4).excludes表示被排除的文件的模式。
(5).classpath表示所使用的類路徑。
(6).debug表示包含的調試信息。
(7).optimize表示是否使用優化。
(8).verbose 表示提供詳細的輸出信息。
(9).fileonerror表示當碰到錯誤就自動停止。
6.<java>標簽
該標簽用來執行編譯生成的.class文件,其屬性如下。
(1).classname 表示將執行的類名。
(2).jar表示包含該類的JAR文件名。
(3).classpath所表示用到的類路徑。
(4).fork表示在一個新的虛擬機中運行該類。
(5).failonerror表示當出現錯誤時自動停止。
(6).output 表示輸出文件。
(7).append表示追加或者覆蓋默認文件。
7.<delete>標簽
該標簽用於刪除一個文件或一組文件,去屬性如下。
(1)/file表示要刪除的文件。
(2).dir表示要刪除的目錄。
(3).includeEmptyDirs 表示指定是否要刪除空目錄,默認值是刪除。
(4).failonerror 表示指定當碰到錯誤是否停止,默認值是自動停止。
(5).verbose表示指定是否列出所刪除的文件,默認值為不列出。
8.<copy>標簽
該標簽用於文件或文件集的拷貝,其屬性如下。
(1).file 表示源文件。
(2).tofile 表示目標文件。
(3).todir 表示目標目錄。
(4).overwrite 表示指定是否覆蓋目標文件,默認值是不覆蓋。
(5).includeEmptyDirs 表示制定是否拷貝空目錄,默認值為拷貝。
(6).failonerror 表示指定如目標沒有發現是否自動停止,默認值是停止。
(7).verbose 表示制定是否顯示詳細信息,默認值不顯示。
ant教程詳解--javac,java,jar,war,delete,copy,mkdir:
Ant 是一個 Apache 基金會下的跨平台的構件工具,它可以實現項目的自動構建和部署等功能。在本文中,主要讓讀者熟悉怎樣將 Ant 應用到 Java 項目中,讓它簡化構建和部署操作。 <? xml version="1.0" ?> < project name ="helloWorld"> < target name ="sayHelloWorld"> < echo message ="Hello,Amigo"/> </ target > </ project >
<? xml version="1.0" ?> < project name ="projectStudy" default ="sayBaseDir" basedir ="E:" apache-ant-1.7.0" > < target name ="sayBaseDir"> < echo message ="The base dir is: ${basedir}"/> </ target > </ project >
<? xml version="1.0" ?> < project name ="targetStudy"> < target name ="targetA" if ="ant.java.version"> < echo message ="Java Version: ${ant.java.version}"/> </ target > < target name ="targetB" depends ="targetA" unless ="amigo"> < description > a depend example! </ description > < echo message ="The base dir is: ${basedir}"/> </ target > </ project >
<? xml version="1.0" ?> < project name ="propertyStudy" default ="example"> < property name ="name" value ="amigo"/> < property name ="age" value ="25"/> < target name ="example"> < echo message ="name: ${name}, age: ${age}"/> </ target > </ project >
<? xml version="1.0" ?> < project name ="javacTest" default ="compile" basedir ="."> < target name ="clean"> < delete dir ="build"/> </ target > < target name ="compile" depends ="clean"> < mkdir dir ="build/classes"/> < javac srcdir ="src" destdir ="build/classes"/> </ target > </ project >
<? xml version="1.0" ?> < project name ="javaTest" default ="jar" basedir ="."> < target name ="clean"> < delete dir ="build"/> </ target > < target name ="compile" depends ="clean"> < mkdir dir ="build/classes"/> < javac srcdir ="src" destdir ="build/classes"/> </ target > < target name ="run" depends ="compile"> < java classname ="HelloWorld"> < classpath > < pathelement path ="build/classes"/> </ classpath > </ java > </ target > </ project > 運行該 build.xml 文件,可在控制台看到 HelloWorld 的 main 方法的輸出。 <% @ page language="java" contentType="text/html; charset="UTF-8" pageEncoding="UTF-8" %> <! DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd" > < html > < head > < meta http-equiv ="Content-Type" content ="text/html; charset=ISO-8859-1"> < title > ant 打包測試 </ title > </ head > < body > Hello,Ant </ body > </ html >
<? xml version="1.0" ?> < project name ="antwebproject" default ="war" basedir ="."> < property name ="classes" value ="build/classes"/> < property name ="build" value ="build"/> < property name ="lib" value ="WebRoot/WEB-INF/lib"/> <!-- 刪除build 路徑--> < target name ="clean"> < delete dir ="build"/> </ target >
< target name ="compile" depends ="clean"> < mkdir dir ="${classes}"/> < javac srcdir ="src" destdir ="${classes}"/> </ target >
<!-- 打war 包--> < target name ="war" depends ="compile"> < war destfile ="${build}/antwebproject.war" webxml ="WebRoot/WEB-INF/web.xml"> <!-- 拷貝WebRoot 下除了WEB-INF 和META-INF 的兩個文件夾--> < fileset dir ="WebRoot" includes ="**/*.jsp"/> <!-- 拷貝lib 目錄下的jar 包--> < lib dir ="${lib}"/> <!-- 拷貝build/classes 下的class 文件--> < classesdir ="${classes}"/> </ war > </ target > </ project >
各 target 的作用在內容中已經進行說明,在此不再贅述。運行該 build 文件,更新目錄后,可看到在 build 目錄下生成了 antwebproject.war 文件,解開后可看到其目錄結構如下: |