Eclipse快速上手指南之使用ANT
2004-07-30 17:35
作者：
出处Q?
J2ME开发网
Ant是Javaq_下非常棒的批处理命o执行E序Q能非常方便地自动完成编译，试Q打包，部v{等一pddQ大大提高开发效率。如果你现在q没有开始用AntQ那p赶快开始学习用，使自q开发水q上一个新台阶?br>
Eclipse中已l集成了AntQ我们可以直接在Eclipse中运行Ant?br>
以前面徏立的Hello工程ZQ创Z下目录结构：
 |
新徏一个build.xmlQ放在工E根目录下。build.xml定义了Ant要执行的批处理命令。虽然Ant也可以用其它文件名Q但是遵循标准能更开发更规范Q同时易于与别h交流?br>
通常Qsrc存放Java源文Ӟclasses存放~译后的class文gQlib存放~译和运行用到的所有jar文gQweb存放JSP{web文gQdist存放打包后的jar文gQdoc存放API文档?br>
然后在根目录下创建build.xml文gQ输入以下内容：
| Q?xml version="1.0"?Q?br>Qproject name="Hello world" default="doc"Q?/font> Q?-- properies --Q?br>Qproperty name="src.dir" value="src" /Q?br>Qproperty name="report.dir" value="report" /Q?br>Qproperty name="classes.dir" value="classes" /Q?br>Qproperty name="lib.dir" value="lib" /Q?br>Qproperty name="dist.dir" value="dist" /Q?br>Qproperty name="doc.dir" value="doc"/Q?/font> Q?-- 定义classpath --Q?br>Qpath id="master-classpath"Q?br>Qfileset file="${lib.dir}/*.jar" /Q?br>Qpathelement path="${classes.dir}"/Q?br>Q?pathQ?/font> Q?-- 初始化Q?--Q?br>Qtarget name="init"Q?br>Q?targetQ?/font> Q?-- ~译 --Q?br>Qtarget name="compile" depends="init" description="compile the source files"Q?br>Qmkdir dir="${classes.dir}"/Q?br>Qjavac srcdir="${src.dir}" destdir="${classes.dir}" target="1.4"Q?br>Qclasspath refid="master-classpath"/Q?br>Q?javacQ?br>Q?targetQ?/font> Q?-- 试 --Q?br>Qtarget name="test" depends="compile" description="run junit test"Q?br>Qmkdir dir="${report.dir}"/Q?br>Qjunit printsummary="on" haltonfailure="false" failureproperty="tests.failed" showoutput="true"Q?br>Qclasspath refid="master-classpath" /Q?br>Qformatter type="plain"/Q?br>Qbatchtest todir="${report.dir}"Q?br>Qfileset dir="${classes.dir}"Q?br>Qinclude name="**/*Test.*"/Q?br>Q?filesetQ?br>Q?batchtestQ?br>Q?junitQ?br>Qfail if="tests.failed"Q?br>*********************************************************** **** One or more tests failed! Check the output ... **** *********************************************************** Q?failQ?br>Q?targetQ?/font> Q?-- 打包成jar --Q?br>Qtarget name="pack" depends="test" description="make .jar file"Q?br>Qmkdir dir="${dist.dir}" /Q?br>Qjar destfile="${dist.dir}/hello.jar" basedir="${classes.dir}"Q?br>Qexclude name="**/*Test.*" /Q?br>Qexclude name="**/Test*.*" /Q?br>Q?jarQ?br>Q?targetQ?/font> Q?-- 输出api文档 --Q?br>Qtarget name="doc" depends="pack" description="create api doc"Q?br>Qmkdir dir="${doc.dir}" /Q?br>Qjavadoc destdir="${doc.dir}" author="true" version="true" use="true" windowtitle="Test API"Q?br>Qpackageset dir="${src.dir}" defaultexcludes="yes"Q?br>Qinclude name="example/**" /Q?br>Q?packagesetQ?br>QdoctitleQ＜![CDATA[Qh1QHello, testQ?h1Q]]Q＜/doctitleQ?br>QbottomQ＜![CDATA[QiQAll Rights Reserved.Q?iQ]]Q＜/bottomQ?br>Qtag name="todo" scope="all" description="To do:" /Q?br>Q?javadocQ?br>Q?targetQ?br>Q?projectQ?/font> |
以上xml依次定义了initQ初始化Q，compileQ编译）QtestQ测试）QdocQ生成文档）QpackQ打包）dQ可以作为模ѝ?br>
选中Hello工程Q然后选择“Project”Q?#8220;Properties”Q?#8220;Builders”Q?#8220;New…”Q选择“Ant Build”Q?br>
 |
填入NameQAnt_BuilderQBuildfileQbuild.xmlQBase DirectoryQ?{workspace_loc:/Hello}Q按“Browse Workspace”选择工程根目录）Q由于用Cjunit.jar包，搜烦Eclipse目录Q找到junit.jarQ把它复制到 Hello/lib目录下，q添加到Ant的Classpath中：
 |
然后在Builder面板中钩上Ant_BuildQ去掉Java BuilderQ?br>
 |
再次~译Q即可在控制台看到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 standard tags: @todo. To avoid potential overrides, use at least one period character (.) in custom tag names. [javadoc] Note: Custom tags that were not seen: @todo BUILD SUCCESSFUL Total time: 11 seconds |
Ant依次执行初始化，~译Q测试，打包Q生成API文档一pddQ极大地提高了开发效率。将来开发J2EE目Ӟq可加入部v{Q务。ƈ且，即 q了Eclipse环境Q只要正安装了AntQ配|好环境变量ANT_HOME=QAnt解压目录Q，Path=…;%ANT_HOME%\binQ? 在命令行提示W下切换到Hello目录Q简单地键入ant卛_?img src ="http://www.aygfsteel.com/kuxiaoku/aggbug/123389.html" width = "1" height = "1" />
]]>
版权声明Q可以Q意{载，转蝲时请务必以超链接形式标明文章原始出处和作者信息及本声?/a>?br> http://www.chedong.com/tech/ant.html
内容摘要Q?br> ant是一个基于JAVA的自动化脚本引擎Q脚本格式ؓXML。除了做JAVA~译相关d外，ANTq可以通过插g实现很多应用的调用?br>
- ANT的基本概念：
- ANT的安装：解包Q设|\?/li>
- ANT的用：最好的学习只不q是一个简单实用的例子h……
ANT的基本概念：Java的Makefile
当一个代码项目大了以后，每次重新~译Q打包，试{都会变得非常复杂而且重复Q因此c语言中有make脚本来帮助这些工作的扚w完成。在Java 中应用是q_无关性的Q当然不会用q_相关的make脚本来完成这些批处理d了，ANT本n是q样一个流E脚本引擎，用于自动化调用程序完成项目的~? 译，打包Q测试等。除了基于JAVA是^台无关的外，脚本的格式是ZXML的，比make脚本来说q要好维护一些?br>
每个ant脚本Q缺省叫build.xmlQ中讄了一pdd(target)Q比如对于一个一般的目可能需要有以下d?/p>
- d1Qusage 打印本脚本的帮助信息Q缺省）
- d2Qclean <-- init 清空初始化环?
- d3Qjavadoc <-- build <-- init 生成JAVADOC
- d4Qjar <-- build <-- init 生成JAR
- d5Qall <-- jar + javadoc <-- build <-- init 完成以上所有Q务：jar javadoc
注：我看到很多项目的ant脚本中的命名基本上都是一致的Q比如：~译一般叫build或者compileQ打包一般叫jar或warQ生成文档一般命? 为javadoc或javadocsQ执行全部Q务all。在每个d的中QANT会根据配|调用一些外部应用ƈ配以相应参数执行。虽然ANT可调用的? 部应用种c非怸富，但其实最常用的就2Q?个：比如javac javadoc jar{?
ANT的安?/h2>
解包后在pȝ可执行\径中加入指向ant的bin的\径就可以了，比如可以在GNU/Linux上把以下配置加入/etc/profile中：
export ANT_HOME=/home/ant
export JAVA_HOME=/usr/java/j2sdk1.4.1
export PATH=$PATH:$JAVA_HOME/bin:$ANT_HOME/bin
q样执行ant
后，如果不指定配|文件ant会缺省找build.xmlq个配置文gQƈҎ配置文g执行dQ缺省的d讄可以指向最常用的Q务，比如Q?
buildQ或指向打印帮助信息QusageQ告诉用h那些脚本选项可以使用?br>
ANT的?br>
最好的学习q程是看懂那些open
source目中的build.xml脚本Q然后根据自q需要简化成一个更单的QANT和APACHE上很多非常工E派的项目：单易用，而且适应
性非常强Q因些项目的建立往往来源于开发h员日常最直接的需求?br>
以下是的一?a >WebLucene?
用的例子Q修改自JDOM的build.xmlQ?br>
<project default="usage" basedir=".">
<!--
===================================================================
-->
<!-- Initialization
target
-->
<!--
===================================================================
-->
<target name="init">
<tstamp/>
<property file="${basedir}/build.properties" />
<property name="Name" value="ProjectFullName"/>
<property name="name" value="project_name"/>
<property name="version" value="0.2"/>
<property name="year" value="2003"/>
<echo message="----------- ${Name} ${version}
[${year}] ------------"/>
<property name="debug" value="off"/>
<property name="optimize" value="on"/>
<property name="deprecation" value="on"/>
<property name="src.dir"
value="./src/WEB-INF/src"/>
<property name="lib.dir"
value="./src/WEB-INF/lib"/>
<property name="packages"
value="com.chedong.*,org.apache.lucene.*"/>
<property name="build.src"
value="./src/WEB-INF/build"/>
<property name="build.dest"
value="./src/WEB-INF/classes"/>
<property name="build.javadocs"
value="./src/doc"/>
<path id="classpath">
<pathelement
path="${jsdk_jar}"/>
<fileset
dir="${lib.dir}">
<include name="**/*.jar"/>
</fileset>
</path>
<filter token="year" value="${year}"/>
<filter token="version" value="${version}"/>
<filter token="date" value="${TODAY}"/>
<filter token="log" value="true"/>
<filter token="verbose" value="true"/>
</target>
<!--
===================================================================
-->
<!-- Help on
usage
-->
<!--
===================================================================
-->
<target name="usage" depends="init">
<echo message="${Name} Build file"/>
<echo
message="-------------------------------------------------------------"/>
<echo message=""/>
<echo message=" available targets are:"/>
<echo message=""/>
<echo message="
jar --> generates the ${name}.jar
file"/>
<echo message="
build --> compiles the source code"/>
<echo message=" javadoc -->
generates the API documentation"/>
<echo message="
clean --> cleans up the directory"/>
<echo message=""/>
<echo message=" Please rename
build.properties.default to build.properties"/>
<echo message=" and edit build.properties to
specify JSDK 2.3 classpath."/>
<echo message=""/>
<echo message=" See the comments inside the
build.xml file for more details."/>
<echo
message="-------------------------------------------------------------"/>
<echo message=""/>
<echo message=""/>
</target>
<!--
===================================================================
-->
<!-- Prepares the source
code
-->
<!--
===================================================================
-->
<target name="prepare-src" depends="init">
<!-- create directories -->
<mkdir dir="${build.src}"/>
<mkdir dir="${build.dest}"/>
<!-- copy src files -->
<copy todir="${build.src}">
<fileset dir="${src.dir}"/>
</copy>
</target>
<!--
===================================================================
-->
<!-- Compiles the source
directory
-->
<!--
===================================================================
-->
<target name="build" depends="prepare-src">
<javac srcdir="${build.src}"
destdir="${build.dest}"
debug="${debug}"
optimize="${optimize}">
<classpath refid="classpath"/>
</javac>
</target>
<!--
===================================================================
-->
<!-- Creates the class
package
-->
<!--
===================================================================
-->
<target name="jar" depends="build">
<jar jarfile="${lib.dir}/${name}.jar"
basedir="${build.dest}"
includes="**"/>
</target>
<!--
===================================================================
-->
<!-- Creates the API
documentation
-->
<!--
===================================================================
-->
<target name="javadoc" depends="build">
<mkdir dir="${build.javadocs}"/>
<javadoc packagenames="${packages}"
sourcepath="${build.src}"
destdir="${build.javadocs}"
author="true"
version="true"
use="true"
splitindex="true"
windowtitle="${Name} API"
doctitle="${Name}">
<classpath refid="classpath"/>
</javadoc>
</target>
<!--
===================================================================
-->
<!-- Clean
targets
-->
<!--
===================================================================
-->
<target name="clean" depends="init">
<delete dir="${build.src}"/>
<delete dir="${build.dest}/org"/>
<delete dir="${build.dest}/com"/>
<delete>
<fileset dir="${build.dest}"
includes="**/*.class"/>
</delete>
</target>
</project>
<!-- End of file -->
~省dQusage 打印帮助文档Q告诉有那些d选项Q可用的有build, jar, javadoc和clean.
初始化环境变量：init
所有Q务都Z一些基本环境变量的讄初始化完成，是后l其他Q务的基础Q在环境初始化过E中Q有2Ҏ较可以方便设|：
1 除了使用却缺省的property讄了JAVA源\径和输出路径外，引用了一个外部的build.properties文g中的讄Q?br>
<property file="${basedir}/build.properties" />
q样大部分简单配|用户只要会看懂build.properties可以了Q毕竟XML比vkey
value的属性文件还是要可读性差一些。用build.properties也可以方便其他用户从~译的细节中解放出来?br>
2 CLASSPATH讄Q用了其中的：
<path id="classpath">
<pathelement
path="${jsdk_jar}"/>
<fileset
dir="${lib.dir}">
<include name="**/*.jar"/>
</fileset>
</path>
则相当于讄了：CLASSPATH=/path/to/resin/lib/jsdk23.jar;
/path/to/project/lib/*.jar;
文g复制Qprepare-src
创徏临时SRC存放目录和输出目录?br>
<!--
===================================================================
-->
<!-- Prepares the source
code
-->
<!--
===================================================================
-->
<target name="prepare-src" depends="init">
<!-- create directories -->
<mkdir dir="${build.src}"/>
<mkdir dir="${build.dest}"/>
<!-- copy src files -->
<copy todir="${build.src}">
<fileset dir="${src.dir}"/>
</copy>
</target>
~译dQbuild
~译时的CLASSPATH环境通过一下方式找到引用一个path对象
<classpath refid="classpath"/>
打包dQjar
对应用打包生成项目所写名?jar文g
<!--
===================================================================
-->
<!-- Creates the class
package
-->
<!--
===================================================================
-->
<target name="jar" depends="build">
<jar jarfile="${lib.dir}/${name}.jar"
basedir="${build.dest}"
includes="**"/>
</target>
生成JAVADOC文档d: javadoc
<!--
===================================================================
-->
<!-- Creates the API
documentation
-->
<!--
===================================================================
-->
<target name="javadoc" depends="build">
<mkdir dir="${build.javadocs}"/>
<javadoc packagenames="${packages}"
sourcepath="${build.src}"
destdir="${build.javadocs}"
author="true"
version="true"
use="true"
splitindex="true"
windowtitle="${Name} API"
doctitle="${Name}">
<classpath refid="classpath"/>
</javadoc>
</target>
清空临时~译文gQclean
<!--
===================================================================
-->
<!-- Clean
targets
-->
<!--
===================================================================
-->
<target name="clean" depends="init">
<delete dir="${build.src}"/>
<delete dir="${build.dest}/org"/>
<delete dir="${build.dest}/com"/>
<delete>
<fileset dir="${build.dest}"
includes="**/*.class"/>
</delete>
</target>
TODOQ?br>
更多d/扩展Q（样例Q?br>
- 试dQJUnit试
- 代码风格查Q务：CheckStyleQJalopy{?/li>
- 邮g警报dQ可以把以上q些d的输告发送到制定的用户列表中Q这个Q务可以设|每天自动运行?/li>
参考资料：
Jakarta ANT:
http://ant.apache.org
]]>
<project default="usage" basedir=".">
<!-- =================================================================== -->
<!-- Initialization target -->
<!-- =================================================================== -->
<target name="init">
<tstamp/>
<property file="${basedir}/build.properties" />
<property name="Name" value="ProjectFullName"/>
<property name="name" value="project_name"/>
<property name="version" value="0.2"/>
<property name="year" value="2003"/>
<echo message="----------- ${Name} ${version} [${year}] ------------"/>
<property name="debug" value="off"/>
<property name="optimize" value="on"/>
<property name="deprecation" value="on"/>
<property name="src.dir" value="./src/WEB-INF/src"/>
<property name="lib.dir" value="./src/WEB-INF/lib"/>
<property name="packages" value="com.chedong.*,org.apache.lucene.*"/>
<property name="build.src" value="./src/WEB-INF/build"/>
<property name="build.dest" value="./src/WEB-INF/classes"/>
<property name="build.javadocs" value="./src/doc"/>
<path id="classpath">
<pathelement path="${jsdk_jar}"/>
<fileset dir="${lib.dir}">
<include name="**/*.jar"/>
</fileset>
</path>
<filter token="year" value="${year}"/>
<filter token="version" value="${version}"/>
<filter token="date" value="${TODAY}"/>
<filter token="log" value="true"/>
<filter token="verbose" value="true"/>
</target>
<!-- =================================================================== -->
<!-- Help on usage -->
<!-- =================================================================== -->
<target name="usage" depends="init">
<echo message="${Name} Build file"/>
<echo message="-------------------------------------------------------------"/>
<echo message=""/>
<echo message=" available targets are:"/>
<echo message=""/>
<echo message=" jar --> generates the ${name}.jar file"/>
<echo message=" build --> compiles the source code"/>
<echo message=" javadoc --> generates the API documentation"/>
<echo message=" clean --> cleans up the directory"/>
<echo message=""/>
<echo message=" Please rename build.properties.default to build.properties"/>
<echo message=" and edit build.properties to specify JSDK 2.3 classpath."/>
<echo message=""/>
<echo message=" See the comments inside the build.xml file for more details."/>
<echo message="-------------------------------------------------------------"/>
<echo message=""/>
<echo message=""/>
</target>
<!-- =================================================================== -->
<!-- Prepares the source code -->
<!-- =================================================================== -->
<target name="prepare-src" depends="init">
<!-- create directories -->
<mkdir dir="${build.src}"/>
<mkdir dir="${build.dest}"/>
<!-- copy src files -->
<copy todir="${build.src}">
<fileset dir="${src.dir}"/>
</copy>
</target>
<!-- =================================================================== -->
<!-- Compiles the source directory -->
<!-- =================================================================== -->
<target name="build" depends="prepare-src">
<javac srcdir="${build.src}"
destdir="${build.dest}"
debug="${debug}"
optimize="${optimize}">
<classpath refid="classpath"/>
</javac>
</target>
<!-- =================================================================== -->
<!-- Creates the class package -->
<!-- =================================================================== -->
<target name="jar" depends="build">
<jar jarfile="${lib.dir}/${name}.jar"
basedir="${build.dest}"
includes="**"/>
</target>
<!-- =================================================================== -->
<!-- Creates the API documentation -->
<!-- =================================================================== -->
<target name="javadoc" depends="build">
<mkdir dir="${build.javadocs}"/>
<javadoc packagenames="${packages}"
sourcepath="${build.src}"
destdir="${build.javadocs}"
author="true"
version="true"
use="true"
splitindex="true"
windowtitle="${Name} API"
doctitle="${Name}">
<classpath refid="classpath"/>
</javadoc>
</target>
<!-- =================================================================== -->
<!-- Clean targets -->
<!-- =================================================================== -->
<target name="clean" depends="init">
<delete dir="${build.src}"/>
<delete dir="${build.dest}/org"/>
<delete dir="${build.dest}/com"/>
<delete>
<fileset dir="${build.dest}" includes="**/*.class"/>
</delete>
</target>
</project>
<!-- End of file -->
~省dQusage 打印帮助文档Q告诉有那些d选项Q可用的有build, jar, javadoc和clean.
初始化环境变量：init
所有Q务都Z一些基本环境变量的讄初始化完成，是后l其他Q务的基础Q在环境初始化过E中Q有2Ҏ较可以方便设|：
1 除了使用却缺省的property讄了JAVA源\径和输出路径外，引用了一个外部的build.properties文g中的讄Q?br> <property file="${basedir}/build.properties" />
q样大部分简单配|用户只要会看懂build.properties可以了Q毕竟XML比vkey value的属性文件还是要可读性差一些。用build.properties也可以方便其他用户从~译的细节中解放出来?br>
2 CLASSPATH讄Q用了其中的：
<path id="classpath">
<pathelement path="${jsdk_jar}"/>
<fileset dir="${lib.dir}">
<include name="**/*.jar"/>
</fileset>
</path>
则相当于讄了：CLASSPATH=/path/to/resin/lib/jsdk23.jar; /path/to/project/lib/*.jar;
文g复制Qprepare-src
创徏临时SRC存放目录和输出目录?br> <!-- =================================================================== -->
<!-- Prepares the source code -->
<!-- =================================================================== -->
<target name="prepare-src" depends="init">
<!-- create directories -->
<mkdir dir="${build.src}"/>
<mkdir dir="${build.dest}"/>
<!-- copy src files -->
<copy todir="${build.src}">
<fileset dir="${src.dir}"/>
</copy>
</target>
~译dQbuild
~译时的CLASSPATH环境通过一下方式找到引用一个path对象
<classpath refid="classpath"/>
打包dQjar
对应用打包生成项目所写名?jar文g
<!-- =================================================================== -->
<!-- Creates the class package -->
<!-- =================================================================== -->
<target name="jar" depends="build">
<jar jarfile="${lib.dir}/${name}.jar"
basedir="${build.dest}"
includes="**"/>
</target>
生成JAVADOC文档d: javadoc
<!-- =================================================================== -->
<!-- Creates the API documentation -->
<!-- =================================================================== -->
<target name="javadoc" depends="build">
<mkdir dir="${build.javadocs}"/>
<javadoc packagenames="${packages}"
sourcepath="${build.src}"
destdir="${build.javadocs}"
author="true"
version="true"
use="true"
splitindex="true"
windowtitle="${Name} API"
doctitle="${Name}">
<classpath refid="classpath"/>
</javadoc>
</target>
清空临时~译文gQclean
<!-- =================================================================== -->
<!-- Clean targets -->
<!-- =================================================================== -->
<target name="clean" depends="init">
<delete dir="${build.src}"/>
<delete dir="${build.dest}/org"/>
<delete dir="${build.dest}/com"/>
<delete>
<fileset dir="${build.dest}" includes="**/*.class"/>
</delete>
</target>
TODOQ?br> 更多d/扩展Q（样例Q?br>