Ant 的最完整build.xml.doc

Ant的概念Make命令是一個項目管理工具，而Ant所實現(xiàn)功能與此類似。像make，gnumake和nmake這些編譯工具都有一定的缺陷，但是Ant卻克服了這些工具的缺陷。最初Ant開發(fā)者在開發(fā)跨平臺的應用時，用樣也是基于這些缺陷對Ant做了更好的設計。Ant 與 makefileMakefile有一些不足之處，比如很多人都會碰到的煩人的Tab問題。最初的Ant開發(fā)者多次強調(diào)”只是我在Tab前面加了一個空格，所以我的命令就不能執(zhí)行”。有一些工具在一定程度上解決了這個問題，但還是有很多其他的問題。Ant則與一般基于命令的工具有所不同，它是Java類的擴展。Ant運行需要的XML格式的文件不是Shell命令文件。它是由一個Project組成的，而一個Project又可分成可多target，target再細分又分成很多task，每一個task都是通過一個實現(xiàn)特定接口的java類來完成的。Ant的優(yōu)點Ant是Apache軟件基金會JAKARTA目錄中的一個子項目，它有以下的優(yōu)點?？缙脚_性。Ant是存Java語言編寫的，所示具有很好的跨平臺性。操作簡單。Ant是由一個內(nèi)置任務和可選任務組成的。Ant運行時需要一個XML文件(構建文件)。Ant通過調(diào)用target樹，就可以執(zhí)行各種task。每個task實現(xiàn)了特定接口對象。由于Ant構建文件時XML格式的文件，所以和容易維護和書寫，而且結構很清晰。Ant可以集成到開發(fā)環(huán)境中。由于Ant的跨平臺性和操作簡單的特點，它很容易集成到一些開發(fā)環(huán)境中去。Ant 開發(fā)Ant的構建文件當開始一個新的項目時，首先應該編寫Ant構建文件。構建文件定義了構建過程，并被團隊開發(fā)中每個人使用。Ant構建文件默認命名為build.xml，也可以取其他的名字。只不過在運行的時候把這個命名當作參數(shù)傳給Ant。構建文件可以放在任何的位置。一般做法是放在項目頂層目錄中，這樣可以保持項目的簡潔和清晰。下面是一個典型的項目層次結構。(1) src存放文件。(2) class存放編譯后的文件。(3) lib存放第三方JAR包。(4) dist存放打包，發(fā)布以后的代碼。Ant構建文件是XML文件。每個構建文件定義一個唯一的項目(Project元素)。每個項目下可以定義很多目標(target元素)，這些目標之間可以有依賴關系。當執(zhí)行這類目標時，需要執(zhí)行他們所依賴的目標。每個目標中可以定義多個任務，目標中還定義了所要執(zhí)行的任務序列。Ant在構建目標時必須調(diào)用所定義的任務。任務定義了Ant實際執(zhí)行的命令。Ant中的任務可以為3類。（1） 核心任務。核心任務是Ant自帶的任務。（2） 可選任務?？蛇x任務實來自第三方的任務，因此需要一個附加的JAR文件。（3） 用戶自定義的任務。用戶自定義的任務實用戶自己開發(fā)的任務。1.標簽每個構建文件對應一個項目。標簽時構建文件的根標簽。它可以有多個內(nèi)在屬性，就如代碼中所示，其各個屬性的含義分別如下。(1) default表示默認的運行目標，這個屬性是必須的。(2) basedir表示項目的基準目錄。(3) name表示項目名。(4) description表示項目的描述。每個構建文件都對應于一個項目，但是大型項目經(jīng)常包含大量的子項目，每一個子項目都可以有自己的構建文件。2.標簽 一個項目標簽驢梢雜幸桓齷蚨喔?/spantarget標簽。一個target標簽可以依賴其他的target標簽。例如，有一個target用于編譯程序，另一個target用于聲稱可執(zhí)行文件。在生成可執(zhí)行文件之前必須先編譯該文件，因策可執(zhí)行文件的target依賴于編譯程序的target。Target的所有屬性如下。(1).name表示標明，這個屬性是必須的。(2).depends表示依賴的目標。(3)if表示僅當屬性設置時才執(zhí)行。(4)unless表示當屬性沒有設置時才執(zhí)行。(5)description表示項目的描述。Ant的depends屬性指定了target的執(zhí)行順序。Ant會依照depends屬性中target出現(xiàn)順序依次執(zhí)行每個target。在執(zhí)行之前，首先需要執(zhí)行它所依賴的target。程序中的名為run的target的depends屬性compile，而名為compile的target的depends屬性是prepare，所以這幾個target執(zhí)行的順序是prepare-compile-run。一個target只能被執(zhí)行一次，即使有多個target依賴于它。如果沒有if或unless屬性，target總會被執(zhí)行。3.標簽該標簽用于創(chuàng)建一個目錄，它有一個屬性dir用來指定所創(chuàng)建的目錄名，其代碼如下：通過以上代碼就創(chuàng)建了一個目錄，這個目錄已經(jīng)被前面的property標簽所指定。4標簽該標簽用來生成一個JAR文件，其屬性如下。(1) destfile表示JAR文件名。(2) basedir表示被歸檔的文件名。(3) includes表示別歸檔的文件模式。(4) exchudes表示被排除的文件模式。5該標簽用于編譯一個或一組java文件，其屬性如下。(1).srcdir表示源程序的目錄。(2).destdir表示class文件的輸出目錄。(3).include表示被編譯的文件的模式。(4).excludes表示被排除的文件的模式。(5).classpath表示所使用的類路徑。(6).debug表示包含的調(diào)試信息。(7).optimize表示是否使用優(yōu)化。(8).verbose 表示提供詳細的輸出信息。(9).fileonerror表示當碰到錯誤就自動停止。6標簽該標簽用來執(zhí)行編譯生成的.class文件，其屬性如下。(1).classname 表示將執(zhí)行的類名。(2).jar表示包含該類的JAR文件名。(3).classpath所表示用到的類路徑。(4).fork表示在一個新的虛擬機中運行該類。(5).failonerror表示當出現(xiàn)錯誤時自動停止。(6).output 表示輸出文件。(7).append表示追加或者覆蓋默認文件。7.標簽該標簽用于刪除一個文件或一組文件，去屬性如下。(1)/file表示要刪除的文件。(2).dir表示要刪除的目錄。(3).includeEmptyDirs 表示指定是否要刪除空目錄，默認值是刪除。(4).failonerror 表示指定當碰到錯誤是否停止，默認值是自動停止。(5).verbose表示指定是否列出所刪除的文件，默認值為不列出。8.標簽該標簽用于文件或文件集的拷貝，其屬性如下。(1).file 表示源文件。(2).tofile 表示目標文件。(3).todir 表示目標目錄。(4).overwrite 表示指定是否覆蓋目標文件，默認值是不覆蓋。(5).includeEmptyDirs 表示制定是否拷貝空目錄，默認值為拷貝。(6).failonerror 表示指定如目標沒有發(fā)現(xiàn)是否自動停止，默認值是停止。(7).verbose 表示制定是否顯示詳細信息，默認值不顯示。Ant的數(shù)據(jù)類型在構建文件中為了標識文件或文件組，經(jīng)常需要使用數(shù)據(jù)類型。數(shù)據(jù)類型包含在org.apache.tool.ant.types包中。下面簡單介紹構建文件中常用的數(shù)據(jù)類型。1. argument 類型由Ant構建文件調(diào)用的程序，可以通過元素向其傳遞命令行參數(shù)，如apply,exec和java任務均可接受嵌套元素，可以為各自的過程調(diào)用指定參數(shù)。以下是的所有屬性。(1).values 是一個命令參數(shù)。如果參數(shù)種有空格，但又想將它作為單獨一個值，則使用此屬性。(2).file表示一個參數(shù)的文件名。在構建文件中，此文件名相對于當前的工作目錄。(3).line表示用空格分隔的多個參數(shù)列表。(4).path表示路徑。2.ervironment 類型由Ant構建文件調(diào)用的外部命令或程序，元素制定了哪些環(huán)境變量要傳遞給正在執(zhí)行的系統(tǒng)命令，元素可以接受以下屬性。(1).file表示環(huán)境變量值得文件名。此文件名要被轉換位一個絕對路徑。(2).path表示環(huán)境變量的路徑。Ant會將它轉換為一個本地約定。(3).value 表示環(huán)境變量的一個直接變量。(4).key 表示環(huán)境變量名。注意 file path 或 value只能取一個。3.filelist類型Filelist 是一個支持命名的文件列表的數(shù)據(jù)類型，包含在一個filelist類型中的文件不一定是存在的文件。以下是其所有的屬性。(1).dir是用于計算絕對文件名的目錄。(2).files 是用逗號分隔的文件名列表。(3).refid 是對某處定義的一個的引用。注意 dir 和 files 都是必要的，除非指定了refid(這種情況下，dir和files都不允許使用)。4.fileset類型Fileset 數(shù)據(jù)類型定義了一組文件，并通常表示為元素。不過，許多ant任務構建成了隱式的fileset,這說明他們支持所有的fileset屬性和嵌套元素。以下為fileset 的屬性列表。(1).dir表示fileset 的基目錄。(2).casesensitive的值如果為false，那么匹配文件名時，fileset不是區(qū)分大小寫的，其默認值為true.(3).defaultexcludes 用來確定是否使用默認的排除模式，默認為true。(4).excludes 是用逗號分隔的需要派出的文件模式列表。(5).excludesfile 表示每行包含一個排除模式的文件的文件名。(6).includes 是用逗號分隔的，需要包含的文件模式列表。(7).includesfile 表示每行包括一個包含模式的文件名。5.patternset 類型 Fileset 是對文件的分組，而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元素用來表示一個類路徑，不過它還可以用于表示其他的路徑。在用作揖個屬性時，路經(jīng)中的各項用分號或冒號隔開。在構建的時候，此分隔符將代替當前平臺中所有的路徑分隔符，其擁有的屬性如下。(1).location 表示一個文件或目錄。Ant在內(nèi)部將此擴展為一個絕對路徑。(2).refid 是對當前構建文件中某處定義的一個path的引用。(3).path表示一個文件或路徑名列表。8.mapper類型Mapper類型定義了一組輸入文件和一組輸出文件間的關系，其屬性如下。(1).classname 表示實現(xiàn)mapper類的類名。當內(nèi)置mapper不滿足要求時，用于創(chuàng)建定制mapper.(2).classpath表示查找一個定制mapper時所用的類型路徑。(3).classpathref是對某處定義的一個類路徑的引用。(4).from屬性的含義取決于所用的mapper.(5).to屬性的含義取決于所用的mapper.(6).type屬性的取值為identity，flatten glob merge regexp其中之一，它定義了要是用的內(nèi)置mapper的類型。Ant 的運行安裝好Ant并且配置好路徑之后，在命令行中切換到構建文件的目錄，輸入Ant命令就可以運行Ant.若沒有指定任何參數(shù)，Ant會在當前目錄下查詢build.xml文件。如果找到了就用該文件作為構建文件。如果使用了 find 選項，Ant 就會在上級目錄中找構建文件，直至到達文件系統(tǒng)得跟目錄。如果構建文件的名字不是build.xml ，則Ant運行的時候就可以使用 buildfile file ,這里file 指定了要使用的構建文件的名稱，示例如下：Ant如下說明了表示當前目錄的構建文件為build.xml 運行 ant 執(zhí)行默認的目標。Ant buildfile test.xml使用當前目錄下的test.xml 文件運行Ant ,執(zhí)行默認的目標.!-文檔結構為: 全局變量的定義. 任務組(tasks) 一項javac任務. 一項其它任務.project代表一個項目，default:運行到名稱為dist的target(任務組)basedir:基準路徑。-!-=定義屬性（property tasks）最好把用到的路徑呀，名稱呀都在這里定義成全局變量例：定義以后就可以這樣用它：現(xiàn)在:b=hello/b=-!-定義一組路徑以后可以通過id重用這組路徑 ，例：- creates the AP