如何在 Ant 中动态包含 ant-contrib.jar

Question

我正在寻找一种在 Ant 文件中包含 .jar 的方法，以便我可以立即使用它并在我的目标中调用它的方法。 就我而言，它是ant-contrib-1.0b3.jar。

Answer 1

最好的方法是将 Ant-Contrib jarfile 放入您的项目中。例如，假设build.xml 位于项目的根目录中。在您的项目中创建一个名为ant.lib\ant-contrib 的目录，然后将ant-contrib*.jar 放在此文件夹中。您可以将此方法用于您可能需要的其他可选 Ant 任务（例如，Ivy、Findbugs、Cobrrtura 等）。

然后，在您的 build.xml 文件中，您可以这样做：

<taskdef resource="net/sf/antcontrib/antlib.xml">
     <classpath>
         <fileset dir="${basedir}/ant.lib/ant-contrib"/>
     </classpath>
</taskdef>

我喜欢这样做，因为项目中包含了带有任务的可选 jar。如果您将所有内容都签入您的版本控制系统，那么有人可以签出您的代码并进行构建，而无需下载 Ant-Contrib 并自行安装。

您可以定义一个 XML 命名空间。这为您的 Ant-Contrib 任务提供了一个前缀，以避免在您使用具有相同任务名称的其他可选 ant 任务时发生任务名称冲突。另外，它会提醒用户这不是标准的 Ant 任务。

如果您使用 XML 命名空间，则需要在 <project> 标题中添加 XMLNS 声明。这将包含一个 URI，它将您的 Ant Contrib 任务连接到您的 XML 命名空间。例如，ac: 命名空间适用于所有 Ant Contrib 任务：

<project name="my.project" default="package" basedir="."
    xmlns:ac="http://ant-contrib.sourceforge.net">

 <taskdef resource="net/sf/antcontrib/antlib.xml"
      uri="http://ant-contrib.sourceforge.net">
     <classpath>
         <fileset dir="${basedir}/ant.lib/ant-contrib"/>
     </classpath>
</taskdef>

这样做的目的是将 ac 的 XML 命名空间 (xmlns) 与 URI http://ant-contrib.sourceforge.net 匹配。 URI 可以是任何东西。例如：

<project name="my.project" default="package" basedir="."
    xmlns:ac="hamburger:with-fries">

 <taskdef resource="net/sf/antcontrib/antlib.xml"
      uri="hamburger:with-fries">
     <classpath>
         <fileset dir="${basedir}/ant.lib/ant-contrib"/>
     </classpath>
</taskdef>

标准是使用类似antlib:net.sf.antcontrib:

<project name="my.project" default="package" basedir="."
    xmlns:ac="antlib:net.sf.antcontrib">

 <taskdef resource="net/sf/antcontrib/antlib.xml"
      uri="antlib:net.sf.antcontrib">
     <classpath>
         <fileset dir="${basedir}/ant.lib/ant-contrib"/>
     </classpath>
</taskdef>

但是，我喜欢使用项目的 URL。这样，如果有人想要关于 Ant-Contrib 任务的文档，他们就会知道 Ant-Contrib 项目所在的 URL。

在上述所有三种情况下，我都使用ac 定义了 XML 命名空间。因此，您必须在所有 Ant-Contrib 任务名称前加上 ac:。你可以使用antcontrib 或任何你喜欢的。使用 ac: 命名空间，您的 Ant-contrib 任务将如下所示：

<ac:if>
   <istrue value="${include.debug.code}"/>
   <ac:then>
        [...]
   </ac:then>
   <ac:else>
        [...]
   </ac:else>
<ac:if>

如果你跳过整个命名空间的事情，你可以简单地使用 Ant-Contrib 任务记录：

<if>
   <istrue value="${include.debug.code}"/>
   <then>
        [...]
   </then>
   <else>
        [...]
   </else>

Answer 2

最好的解决方案是集成 apache ivy 依赖管理器。 Ivy 可用于管理所有构建类路径的 Maven 风格！

示例

ivy.xml

此文件描述您项目的第 3 方依赖项。 Ivy 使用配置在逻辑上将文件分组在一起。在您的情况下，请注意特殊的“构建”配置用于配置构建所需的 ANT 任务：

<ivy-module version="2.0">
    <info organisation="com.myspotontheweb" module="demo"/>

    <configurations>
        <conf name="compile" description="Required to compile application"/>
        <conf name="runtime" description="Additional run-time dependencies" extends="compile"/>
        <conf name="test"    description="Required for test only" extends="runtime"/>
        <conf name="build"   description="3rd party ANT tasks"/>
    </configurations>

    <dependencies>
        <!-- compile dependencies -->
        <dependency org="org.slf4j" name="slf4j-api" rev="1.6.4" conf="compile->default"/>

        <!-- runtime dependencies -->
        <dependency org="org.slf4j" name="slf4j-simple" rev="1.6.4" conf="runtime->default"/>

        <!-- test dependencies -->
        <dependency org="junit" name="junit" rev="4.10" conf="test->default"/>

        <!-- Build dependencies -->
        <dependency org="ant-contrib" name="ant-contrib" rev="1.0b3" conf="build->default"/>
    </dependencies>

</ivy-module>

注意：

• 默认情况下从Maven Central 检索依赖项，现在托管了大约 90% 的开源 jars

build.xml

<project name="demo" default="build" xmlns:ivy="antlib:org.apache.ivy.ant" xmlns:antcontrib="antlib:net.sf.antcontrib">

    <target name="bootstrap" description="Install ivy">
        <mkdir dir="${user.home}/.ant/lib"/>
        <get src="https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&amp;g=org.apache.ivy&amp;a=ivy&amp;v=LATEST&amp;e=jar"
             dest="${user.home}/.ant/lib/ivy.jar"/>
    </target>

    <target name="init" description="Use ivy to resolve classpaths">
        <ivy:resolve/>

        <ivy:report todir='build/ivy-reports' graph='false' xml='false'/>

        <ivy:cachepath pathid="compile.path" conf="compile"/>
        <ivy:cachepath pathid="runtime.path" conf="runtime"/>
        <ivy:cachepath pathid="test.path"    conf="test"/>
        <ivy:cachepath pathid="build.path"   conf="build"/>
    </target>

    <target name="taskdefs" depends="init" description="Declare 3rd party ANT tasks">
        <taskdef uri="antlib:net.sf.antcontrib" classpathref="build.path"/>
    </target>

    <target name="build" depends="taskdefs" description="Build logic using ant-contrib tasks">
        <echo message="The first five letters of the alphabet are:"/>

        <antcontrib:for list="a,b,c,d,e" param="letter">
            <sequential>
                <echo>Letter @{letter}</echo>
            </sequential>
        </antcontrib:for>
    </target>

    <target name="clean" description="Cleanup build files">
        <delete dir="build"/>
    </target>

    <target name="clean-all" depends="clean" description="Additionally purge ivy cache">
        <ivy:cleancache/>
    </target>

</project>

注意事项：

• 有一个特殊的“引导”目标用于启动新安装。不幸的是，ivy 没有与核心 ANT 一起分发
• cachepath ivy 任务用于创建 ANT 路径，其中包含由 ivy 下载和缓存的 jar。
• ivy 报告任务对于了解 3rd 方库的传递依赖关系非常有用。
• antcontrib 现在以ANT lib 的形式分发，解释了奇怪的命名空间。