ant – java 構建工具)

我喜歡簡單：ant - java 構建工具

hello ant

    管理你的代碼，doc檔案,編譯,配置等開發工作你是怎末做的：自己管理來源目錄，編譯檔案，copy,實施...
在window寫bat,在unix寫shell？
     可惜我不怎末會寫。所以我製作一個ejb的過程是這樣的：
寫代碼->寫個bat編譯代碼->組織檔案(ejb-jar.xml,jboss.xml...)->壓縮檔產生jar文檔->
實施......(還有同樣的測試過程)(為甚末不用jbuild?)

    這中間每次修改都要經過重複的無數次手工copy,paste...過程，好累，好花時間。可我確實不想去
學指令碼編寫，unix,linux下我還得重學，太累。

    如果你和我一樣希望自動執行預定義的動作卻又不想太累，那末，我覺得ANT工具不錯：
它可以以相同的用法用在不同平台(跨平台)。它是JAVA做的，免費的，開源的，據說網上已經成了事實的JAVA
構建標準，還聽說高手都用它...... ^_^

    我花了2天時間才掌握了它的基本用法，我希望你能通過我的文章和實驗花半天時間就掌握它。

內容：

• 下載，安裝
• hello ant
• hello ant 進級
• 參考及下載

下載，安裝
   又下載?又是一大堆參數變數? 
    http://jakarta.apache.org/ant/index.html 它是apache的java子項目"jakarta"的子項目.你可以選擇
當前的版本，目前我是1.5版,window版，以下就用它講。

    解壓後ant_home用來方便訪問。並確保你也設定了java_home 。
    set ant_home=D:/java/kit/ant/jakarta-ant-1.5.1    這是我的目錄    

    就這些，簡單吧。

hello ant

我們要開發一個java類：其內容只有一句，輸出"hello ant"字串。並使用ant完成編譯和運行工作，這個例子只是為了跑通ant，不附加多餘的東西。

為檔案組織，請建立相應的目錄，並編寫HelloAnt.java

按照人家老外的檔案組織規則咱也照搬。

hello.ant.HelloAnt.java

package hello.ant;</p><p>public class HelloAnt{<br /> public static void main(String[] args){<br /> System.out.println("hello ant,ant 的第一次接觸，好棒！");<br /> }<br />}

在項目根目錄(hello-ant/)寫1個檔案：ant執行設定檔build.xml

build.xml

<?xml version="1.0" encoding="GB2312" ?></p><p><!-- 一個項目,可包含很多工作群組(target) --><br /><project default="main" basedir="."></p><p> <!-- 項目中的一個工作群組,可包含很多任務(task:javac,java...) --><br /> <target name="main"></p><p> <!--編譯--><br /> <javac srcdir="src/main/hello/ant" destdir="build/classes"/></p><p> <!--運行--><br /> <java classname="hello.ant.HelloAnt"><br /> <classpath><br /> <pathelement path="build/classes"/><br /> </classpath><br /> </java></p><p> </target><br /></project>

ok,一切大功告成，哦，不，還沒有運行它。

dos下進入hello-ant的目錄，即build.xml所在的目錄，我們要用ant工具執行它 ， 

執行: %ant_home%/bin/ant -file build.xml     用ant工具執行目前的目錄下的設定檔build.xml 

或  ：ant -file build.xml                    你如果設定%ant_home%/bin到path中

這次ok了，這是答案：

命令提示字元視窗

D:/temp/hello-ant>ant -file build.xml Buildfile: build.xml main: [javac] Compiling 1 source file to D:/temp/hello-ant/build/classes [java] hello ant,ant 的第一次接觸，好棒！ BUILD SUCCESSFUL Total time: 2 seconds D:/temp/hello-ant>

檢查一下build/classes目錄，哦，看到編譯過的檔案就在這裡:
build/classes/hello/ant/HelloAnt.class.

hello ant 進級

(此段比較廢話，可以略過)
你也許會說：這末簡單的工作寫個批處理不就得了，又xml又ant的，把我的時間都浪費完了，我用jbuild或
webShpere不就得了，怎末說你才明白呢？反正網上開源項目大多數都用ant,你總不能給人家個*.jpx吧，
而且這樣的工具太貴，受不了(當然用D的兄弟不怕^_^ )，而且ant可以讓你明確的管理和自動化所有的東西:
編譯-實施-測試...,哎，稍微麻煩一點點，但節約你以前花在零碎的copy,paste上的時間.而且我探索管理
代碼的品質有所提高.

我們要改進build.xml，讓它做更多的事情：

• 定義全域變數
• 初始化,主要是建立目錄
• 編譯  (已有)
• 打包為jar
• 建立API documentation
• 產生distribution產品

凡事都講究平衡，你要ant給你做更多事，當然要累一點點，不過只用累一次，以後的代碼修改後的構建都是"一鍵式"完成,我們製作一個hello的簡單例子，你可以自己做j2ee的練習。

我們要擴充目錄結構，使它更像回事：

ant處理編譯之前的目錄：

ant處理之後的目錄：

圖中：/src,/docs,/lib是自己組織的檔案結構，/build,/dist是ant動態產生的成品。

/src                     源檔案：java源，script源，jsp源，xml配置.....
/src/main         java源
/src/script     window,unix,liunx的執行script，我們的簡單只有一個：
                  run.bat:  java hello.ant.HelloAnt

/docs                手寫說明文檔
/lib                   程式所需類庫的jar,比如j2ee.jar,mail,jar...

/build               用ant動態產生的構建目錄
/build/classes  編譯的類檔案
/build/docs         copy "/docs"的手寫說明文檔，和ant產生的api文檔
/build/lib           放置我們自己的HelloAnt.class打包成品hello-ant.jar

/dist/bin        copy "/src/script" 得執行檔案
/dist/docs      copy "/build/docs" 的文檔
/dist/lib         除了copy "/build/lib"下的hello-ant.jar外，
                              還應copy "/lib"的程式所需jar，這裡我們沒有。

以上是我學老外的檔案組織，大家可以按照自己的愛好組織

我們編寫必要的檔案：

hello.ant. HelloAnt.java

已有

/src/script.bat

@echo off<br />echo ========================================================<br />echo 請先設定 Environment<br />echo .<br />echo JAVA_HOME: %JAVA_HOME%<br />echo ======================================================</p><p>%java_home%/bin/java -classpath ../lib/hello-ant.jar hello.ant.HelloAnt</p><p>pause

/docs/index.html 隨便寫一個手寫的文檔

hello ant 軟體項目手冊docs 訪問api文檔

/build.xml 設定檔

<?xml version="1.0" encoding="GB2312" ?><br /><!--<br /> =======================================================================<br /> hello-ant 項目 ,學習ant工具的第2個build file.</p><p> 參照ant的jakarta-ant-1.6alpha的build.xml</p><p> Copyright (c) 2002 The Neusoft Software Foundation. All rights<br /> reserved.</p><p> =======================================================================<br />--></p><p><!--<br /> 文檔結構為:<br /> <project><br /> <property/> 全域變數的定義<br /> <property/>...</p><p> <target name="1"> 工作群組(tasks)<br /> <javac></javac> 一項javac任務<br /> ...<br /> <oneTask></ontTask> 一項其它任務<br /> </target></p><p> <target name="2"><br /> <javac></javac><br /> ...<br /> <oneTask></ontTask><br /> </target><br /> </project></p><p> project代表一個項目，<br /> default:運行到名稱為"dist"的target(工作群組)<br /> basedir:基準路徑。<br />--><br /><project default="dist" basedir="."></p><p><!--<br /> ===================================================================<br /> 定義屬性（property tasks）<br /> 最好把用到的路徑呀，名稱呀都在這裡定義成全域變數<br /> 例：定義<br /> <property name="a" value="hello"/><br /> 以後就可以這樣用它：<br /> <property name="b" value="${a}/b"/><br /> 現在:b=="hello/b"<br /> ===================================================================<br />--></p><p> <!--主要的系統內容屬性--><br /> <property environment="env"/><!--取window,unix...的環境變數--><br /> <property name="java.home" value="${env.JAVA_HOME}"/><br /> <property name="ant.home" value="${env.ANT_HOME}"/></p><p> <!--主要的app環境屬性--><br /> <property name="app.name" value="hello-ant"/><br /> <property name="app.jar" value="${app.name}.jar"/><br /> <property name="app.copyright" value=" Copyright (c) 2002 The Neusoft Software Foundation. All rights reserved."/></p><p> <!--app中src的屬性--><br /> <property name="src.dir" value="src" /><br /> <property name="src.main" value="${src.dir}/main"/><br /> <property name="src.script" value="${src.dir}/script"/></p><p> <!--app用到的lib--><br /> <property name="lib.dir" value="lib"/></p><p> <!--app的build目錄中--><br /> <property name="build.dir" value="build" /><br /> <property name="build.classes" value="${build.dir}/classes"/><br /> <property name="build.docs" value="${build.dir}/docs"/><br /> <property name="build.docs.api" value="${build.docs}/api"/><br /> <property name="build.lib" value="${build.dir}/lib"/></p><p> <!--app的dist (distribution) 目錄中--><br /> <property name="dist.dir" value="dist"/><br /> <property name="dist.bin" value="${dist.dir}/bin"/><br /> <property name="dist.docs" value="${dist.dir}/docs"/><br /> <property name="dist.lib" value="${dist.dir}/lib"/></p><p> <!--app的docs目錄中--><br /> <property name="docs.dir" value="docs"/></p><p> <!--<br /> 定義一組路徑以後可以通過id重用這組路徑 ，例：<br /> <javac srcdir="src/main" destdir="build/classes"><br /> <classpath refid="classpath"/><br /> </javac><br /> --><br /> <path id="classpath"><br /> <!--本項目只有一個java，用不上classpath，這裡只是做個例子--><br /> <pathelement location="${build.classes}"/><br /> <pathelement path="${java.home}/lib/tools.jar"/><br /> </path></p><p><!--<br /> ===================================================================<br /> init 準備目錄(File Tasks)<br /> 主要的目錄結構通常是不會變的，一起產生他們<br /> ===================================================================<br />--><br /> <target name="init"><br /> <!--清除以前目錄--><br /> <delete dir="${build.dir}" failonerror="false" /><br /> <delete dir="${dist.dir}" failonerror="false"/></p><p> <!--準備目錄--><br /> <mkdir dir="${build.dir}"/><br /> <mkdir dir="${build.classes}"/><br /> <mkdir dir="${build.docs}"/><br /> <mkdir dir="${build.docs.api}"/><br /> <mkdir dir="${build.lib}"/></p><p> <mkdir dir="${dist.dir}"/><br /> <mkdir dir="${dist.bin}"/><br /> <mkdir dir="${dist.lib}"/></p><p> </target></p><p><!--<br /> ===================================================================<br /> Build the code (Compile Tasks,File Tasks)<br /> ===================================================================<br />--><br /> <target name="build" depends="init"><br /> <!--編譯--><br /> <javac srcdir="${src.main}" destdir="${build.classes}"><br /> <classpath refid="classpath"/><br /> </javac><br /> </target></p><p><!--<br /> ===================================================================<br /> 打包文檔(Archive Tasks)<br /> Create the project jars: xxx1.jar and xxx2.jar<br /> ===================================================================<br />--><br /> <target name="jars" depends="build"><br /> <jar basedir="${build.classes}" jarfile="${build.lib}/${app.jar}"/><br /> </target></p><p><!--<br /> ===================================================================<br /> Creates the API documentation<br /> ===================================================================<br />--><br /> <target name="javadocs"<br /> depends="jars"<br /> description="--> creates the API documentation"><br /> <!--copy docs 手冊... --><br /> <copy todir="${build.docs}"><br /> <fileset dir="${docs.dir}"/><br /> </copy></p><p> <javadoc packagenames="hello.ant.*"<br /> sourcepath="${src.main}"<br /> defaultexcludes="yes"<br /> destdir="${build.docs.api}"<br /> author="true"<br /> version="true"<br /> use="true"<br /> windowtitle="Docs API"><br /> <doctitle><![CDATA[<h1>hello ant Docs API</h1>]]></doctitle><br /> <bottom><![CDATA[<i>${app.copyright}</i>]]></bottom><br /> <tag name="todo" scope="all" description="To do:" /><br /> </javadoc><br /> </target></p><p><!--<br /> ===================================================================<br /> Create the distribution that can run (Archive Tasks)<br /> 主要是從各目錄中把該copy的copy上<br /> ===================================================================<br />--><br /> <target name="dist" depends="javadocs"><br /> <!--copy bin 執行檔案 --><br /> <copy todir="${dist.bin}"><br /> <fileset dir="${src.script}/"/><br /> </copy><br /> <copy todir="${dist.docs}"><br /> <fileset dir="${build.docs}/"/><br /> </copy><br /> <!-- copy lib 檔案 --><br /> <copy todir="${dist.lib}"><br /> <fileset dir="${build.lib}/"/><br /> </copy></p><p> </target><br /><!--<br /> ===================================================================<br /> Cleans everything(File Tasks)<br /> 例如可以刪除build中的檔案，留給你發揮吧<br /> ===================================================================<br />--></p><p></project>

build.xml多了些，但其實很簡單：(注釋比較詳細可以參照，這裡再簡單說一下)

一個build.xml包含一個工程的自動化處理的完整xml說明，並且基本由3種東東組成：

<project >

    1.全域變數的定義
    <property/>

    2.工作群組
    <target>
        3.許多單項任務... 像copy,delete,javac,jar...
        <task1/>
        <task2/>
        <task3/>
    </target>

</project>

參考及下載：

本文程式:第1個hello-ant

本文程式:第2個進階的hello-ant

ant最新下載：
http://jakarta.apache.org/ant/index.html 

ant具體的編寫方法參考ant手冊以下2部分就形，
http://jakarta.apache.org/ant/manual/using 使用說明
http://jakarta.apache.org/ant/manual/coretasklist.html 核心tasks
其他一大堆東西你要看也行。不過我覺得比較浪費時間。
http://jakarta.apache.org/ant/manual/index.html  手冊index

huihoo.com翻譯改編的ant/manual/using
http://www.huihoo.com/java/ant.html

用ANT構造Application作者：餘斌斌    
http://developer.ccidnet.com/pub/disp/Article?columnID=295&articleID=27619&pageNO=1

ibm 利用 Ant 和 JUnit 進行漸進式開發——使用單元測試來逐步改進代碼
http://www-900.ibm.com/developerWorks/cn/java/j-ant/index.shtml

關於作者：

陳鵬，東軟西安公司。作為一名狂熱的程式員希望每一天都能成長進步，並希望與大家分享快樂和知識。
請用以下方式和他聯絡：email chen56@msn.com  

2002-12-25