但行好事
莫论前程❤

Ant项目管理工具—-build.xml详解

Ant的概念

​ 可能有些读者并不连接什么是Ant以及入可使用它,但只要使用通过Linux系统得读者,应该知道make这个命令。当编译Linux内核及一些软件的源程序时,经常要用这个命令。Make命令其实就是一个项目管理工具,而Ant所实现功能与此类似。像make,gnumake和nmake这些编译工具都有一定的缺陷,但是Ant却克服了这些工具的缺陷。最初Ant开发者在开发跨平台的应用时,用样也是基于这些缺陷对Ant做了更好的设计。

​ Ant是纯Java语言编写的,所示具有很好的跨平台性。操作简单。Ant是由一个内置任务和可选任务组成的。Ant运行时需要一个XML文件(构建文件)。Ant通过调用target树,就可以执行各种task。每个task实现了特定接口对象。由于Ant构建文件时XML格式的文件,所以和容易维护和书写,而且结构很清晰。Ant可以集成到开发环境中。由于Ant的跨平台性和操作简单的特点,它很容易集成到一些开发环境中去。

Ant 开发

Ant的构建文件当开始一个新的项目时,首先应该编写Ant构建文件。构建文件定义了构建过程,并被团队开发中每个人使用。Ant构建文件默认命名为build.xml,也可以取其他的名字。只不过在运行的时候把这个命名当作参数传给Ant。构建文件可以放在任何的位置。一般做法是放在项目顶层目录中,这样可以保持项目的简洁和清晰。下面是一个典型的项目层次结构。
(1) src存放文件。
(2) class存放编译后的文件。
(3) lib存放第三方JAR包。
(4) dist存放打包,发布以后的代码。

Ant构建文件是XML文件。每个构建文件定义一个唯一的项目(Project元素)。每个项目下可以定义很多目标(target元素),这些目标之间可以有依赖关系。当执行这类目标时,需要执行他们所依赖的目标。每个目标中可以定义多个任务,目标中还定义了所要执行的任务序列。Ant在构建目标时必须调用所定义的任务。任务定义了Ant实际执行的命令。Ant中的任务可以为3类。
(1) 核心任务。核心任务是Ant自带的任务。
(2) 可选任务。可选任务实来自第三方的任务,因此需要一个附加的JAR文件。
(3) 用户自定义的任务。用户自定义的任务实用户自己开发的任务。

  • build.xml ant构件文件
<?xml version="1.0" encoding="UTF-8"?>
<project basedir="." default="buildeprk" name="eprkapp">
    <property environment="env" /> <!-- 设置系统的环境变量前缀为env -->
    <property name="appName" value="ceb" />
    <property name="appTempDir" value="./weblogic" /> <!-- 临时文件存放位置 -->
    <property file="build.properties" />    <!-- 参数配置文件 -->
    <!-- ${env.HOME}调用系统的HOME变量,即当前用户的家目录 -->
    <property name="domain.dir" value="${env.HOME}/domains/${domain.name}">
    </property>

    <target name="cleanup">
        <delete dir="${appTempDir}/eprk" />
    </target>

    <property name="DOWNLOAD_DIR" value="${application.download.dir}/${deploy.date}" />

    <target depends="cleanup" name="webstart_build">
        <echo message="正在执行 webstart 文件夹下的 build.xml ..." />
        <ant antfile="build.xml" dir="webapps/nc_web/webstart" inheritAll="false" />
    </target>

    <target depends="webstart_build" name="root_build">
        <echo message="正在执行当前文件夹下的 build.xml ..." />
        <ant antfile="buildserver.xml" inheritAll="false" />
    </target>

    <target depends="svnupdate,cleanup,webstart_build,root_build" name="buildeprk">
        <echo message="build 完成" />
    </target>

    <!-- ================================= 
          target: redeploy              
         ================================= -->
    <target name="redeploy" depends="buildeprk,buildapp,deployceb,startAllEprkServer" description="重新部署eprk">
        <echo message="部署重启完成">
        </echo>
    </target>


    <target name="buildapp" depends="" description="buildapp">
        <exec command="rm -rf ${domain.dir}/application/ceb"></exec>
        <exec command="cp -R weblogic/ceb ${domain.dir}/application/"></exec>
        <echo message="application部署完成" />
    </target>

    <!-- ================================= 
          target: svn              
         ================================= -->
    <target name="svnupdate" depends="" description="svn">
        <exec command="svn update">
        </exec>
    </target>

    <!-- ================================= 
           target: deploy              
         ================================= -->

    <target name="deployceb" depends="stopAllEprkServer,deleteEprkStage" description="部署CEB">
        <echo>----删除ceb临时目录----</echo>
    </target>

    <!-- ================================= 
           target: stopAllEprkServer              
         ================================= -->
    <target name="stopAllEprkServer" depends="stopEprkServer1,stopEprkServer2,stopEprkServer1_remote,stopEprkServer2_remote" description="stopEprkServer">
    </target>

    <!-- ================================= 
           target: killServer eprk             
         ================================= -->
    <target name="stopEprkServer1">
        <exec append="true" dir="${domain.dir}/start_script" command="./stopEprkServer1.sh"></exec>
    </target>

    <target name="stopEprkServer1_remote">
        <echo>停止远程eprkServer1</echo>
        <!--
            <sshexec host="${server.host.remote}" username="eprk" password="eprk" trust="true" command="./stopEprkServer1.sh">
            </sshexec>
            -->
    </target>

    <target name="stopEprkServer2">
        <exec append="true" dir="${domain.dir}/start_script" command="./stopEprkServer2.sh"></exec>
    </target>

    <target name="stopEprkServer2_remote">
        <echo>停止远程eprkServer2</echo>
        <!--
            <sshexec host="${server.host.remote}" username="eprk" password="eprk" trust="true" command="./stopEprkServer2.sh">
            </sshexec>
            -->
    </target>

    <!-- ================================= 
                  target: update-app              
                 ================================= -->
    <target name="update-app" depends="ftpget" description="解压tar包">
        <echo>----解压----</echo>
        <!--
            <untar dest="/qynj/qynjdatabakup/update/${TODAY_CN}/tmp/" src="/qynj/qynjdatabakup/update/${TODAY_CN}/update${TODAY_CN}.tar">
            </untar>
            <untar dest="/qynj/qynjdatabakup/update/${TODAY_CN}/tmp/test/" src="/qynj/qynjdatabakup/update/${TODAY_CN}/tmp/ceb_${TODAY_CN}.tar">
            </untar>
            -->
    </target>

    <target name="ftpget" depends="backup">
        <echo>ftp下载</echo>
        <ftp userid="epamsproj" password="epams213877" server="10.1.32.1" remotedir="/files/system/EPAMS/update/update${deploy.date}/" binary="true" action="get" depends="true" verbose="true">
            <fileset dir="/qynj/qynjdatabakup/update/${deploy.date}/">
            </fileset>
        </ftp>
    </target>

    <target name="backup" depends="" description="备份application目录">
        <echo>tar备份applications</echo>
        <!--
            <tar basedir="${domain.dir}/applications/" tarfile="${domain.dir}/app${TODAY_CN}.tar">
            </tar>
            -->
    </target>

    <!-- - - - - - - - - - - - - - - - - - 
              target: deleteEprkStage                      
             - - - - - - - - - - - - - - - - - -->
    <target name="deleteEprkStage">
        <exec append="true" dir="${domain.dir}/start_script" command="./updateApp.sh eprkServer1 ceb"></exec>
        <exec append="true" dir="${domain.dir}/start_script" command="./updateApp.sh eprkServer2 ceb"></exec>
        <!--
        <exec append="true" dir="${domain.dir}/start_script" command="./updateApp.sh eprkServer2_1 ceb">
        </exec>
        -->
        <!--
            <sshexec host="${server.host.remote}" username="eprk" password="eprk" trust="true" command="./updateApp.sh eprkServer1_2 ceb">
            </sshexec>
            -->
        <!--
            <sshexec host="${server.host.remote}" username="eprk" password="eprk" trust="true" command="./updateApp.sh eprkServer1_2 ceb">
            </sshexec>
            -->
    </target>

    <!-- ================================= 
          target: startEprkServer           
         ================================= -->
    <target name="startEprkServer1">
        <exec append="true" dir="${domain.dir}/start_script" command="./startEprkServer1.sh"></exec>
    </target>
    <target name="startEprkServer1_remote">
        <echo>启动远程eprkServer1</echo>
        <!--
        <sshexec host="${server.host.remote}" username="eprk" password="eprk" trust="true" command="./startEprkServer1.sh">
        </sshexec>
        -->
    </target>

    <target name="startEprkServer2">
        <exec append="true" dir="${domain.dir}/start_script" command="./startEprkServer2.sh"></exec>
    </target>
    <target name="startEprkServer2_remote">
        <echo>启动远程eprkServer2</echo>
        <!--
        <sshexec host="${server.host.remote}" username="eprk" password="eprk" trust="true" command="./startEprkServer2.sh">
        </sshexec>
        -->
    </target>

    <!-- ================================= 
          target: startAllEprkServer              
         ================================= -->
    <target name="startAllEprkServer" depends="startEprkServer1,startEprkServer2,startEprkServer1_remote,startEprkServer2_remote" description="startAllEprkServer">
    </target>

    <!-- ================================= 
          target: productTar              
         ================================= -->
    <target name="productTar" depends="" description="tar 生产版本">
        <delete >
            <fileset dir=".">
                <include name="ceb${deploy.date}.tar" />
            </fileset>
        </delete>
        <tar tarfile="ceb${deploy.date}.tar">
            <fileset dir="weblogic">
                <include name="ceb\WEB-INF\lib\ceb.jar" />
                <include name="ceb\webstart\ceb.jar" />
                <include name="ceb\webstart\ceb-eprk-bs.jar" />
                <include name="ceb\webstart\ceb-eprk-pub.jar" />
                <include name="ceb\webstart\ceb-eprk-ui.jar" />
                <include name="ceb\webstart\ceb-fund-bs.jar" />
                <include name="ceb\webstart\ceb-fund-pub.jar" />
                <include name="ceb\webstart\ceb-fund-ui.jar" />
                <include name="ceb\webstart\ceb-tradea-gbu.jar" />
                <include name="ceb\WEB-INF\applicationContext.xml" />
                <include name="ceb\WEB-INF\remoting-servlet.xml" />
                <include name="ceb\WEB-INF\classes\version.properties" />
            </fileset>
        </tar>
    </target>

    <!-- ================================= 
          target: ftpsend              
         ================================= -->
    <target name="ftpsend" depends="" description="上传32.1">
        <ftp userid="epamsproj" password="epams213877" server="10.1.32.1" action="mkdir" remotedir="update/update${deploy.date}/">
        </ftp>
        <ftp userid="epamsproj" password="epams213877" server="10.1.32.1" action="send" binary="true" remotedir="update/update${deploy.date}/">
            <fileset dir=".">
                <include name="ceb${deploy.date}.tar" />
            </fileset>
        </ftp>
    </target>

    <!-- ================================= 
          target: copyto226              
         ================================= -->
    <target name="copyto226" depends="productTar" description="打包上传226">
        <scp todir="eprk@10.1.240.226:${DOWNLOAD_DIR}/ceb${deploy.date}.tar" password="eprk" file="ceb${deploy.date}.tar"></scp>
    </target>
</project>
  • build.properties参数配置文件
domain.name=eprkdomain

server.host=127.0.0.1
server.port=17101
server.username=weblogic
server.password=1a2s3d@f
server.name=Admin

subServer.port.eprk1=8001
subServer.name.eprk1=eprkServer1_1,eprkServer1_2

subServer.port.eprk2=8002
subServer.name.eprk2=eprkServer2_1,eprkServer2_2

subServer.port.eprkcsg=8003
subServer.name.eprkcsg=csgServer1,csgServer2

subServer.port.sz=7002
subServer.name.sz=SzServer1,SzServer2

server.host.remote=10.1.48.59

wtc 57
wtc.server.name=eprk2
wtc.domain.id=eprk2
wtc.service.id=EPRK
wtc.listen.ip=//10.1.240.224:1234

wtc.remote.domain.id=cebzh_8
wtc.remote.service.id=PBMIDGW470
wtc.remote.serveraddr=//10.1.18.57:7774
wtc.ejb.name=tuxedo.services.EPRKHome

application.name.ceb=ceb
application.source.ceb=/qynj/domains/eprkdomain/applications/ceb

application.name.eprkcsg=eprkcsg
application.source.eprkcsg=/qynj/domains/eprkdomain/applications/eprkcsg

application.name.tradeassist=tradeassist
application.source.tradeassist=/qynj/domains/eprkdomain/applications/tradeassist

application.name.uis=uis
application.source.uis=/qynj/domains/eprkdomain/applications/uis

application.name.epams=Epams
application.source.epams=/qynj/domains/eprkdomain/applications/Epams

#deploy
deploy.date=20120830

application.download.dir=/qynj/qynjdatabakup/update
  • updateApp.sh
#!/bin/sh
appdirs="/qynj/domains/epams_domain/servers/$1/stage/$2"
tmpdirs="/qynj/domains/epams_domain/servers/$1/tmp/_WL_user/$2"
if [ -d $appdirs ]
then
    $appdirs
    rm -r $appdirs
fi
if [ -d $tmpdirs ]
then 
    $tmpdirs
    rm -r $tmpdirs
fi

<project>标签

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

  • default表示默认的运行目标,这个属性是必须的。
  • basedir表示项目的基准目录。
  • name表示项目名。
  • description表示项目的描述。

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

<target>标签

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

  • name表示标明,这个属性是必须的。
  • depends表示依赖的目标。
  • if表示仅当属性设置时才执行。
  • unless表示当属性没有设置时才执行。
  • 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总会被执行。

<mkdir>标签

该标签用于创建一个目录,它有一个属性dir用来指定所创建的目录名,其代码如下:<mkdir dir="${class.root}"/>通过以上代码就创建了一个目录,这个目录已经被前面的property标签所指定。

<jar>标签

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

  • destfile表示JAR文件名。
  • basedir表示被归档的文件名。
  • includes表示别归档的文件模式。
  • exchudes表示被排除的文件模式。

<javac>标签

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

  • srcdir表示源程序的目录。
  • destdir表示class文件的输出目录。
  • include表示被编译的文件的模式。
  • excludes表示被排除的文件的模式。
  • classpath表示所使用的类路径。
  • debug表示包含的调试信息。
  • optimize表示是否使用优化。
  • verbose 表示提供详细的输出信息。
  • fileonerror表示当碰到错误就自动停止。

<java>标签

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

  • classname 表示将执行的类名。
  • jar表示包含该类的JAR文件名。
  • classpath所表示用到的类路径。
  • fork表示在一个新的虚拟机中运行该类。
  • failonerror表示当出现错误时自动停止。
  • output 表示输出文件。
  • append表示追加或者覆盖默认文件。

<delete>标签

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

  • file表示要删除的文件。
  • dir表示要删除的目录。
  • includeEmptyDirs 表示指定是否要删除空目录,默认值是删除。
  • failonerror 表示指定当碰到错误是否停止,默认值是自动停止。
  • verbose表示指定是否列出所删除的文件,默认值为不列出。

<copy>标签

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

  • file 表示源文件。
  • tofile 表示目标文件。
  • todir 表示目标目录。
  • overwrite 表示指定是否覆盖目标文件,默认值是不覆盖。
  • includeEmptyDirs 表示制定是否拷贝空目录,默认值为拷贝。
  • failonerror 表示指定如目标没有发现是否自动停止,默认值是停止。
  • verbose 表示制定是否显示详细信息,默认值不显示。

Ant的数据类型

在构建文件中为了标识文件或文件组,经常需要使用数据类型。数据类型包含在
org.apache.tool.ant.types包中。下面简单介绍构建文件中一些常用的数据类型。

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

  • values 是一个命令参数。如果参数种有空格,但又想将它作为单独一个值,则使用此属性。
  • file表示一个参数的文件名。在构建文件中,此文件名相对于当前的工作目录。
  • line表示用空格分隔的多个参数列表。
  • path表示路径。

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

  • file表示环境变量值得文件名。此文件名要被转换位一个绝对路径。
  • path表示环境变量的路径。Ant会将它转换为一个本地约定。
  • value 表示环境变量的一个直接变量。
  • key 表示环境变量名。
    注意 file path 或 value只能取一个。

3.filelist类型Filelist 是一个支持命名的文件列表的数据类型,包含在一个filelist类型中的文件不一定是存在的文件。以下是其所有的属性。

  • dir是用于计算绝对文件名的目录。
  • files 是用逗号分隔的文件名列表。
  • refid 是对某处定义的一个<filelist>的引用。
    注意 dir 和 files 都是必要的,除非指定了refid(这种情况下,dir和files都不允许使用)。

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

  • dir表示fileset 的基目录。
  • casesensitive的值如果为false,那么匹配文件名时,fileset不是区分大小写的,其默认值为true。
  • defaultexcludes 用来确定是否使用默认的排除模式,默认为true。
  • excludes 是用逗号分隔的需要派出的文件模式列表。
  • excludesfile 表示每行包含一个排除模式的文件的文件名。
  • includes 是用逗号分隔的,需要包含的文件模式列表。
  • includesfile 表示每行包括一个包含模式的文件名。

5.patternset 类型
Fileset 是对文件的分组,而patternset是对模式的分组,他们是紧密相关的概念。支持4个属性:includes excludex includexfile 和 excludesfile,与fileset相同。Patternset 还允许以下嵌套元素:include,exclude,includefile 和 excludesfile。

6.filterset 类型
Filterset定义了一组过滤器,这些过滤器将在文件移动或复制时完成文件的文本替换。
主要属性如下:

  • begintoken 表示嵌套过滤器所搜索的记号,这是标识其开始的字符串。
  • endtoken表示嵌套过滤器所搜索的记号这是标识其结束的字符串。
  • id是过滤器的唯一标志符。
  • refid是对构建文件中某处定义一个过滤器的引用。

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

  • location 表示一个文件或目录。Ant在内部将此扩展为一个绝对路径。
  • refid 是对当前构建文件中某处定义的一个path的引用。
  • path表示一个文件或路径名列表。

8.mapper类型
Mapper类型定义了一组输入文件和一组输出文件间的关系,其属性如下。

  • classname 表示实现mapper类的类名。当内置mapper不满足要求时,用于创建定制mapper。
  • classpath表示查找一个定制mapper时所用的类型路径。
  • classpathref是对某处定义的一个类路径的引用。
  • from属性的含义取决于所用的mapper。
  • to属性的含义取决于所用的mapper。
  • type属性的取值为identity,flatten glob merge regexp 其中之一,它定义了要是用的内置mapper的类型。

Ant 的运行

安装好Ant并且配置好路径之后,在命令行中切换到构建文件的目录,输入Ant命令就可以运行Ant.若没有指定任何参数,Ant会在当前目录下查询build.xml文件。如果找到了就用该文件作为构建文件。如果使用了 –find 选项,Ant 就会在上级目录中找构建文件,直至到达文件系统得跟目录。如果构建文件的名字不是build.xml ,则Ant运行的时候就可以使用 –buildfile file,这里file 指定了要使用的构建文件的名称,示例如下:
Ant如下说明了表示当前目录的构建文件为build.xml 运行 ant 执行默认的目标。
Ant –buildfile test.xml使用当前目录下的test.xml 文件运行Ant ,执行默认的目标。

赞(0) 打赏
未经允许不得转载:刘鹏博客 » Ant项目管理工具—-build.xml详解
分享到: 更多 (0)

相关推荐

  • 暂无文章

评论 抢沙发

评论前必须登录!

 

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

微信扫一扫打赏