代码改变世界

Ant tutorial(2)

2006-03-08 10:32  Jeff  阅读(514)  评论(0编辑  收藏  举报

编译 Java 代码的任务的编写方式:
                <javac srcdir="src"/>
这个标签寻找 src 目录中以 .java 为扩展名的所有文件,并对它们调用 javac 编译器,从而在相同的目录中生成类文件。当然,将类文件放在一个单独的目录结构中通常会更清晰;可以通过添加 destdir 属性来让 Ant 做到这点。其他有用的属性包括:

classpath:等价于 javac -classpath 选项。

debug="true":指示编译器应该带调试信息编译源文件。

javac 任务的一个重要特点在于,它仅编译那些它认为需要编译的源文件。如果某个类文件已经存在,并且对应的源文件自从该类文件生成以来还没有改变过,那么该源文件就不会被重新编译。javac 任务的输出显示了实际被编译的源文件的数目。编写一个 clean 目标来从目标目录移除生成的任何类文件是个很好的习惯。如果想要确保所有源文件都已编译,就可以使用这个任务。这种行为刻画了 Ant 的许多任务的特点:如果某个任务能够确定所请求的操作不需要执行,那么该操作就会被跳过。

Ant javac 任务的默认行为是调用运行 Ant 本身的任何 JVM 的标准编译器。然而,有时您可能想要单独地调用编译器 —— 例如当你希望指定编译器的某些内存选项,或者需要使用一种不同级别的编译器的时候。为实现这个目的,只需将 javac fork 属性设置为 true,比如像下面这样:

<javac srcdir="src" fork="true"/>

如果想要指定一个不同的 javac 可执行文件,并向它传递一个最大内存设置,可以像下面这样做:

    <javac srcdir="src" fork="true" executable="d:\sdk141\bin\javac"

memoryMaximumSize="128m"/>

在编译 Java 源文件之后,结果类文件通常被打包到一个 JAR 文件中,这个文件类似 zip 归档文件。每个 JAR 文件都包含一个清单文件,它可以指定该 JAR 文件的属性。

下面是 Ant jar 任务的一个简单使用例子:

<jar destfile="package.jar" basedir="classes"/>

这将创建一个名为 package.jar JAR 文件,并把 classes 目录中的所有文件添加到其中(JAR 文件能够包含任意类型的文件,而不只是类文件)。此处没有指定清单文件,因此 Ant 将提供一个基本的清单文件。

manifest 属性允许指定一个用作该 JAR 文件的清单的文件。清单文件的内容还可以使用 manifest 任务在生成文件中指定。这个任务能够像文件系统写入一个清单文件,或者能够实际嵌套在 jar 之内,以便一次性地创建清单文件和 JAR 文件。 例如:

<jar destfile="package.jar" basedir="classes">
  
<manifest>
    
<attribute name="Built-By" value="${user.name}"/>
    
<attribute name="Main-class" value="package.Main"/>
  
</manifest>
</jar>

在生成环境中使用当前时间和日期,以某种方式标记某个生成任务的输出,以便记录它是何时生成的,这经常是可取的。这可能涉及编辑一个文件,以便插入一个字符串来指定日期和时间,或将这个信息合并到 JAR zip 文件的文件名中。

 

这种需要是通过简单但是非常有用的 tstamp 任务来解决的。这个任务通常在某次生成过程开始时调用,比如在一个 init 目标中。这个任务不需要属性,许多情况下只需 <tstamp/> 就足够了。

在调用 tstamp 任务之后,我们能够根据日期命名该 JAR 文件,如下所示:

<jar destfile="package-${DSTAMP}.jar" basedir="classes"/>

因此,如果这个任务在 2006 38日调用,该 JAR 文件将被命名为 package-20060308.jar

还可以配置 tstamp 任务来设置不同的属性,应用一个当前时间之前或之后的时间偏移,或以不同的方式格式化该字符串。所有这些都是使用一个嵌套的 format 元素来完成的,如下所示:

<tstamp>
   
<format property="OFFSET_TIME"
           pattern
="HH:mm:ss"
           offset
="10" unit="minute"/>
</tstamp>

上面的清单将 OFFSET_TIME 属性设置为距离当前时间 10 分钟之后的小时数、分钟数和秒数。

用于定义格式字符串的字符与 java.text.SimpleDateFormat 类所定义的那些格式字符相同。

下面将把这些代码片断组合成一个完整的生成文件,它将编译 src 目录下的所有源代码,将结果类文件放在 build 目录下,然后把所有类文件打包到 dist 目录中的一个 JAR 文件中。要自己试验这个生成文件,您所需要的就是包含一个或多个 Java 源代码文件的 src 目录 —— 这个目录可以包含从简单的“Hell World”程序到来自某个现有项目的大量源文件的任何内容。如果需要向 Java classpath 添加 JAR 文件或其他任何内容,以便成功地编译源代码,您只需在 javac 任务中为其添加一个 classpath 属性:

<?xml version="1.0"?>
<project default="dist" name="Project Argon">
     
<description>A simple Java project</description>  

    
<property name="srcDir" location="src"/>
    
<property name="buildDir" location="build"/>
    
<property name="distDir" location="dist"/>

    
<target name="init">
       
<tstamp/>
       
<mkdir dir="${buildDir}"/>
       
<mkdir dir="${distDir}"/>
    
</target>

    
<target name="compile" depends="init">
       
<javac srcdir="${srcDir}" destdir="${buildDir}"/>
    
</target>

    
<target name="dist" depends="compile">
       
<jar destfile="${distDir}/package-${DSTAMP}.jar" basedir="${buildDir}">
         
<manifest>
           
<attribute name="Built-By" value="${user.name}"/>
           
<attribute name="Main-Class" value="package.Main"/>
         
</manifest>
       
</jar>
       
<jar destfile="${distDir}/package-src-${DSTAMP}.jar" basedir="${srcDir}"/>
    
</target>

    
<target name="clean">
      
<delete dir="${buildDir}"/>
      
<delete dir="${distDir}"/>
    
</target>
</project>

下面是使用该文件执行的某次生成过程的示例输出(您得到的输出可能不一样,具体取决于 src 目录的内容):

Buildfile: build.xml

init:
    [mkdir] Created dir: E:\tutorial\javaexample\build
    [mkdir] Created dir: E:\tutorial\javaexample\dist

compile:
    [javac] Compiling 10 source files to E:\tutorial\javaexample\build

dist:
      [jar] Building jar: E:\tutorial\javaexample\dist\package-20031217.jar
      [jar] Building jar: E:\tutorial\javaexample\dist\package-src-20031217.jar

BUILD SUCCESSFUL
Total time: 5 seconds

注意 JAR 文件是根据当前日期来命名的,并且为应用程序的主类设置了一个清单条目,以便主类能够通过一个简单的命令 java -jar package-20031217.jar 来直接运行。我们还创建了一个 JAR 文件,它仅包含项目的源代码。