天天看点

采用Ant打包

好久没更博了,最近研究了一下Ant打包机制,作一下记录。首先简要介绍一下Ant。

Ant是一个基于Java的生成(在软件开发中用来将源代码和其他输入文件转换为可执行文件的形式)工具,最常用的就是用Ant打包war文件。在使用Ant打包之前需要搭建一个ant环境,大致分为一下几步:

1、安装jdk并配置环境变量(JAVA_HOME、CLASSPATH、PATH);

2、下载Ant并解压;

3、新建环境变量ANT_HOME=解压路径,并在PATH后追加ANT_HOME目录下的bin目录(如ANT_HOME:D:\apache-ant-1.8.2,PATH:%ANT_HOME%\bin);

4、测试一下你的设置,开始–>运行–>cmd进入命令行–>键入 ant 回车,如果看到

Buildfile: build.xml does not exist!

Build failed

那么你的Ant环境搭建成功。

使用Ant打包的好处是在多次调试运行中不需要手动的用javac 、copy 、jar、java来一次次的完成,可以批量地完成这些重复操作。因此,ant需要一个构建文件来定义以上这些操作,构建文件一般命名为build.xml,也可以使用其他自己定义的名字,但是在调用的时候需要加上-buildfile参数,如ant -buildfile mybuild.xml。下面介绍一下如何建立一个构建文件。

Ant构建文件是XML文件。每个构建文件定义一个唯一的项目(Project标签)。每个项目下可以定义很多目标(target标签),这些目标之间可以有依赖关系。当执行这类目标时,需要执行他们所依赖的目标。每个目标中可以定义多个任务,目标中还定义了所要执行的任务序列。Ant在构建目标时必须调用所定义的任务。任务定义了Ant实际执行的命令。Ant中的任务可以为3类。

(1) 核心任务。核心任务是Ant自带的任务。

(2) 可选任务。可选任务实来自第三方的任务,因此需要一个附加的JAR文件。

(3) 用户自定义的任务。用户自定义的任务实用户自己开发的任务。

1、project标签

每个构建文件对应一个项目。project标签时构建文件的根标签。它可以有多个内在属性,就如代码中所示,其各个属性的含义分别如下。

(1) default表示默认的运行目标,这个属性是必须的。

(2) basedir表示项目的基准目录。

(3) name表示项目名。

(4) description表示项目的描述。

每个构建文件都对应于一个项目,但是大型项目经常包含大量的子项目,每一个子项目都可以有自己的构建文件。

2、target标签

一个项目标签下可以有一个或多个target标签。一个target标签可以依赖其他的target标签。例如,有一个target用于编译程序,另一个target用于声称可执行文件。在生成可执行文件之前必须先编译该文件,因策可执行文件的target依赖于编译程序的target。Target的所有属性如下。

(1) name表示标明,这个属性是必须的。

(2) depends表示依赖的目标。

(3) if表示仅当属性设置时才执行。

(4) unless表示当属性没有设置时才执行。

(5) description表示项目的描述。

Ant的depends属性指定了target的执行顺序。Ant会依照depends属性中target出现顺序依次执行每个target。在执行之前,首先需要执行它所依赖的target。程序中的名为run的target的depends属性compile,而名为compile的target的depends属性是prepare,所以这几个target执行的顺序是prepare->compile->run。一个target只能被执行一次,即使有多个target依赖于它。如果没有if或unless属性,target总会被执行。

3、mkdir标签

该标签用于创建一个目录,它有一个属性dir用来指定所创建的目录名,其代码如下:

<mkdir dir=”${class.root}”/>

通过以上代码就创建了一个目录,这个目录已经被前面的property标签所指定。

4、jar标签

该标签用来生成一个JAR文件,其属性如下。

(1) destfile表示JAR文件名。

(2) basedir表示被归档的文件名。

(3) includes表示别归档的文件模式。

(4) exchudes表示被排除的文件模式。

5、javac标签

该标签用于编译一个或一组java文件,其属性如下:

(1).srcdir表示源程序的目录。

(2).destdir表示class文件的输出目录。

(3).include表示被编译的文件的模式。

(4).excludes表示被排除的文件的模式。

(5).classpath表示所使用的类路径。

(6).debug表示包含的调试信息。

(7).optimize表示是否使用优化。

(8).verbose 表示提供详细的输出信息。

(9).fileonerror表示当碰到错误就自动停止。

6、java标签

该标签用来执行编译生成的.class文件,其属性如下。

(1).classname 表示将执行的类名。

(2).jar表示包含该类的JAR文件名。

(3).classpath所表示用到的类路径。

(4).fork表示在一个新的虚拟机中运行该类。

(5).failonerror表示当出现错误时自动停止。

(6).output 表示输出文件。

(7).append表示追加或者覆盖默认文件。

7、war标签

该标签用来把javaweb项目打包成一个war文件,在javaweb开发中经常用到,其属性如下。

(1).destfile表示生成war文件路径。

(2).webxml表示web项目的配置文件web.xml

8、delete标签

该标签用于删除一个文件或一组文件,去属性如下:

(1).file表示要删除的文件。

(2).dir表示要删除的目录。

(3).includeEmptyDirs 表示指定是否要删除空目录,默认值是删除。

(4).failonerror 表示指定当碰到错误是否停止,默认值是自动停止。

(5).verbose表示指定是否列出所删除的文件,默认值为不列出。

9、copy标签

该标签用于文件或文件集的拷贝,其属性如下。

(1).file 表示源文件。

(2).tofile 表示目标文件。

(3).todir 表示目标目录。

(4).overwrite 表示指定是否覆盖目标文件,默认值是不覆盖。

(5).includeEmptyDirs 表示制定是否拷贝空目录,默认值为拷贝。

(6).failonerror 表示指定如目标没有发现是否自动停止,默认值是停止。

(7).verbose 表示制定是否显示详细信息,默认值不显示。

以上是构建文件中的常用标签,还有很多标签,在此不一一介绍

在构建文件中为了标识文件或文件组,经常需要使用数据类型,介绍几种常用的数据类型。

1、fileset类型

Fileset 数据类型定义了一组文件,并通常表示为fileset元素。不过,许多ant任务构建成了隐式的fileset,这说明他们支持所有的fileset属性和嵌套元素。以下为fileset 的属性列表。

(1).dir表示fileset 的基目录。

(2).casesensitive的值如果为false,那么匹配文件名时,fileset不是区分大小写的,其默认值为true。

(3).defaultexcludes 用来确定是否使用默认的排除模式,默认为true。

(4).excludes 是用逗号分隔的需要派出的文件模式列表。

(5).excludesfile 表示每行包含一个排除模式的文件的文件名。

(6).includes 是用逗号分隔的,需要包含的文件模式列表。

(7).includesfile 表示每行包括一个包含模式的文件名。

例如:

<fileset dir="${lib.dir}"> <include name="**/*.jar"/> </fileset>

2、argument 类型

由Ant构建文件调用的程序,可以通过arg元素向其传递命令行参数,如apply,exec和java任务均可接受嵌套arg元素,可以为各自的过程调用指定参数。以下是arg的所有属性。

(1).values 是一个命令参数。如果参数种有空格,但又想将它作为单独一个值,则使用此属性。

(2).file表示一个参数的文件名。在构建文件中,此文件名相对于当前的工作目录。

(3).line表示用空格分隔的多个参数列表。

(4).path表示路径。

3、path类型

Path元素用来表示一个类路径,不过它还可以用于表示其他的路径。在用作揖个属性时,路经中的各项用分号或冒号隔开。在构建的时候,此分隔符将代替当前平台中所有的路径分隔符,其拥有的属性如下。

(1).location 表示一个文件或目录。Ant在内部将此扩展为一个绝对路径。

(2).refid 是对当前构建文件中某处定义的一个path的引用。

(3).path表示一个文件或路径名列表。

例如:

<path id="classpath">
        <fileset dir="${lib.dir}">
            <include name="**/*.jar"/>
        </fileset>
    </path>
           

4、filterset 类型

Filterset定义了一组过滤器,这些过滤器将在文件移动或复制时完成文件的文本替换。

主要属性如下:

(1).begintoken 表示嵌套过滤器所搜索的记号,这是标识其开始的字符串。

(2).endtoken表示嵌套过滤器所搜索的记号这是标识其结束的字符串。

(3).id是过滤器的唯一标志符。

(4).refid是对构建文件中某处定义一个过滤器的引用。

5、ervironment 类型

由Ant构建文件调用的外部命令或程序,env元素制定了哪些环境变量要传递给正在执行的系统命令,env元素可以接受以下属性。

(1).file表示环境变量值得文件名。此文件名要被转换位一个绝对路径。

(2).path表示环境变量的路径。Ant会将它转换为一个本地约定。

(3).value 表示环境变量的一个直接变量。

(4).key 表示环境变量名。

注意 file path 或 value只能取一个。

提供一个我自己开发的构建文件demo:

<?xml version="1.0" encoding="UTF-8"?>
<project name="webclient" default="war" basedir=".">
    <property name="webapp.name" value="webclient"/>
    <property name="src.dir" value="${basedir}/src"/>
    <property name="lib.dir" value="${basedir}/WebContent/WEB-INF/lib"/>
    <property name="class.dir" value="${basedir}/WebContent/WEB-INF/classes"/>
    <property name="war.dir" value="${basedir}/war"/>
    <!-- set class path -->
    <path id="classpath">
        <fileset dir="${lib.dir}">
            <include name="**/*.jar"/>
        </fileset>
    </path>
    <!-- clean class & war -->
    <target name="clean">
        <delete dir="${class.dir}" includes="**/*.class"/>
        <delete dir="${war.dir}/${webapp.name}.war"/>
    </target>
    <!-- compile java -->
    <target name="compile" depends="clean">
        <mkdir dir="${class.dir}"/>
        <javac srcdir="${src.dir}" destdir="${class.dir}" debug="true" includeantruntime="false">
            <classpath refid="classpath"/>
        </javac>
        <copy todir="${class.dir}">
            <fileset dir="${src.dir}" excludes="**/*.java"/>
        </copy>
    </target>

    <target name="war" depends="compile">
        <mkdir dir="${war.dir}"/>
        <war destfile="${war.dir}/${webapp.name}.war" webxml="${basedir}/WebContent/WEB-INF/web.xml">
            <fileset dir="${basedir}/WebContent">
                <exclude name="**/*.java"/>
            </fileset>
            <!-- <lib dir="${lib.dir}"/> -->
            <!-- <classes dir="${class.dir}"/> -->
        </war>
    </target>
</project>
           

创建了build文件,就可以打包war、jar等文件了。具体操作:进入dos命令环境->cd命令进入build.xml文件所在目录->执行命令ant -buildfile build.xml

出现如图所示界面,说明war文件打包成功。

采用Ant打包
采用Ant打包

细心的读者可能会发现我的命令行中并没有调用“ant”命令,而是运行了一个叫build.bat的批量处理文件,并且我的ant路径也是以参数传递的。不错,我在ant.bat文件外层自定义了一个build.bat文件,在文件中调用ant命令执行打包操作。这样做是有好处的,下面先给出build.bat文件,再说明这样做的优势。

@echo off
set JAVA_HOME=C:\Program Files (x86)\Java\jdk1.._17
set CLASSPATH=.;%JAVA_HOME%\lib\dt.jar;%JAVA_HOME%\lib\tools.jar
set work_dir=%~dp0%
rem set /p ANT_PATH=please input ant path:
set ANT_PATH=%
pushd %work_dir%
%ANT_PATH%/ant -buildfile build.xml
popd
           

可以看到,在文件开头我定义了两个宏,指明jdk的配置信息。这样一来,用户就不需要再配置jdk的环境变量了。假如你的电脑里安装了两个版本的jdk,只需要修改脚本文件就可以轻松地在两个版本jdk中运行。另外,以参数的形式传入Ant的路径,也省去了配置Ant的环境变量,这样既方便后续开发者调用你的脚本文件,又能轻松的在其他pc上运行。

最后提一下dos下的传参命令,%0代表当前路径,%1接收传入的第一个参数,%2接收传入的第二个参数……以此类推。%~dp0%和%0类似,代表当前路径,但是与%0不同的是,%~dp0%可以获取输入路径的父目录,例输入D:\codes\trunk\client\web\IBMS\webclient\build.bat,则%~dp0%=D:\codes\trunk\client\web\IBMS\webclient

好了,以上是这次研究的所有内容了,比较浅显,有待深入研究!!!

继续阅读