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 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;Base Directory:${workspace_loc:/Hello}(按“Browse Workspace”选择工程根目录),由于用到了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 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依次执行初始化,编译,测试,打包,生成API文档一系列任务,极大地提高了开发效率。将来开发J2EE项目时,还可加入部署等任务。并且,即使脱离了Eclipse环境,只要正确安装了Ant,配置好环境变量ANT_HOME=<Ant解压目录>,Path=…;%ANT_HOME%\bin,在命令行提示符下切换到Hello目录,简单地键入ant即可。

用Ant来打包
Eclipse内置了Ant。Ant是一种类似于批处理程序的软件包,它主要繁琐的工作是编写和调试自动处理脚本(一个XML文件),但只要有了这个脚本,我们就可以一键完成所有的设定工作。

以myswt这个应用程序项目的打包为例,用Ant来完成“编译->打成JAR包->复制项目引用库->复制本地化文件swt-win32-3063.dll->输出API文档”这五步。

1、在myswt项目根目录下,创建最主要的build.xml文件
<?xml version="1.0"?>
<project name="myswt project" default="api_doc">
    <!-- 定义目录变量 -->
    <property name="src.dir" value="src" />
    <property name="bin.dir" value="bin" />
    <property name="eclipse_plugins.dir" value="c:/eclipse/plugins" />
    <property name="dist.dir" value="d:/dist" />
    <property name="doc.dir" value="${dist.dir}/api" />
    <property name="swt.dll" value="swt-win32-3063.dll" />
    <!-- 定义编译文件时所引用的库 -->
    <path id="master-classpath">
        <fileset dir="${eclipse_plugins.dir}" id="project_lib">
            <include name="org.eclipse.ui.workbench_3.0.1/workbench.jar"/>
            <include name="org.eclipse.swt.win32_3.0.1/ws/win32/swt.jar"/>
            <include name="org.eclipse.jface_3.0.0/jface.jar"/>
            <include name="org.eclipse.osgi_3.0.1/osgi.jar"/>
            <include name="org.eclipse.osgi_3.0.1/core.jar"/>
            <include name="org.eclipse.osgi_3.0.1/resolver.jar"/>
            <include name="org.eclipse.osgi_3.0.1/defaultAdaptor.jar"/>
            <include name="org.eclipse.osgi_3.0.1/eclipseAdaptor.jar"/>
            <include name="org.eclipse.osgi_3.0.1/console.jar"/>
            <include name="org.eclipse.core.runtime_3.0.1/runtime.jar"/>
            <include name="org.eclipse.jface.text_3.0.1/jfacetext.jar"/>
            <include name="org.eclipse.ui.workbench.compatibility_3.0.0/compatibility.jar"/>
        </fileset>
    </path>     <!-- 首任务(空)-->
    <target name="init"/>
    <!-- 编译 -->
    <target name="compile" depends="init">
        <delete dir="${bin.dir}"/>
        <mkdir dir="${bin.dir}"/>
        <!--编译源程序-->
        <javac srcdir="${src.dir}" destdir="${bin.dir}" target="1.4">
            <classpath refid="master-classpath"/>
        </javac>
        <!--复制图标目录-->
        <mkdir dir="${bin.dir}/icons"/>
        <copy todir="${bin.dir}/icons">
            <fileset dir="icons"/>
        </copy>
    </target>
    <!-- 打包 -->
    <target name="pack" depends="compile">
        <!-- bin目录压缩成JAR包 -->
        <delete dir="${dist.dir}"/>
        <mkdir dir="${dist.dir}" />
        <jar basedir="${bin.dir}" destfile="${dist.dir}/myswt.jar" manifest="ant_manifes.txt">
            <exclude name="**/*Test.*" />
            <exclude name="**/Test*.*" />
        </jar>
        <!-- 复制用到的库 -->
        <mkdir dir="${dist.dir}/lib" />
        <copy todir="${dist.dir}/lib">
            <fileset refid="project_lib"/>
        </copy>
        <!-- 复制本地化文件 -->
        <copy todir="${dist.dir}" file="${swt.dll}"/>
    </target>
    <!-- 输出api文档 -->
    <target name="api_doc" depends="pack">
        <delete dir="${doc.dir}"/>
        <mkdir dir="${doc.dir}" />
        <javadoc destdir="${doc.dir}" author="true" version="true" use="true" windowtitle="MySWT API">
            <packageset dir="${src.dir}" defaultexcludes="yes"/>
            <doctitle><![CDATA[<h1>MySWT Project</h1>]]></doctitle>
            <bottom><![CDATA[<i>Document by ChenGang 2005.</i>]]></bottom>
        </javadoc>
    </target>
</project> (1)property项是定义变量,比如<property name="swt.dll" value="swt-win32-3063.dll" />,就是定义一个变量:swt.dll=swt-win32-3063.dll。以后用这个变量则是这样:${swt.dll}。
一般尽量将今后可能会变动的目录、文件等定义成变量,以方便维护。不象Java变量有类型的区分,Ant变量是不区别目录、文件等的,所以为了见名知意,在取变量名时,目录都加“dir”后缀,这个后缀是可以任取名的。 l           src.dir - Java源文件路径。value="src"的src是一个相对路径,它相对的是build.xml的所在目录位置(即项目根目录)。
l           bin.dir - Java编译文件的输出路径
l           eclipse_plugins.dir - eclipse的plugins目录
l           dist.dir - 打包文件的存放目录
l           doc.dir - API文档的存放目录,这里用到了dist.dir变量,直接写value="d:/dist/api"也未尝不可。
l           swt.dll - SWT本地化文件。
(2)<path id="master-classpath">,定义编译文件时所引用的库,相当于classpath。<fileset>项表示一个文件集,再深入一层的<include>项,则表示此文件集下的文件,它们的路径定位相对于<fileset>的dir属性。<fileset>还有一个id属性,在后面复制引用库时会用到。
也许你会问:“你是怎么知道要引用这些文件的?”回答:看项目根目录下的“.classpath”文件,就可以知道本项目要引用那些库了。实际上是把.classpath复制一份后,然后用Editplus编辑而得。
(3)接下来开始定义一些任务。首任务一般都让它为空(没有具体任务内容):<target name="init"/>。
(4)Ant中的任务有着相互的依赖(depends)关系,这些依赖关系是通过depends属性来定义的。当要执行一个任务时,Ant先去执行这个任务的depends任务,……,Ant就这样一直往回找下去。比如:在本例的第二行default="api_doc",它定义了缺省任务是api_doc(输出api文档)->此任务的depends = pack(打包)->pack的depends = compile(编译)->compile的depends=init(首任务),init没有depends。于是,Ant就从init开始依次往回执行任务:init->compile->pack->api_doc。
如果你不想“输出api文档”,则将第二行的缺省任务定义成default="pack"即可,这时整个任务链就抛开了api_doc。
(5)<delete dir="${bin.dir}"/>删除目录。<mkdir dir="${bin.dir}"/>新建目录
(6)编译源程序,如下
<javac srcdir="${src.dir}" destdir="${bin.dir}" target="1.4">
    <classpath refid="master-classpath"/>
</javac>
l           srcdir - 源文件目录,其子目录中的源文件也会被javac.exe编译。
l           destdir - 编译文件输出目录。
l           target - 以JDK1.4为编译目标。
l           classpath - 编译的classpath设置,refid是指引用前面设定的master-classpath。
(7)将icons(即myswt/icons)目录的文件,复制到myswt/bin/icons目录中,如下:
<copy todir="${bin.dir}/icons">
    <fileset dir="icons"/>
</copy>
(8)将文件打成JAR包
<jar basedir="${bin.dir}" destfile="${dist.dir}/myswt.jar" manifest="ant_manifes.txt">
    <exclude name="**/*Test.*" />
    <exclude name="**/Test*.*" />
</jar>
l           basedir - 源目录。
l           destfile - 目标目录和打成JAR包名。
l           manifest - 打包清单文件(后面给出其内容)。
l           exclude - 使用了通配符将某一些文件排除不打包(主要是一些测试文件)。
(9)如下,将project_lib的文件复制到d:/dist/lib目录中。project_lib是前面“定义编译文件时所引用的库”中的文件集的id。结果参数下图21.25
<copy todir="${dist.dir}/lib">
    <fileset refid="project_lib"/>
</copy>
(10)将本地化文件复制到d:/dist目录中,如下:
<copy todir="${dist.dir}" file="${swt.dll}"/> 
(11)输出API文档(结果参数下图21.26)
<javadoc destdir="${doc.dir}" author="true" version="true" use="true" windowtitle="MySWT API">
    <packageset dir="${src.dir}" defaultexcludes="yes"/>
    <doctitle><![CDATA[<h1>MySWT Project</h1>]]></doctitle>
    <bottom><![CDATA[<i>Document by ChenGang 2005.</i>]]></bottom>
</javadoc>
l           destdir - 目标路径d:/dist/api
l           packageset - 源文件目录
l           doctitle - 标题
l           bottom - 标尾。
2、创建打包清单
为了避免和原来的manifes.txt同名,在项目根目录建立一个名为ant_manifes.txt的文件。这个文件内容中最长的是Class-Path项,没有必要一个个字符的敲入,它可以由项目根目录下的“.classpath”编辑而得。
ant_manifes.txt内容如下:
Manifest-Version: 1.0
Main-Class: jface.dialog.wizard.WizardDialog1
Class-Path: ./lib/org.eclipse.ui.workbench_3.0.1/workbench.jar ./lib/org.eclipse.swt.win32_3.0.1/ws/win32/swt.jar 
./lib/org.eclipse.jface_3.0.0/jface.jar ./lib/org.eclipse.osgi_3.0.1/osgi.jar ./lib/org.eclipse.osgi_
3.0.1/core.jar ./lib/org.eclipse.osgi_3.0.1/resolver.jar ./lib/org.eclipse.osgi_3.0.1/defaultAdaptor.ja
r ./lib/org.eclipse.osgi_3.0.1/eclipseAdaptor.jar ./lib/org.eclipse.osgi_3.0.1/console.jar ./lib/org.ecl
ipse.core.runtime_3.0.1/runtime.jar ./lib/org.eclipse.jface.text_3.0.1/jfacetext.jar ./lib/org.eclipse.u
i.workbench.compatibility_3.0.0/compatibility.jar
3、如下图21.23所示,选择“Ant构建”来运行Ant。

图21.23 运行“Ant构建”
运行“Ant构建”后的结果如下图21.23-26所示。

图21.24 控制台的输出

图21.25 输出文件的目录结构图

图21.26 输出的API文档效果图
4、运行打包结果
除了清单文件MANIFEST.MF之外,myswt.jar文件和21.1节所得的myswt.jar一样。本节没有创建run.bat批处理文件,而是用下图21.27所示的“右击myswt.jar->打开方式->javaw”的方式来运行myswt.jar。

http://www.huomo.cn/developer/article-5232.html

你可能感兴趣的:(eclipse,ant,api,javadoc,include,任务)