如何正确地从ant构建文件导入属性和目标？

Question

我想用两个模块制作项目。 应用程序和服务器。 服务器取决于应用程序。 当我编译服务器时，我想将应用程序中的类文件包含到构建中。 但是由于导入问题，它相对于服务器而非应用解析类路径。 如何使ant解决相对于应用程序的应用程序位置和相对于服务器的服务器位置。 我不知道它在蚂蚁文档中是如何完成的。 您能以更简单的方式进行解释吗？ 代码段可以澄清一些问题。

应用程序build.xml：

<project name="app">
<property name="app.build.dir" location="build"/>

<target name="compile">
    <echo message="Compiling app to ${app.build.dir}"/>
</target>
</project>

服务器build.xml：

<project name="server">
<property name="server.build.dir" location="build"/>

<include file="../app/build.xml"/>

<target name="compile" depends="app.compile">
    <echo message="Compiling server to ${server.build.dir} using classpath: ${app.build.dir}"/>
</target>
</project>

输出：

Buildfile: D:\work\test\ant-test2\server\build.xml

app.compile:
 [echo] Compiling to D:\work\test\ant-test2\server\build

compile:
 [echo] Compiling server to D:\work\test\ant-test2\server\build using classpath:  D:\work\test\ant-test2\server\build

BUILD SUCCESSFUL
Total time: 0 seconds

所需的输出：

Buildfile: D:\work\test\ant-test2\server\build.xml

app.compile:
 [echo] Compiling to D:\work\test\ant-test2\app\build

compile:
 [echo] Compiling server to D:\work\test\ant-test2\server\build using classpath:  D:\work\test\ant-test2\app\build

BUILD SUCCESSFUL
Total time: 0 seconds

Answer 1

多模块构建很困难，因为没有标准，每个构建作者都有自己的解决方案。

我个人的喜好是模仿Maven如何做到的。 每个模块都会创建一个jar文件并将其发布到“本地”存储库中。 然后，此jar文件是使用其类的其他模块的依赖项。 这种方法在模块之间建立了清晰的隔离，这意味着您在处理一个子模块时不需要构建整个项目。

那么如何使用ANT完成此操作？ 那么，您需要接受另一个Maven概念，即依赖管理。 常春藤插件将此功能提供给ANT。

例

我的虚拟项目。 称为“ app”的单个模块，它是“ server”模块的依赖项

├── build.xml         <-- Builds all modules in correct order
├── app
│   ├── build.xml
│   ├── ivy.xml       <-- Describes module dependencies
│   └── src
|         ..
└── server
    ├── build.xml
    ├── ivy.xml       <-- Dependency on the "app" module
    └── src
          ..

除非您自定义位置，否则ivy使用以下目录来存储文件：

~/.ivy2/cache   <-- Downloaded 3rd party dependencies go here
~/.ivy2/local   <-- Repository which is private to the user. 

创建替代存储位置并利用Maven存储库管理器超出了此问题的范围。

通过构建运行此示例后，将生成以下显式版本化的文件：

~/.ivy2/local/com.myspotontheweb/demo-app/1.0.0/jars/demo-app.jar
~/.ivy2/local/com.myspotontheweb/demo-server/1.0.0/wars/demo-server.war

build.xml

以正确的顺序构建所有模块。 这由每个模块的ivy.xml文件中记录的模块依赖关系确定（请参阅ivy buildlist任务）。 当您有大量相互依赖的模块时，此功能非常有用。

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

  <available classname="org.apache.ivy.Main" property="ivy.installed"/> 

  <target name="install-ivy" unless="ivy.installed">
    <mkdir dir="${user.home}/.ant/lib"/>
    <get dest="${user.home}/.ant/lib/ivy.jar" src="http://search.maven.org/remotecontent?filepath=org/apache/ivy/ivy/2.3.0/ivy-2.3.0.jar"/>
    <fail message="Ivy has been installed. Run the build again"/>
  </target>

  <target name="build-list" depends="install-ivy">
    <ivy:buildlist reference="build-path">
      <fileset dir="." includes="**/build.xml" excludes="build.xml"/>
    </ivy:buildlist>
  </target>

  <target name="build" depends="build-list">
    <subant buildpathref="build-path">
      <target name="clean"/>
      <target name="publish"/>
    </subant>
  </target>

  <target name="clean" depends="build-list">
    <subant buildpathref="build-path">
      <target name="clean"/>
    </subant>
  </target>

  <target name="clean-all" depends="clean">
    <ivy:cleancache/>
  </target>

</project>

笔记：

• 包含逻辑，以确保在缺少常春藤罐子依赖项时进行安装
• 常春藤将缓存下载的第三方依赖。 “ clean-all”任务对于确保构建干净整洁是很有用的:-)

app / ivy.xml

列出模块具有的第三方依赖关系。 这是非常有用的Maven功能。 依赖关系会从Maven Central自动下载。 无需将它们提交到您的源代码存储库中。

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

  <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"/>
  </configurations>

  <publications>
    <artifact name="demo-app"/>
  </publications>

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

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

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

</ivy-module>

注意：

• 常春藤配置用于对依赖项进行分类和分组。 稍后用于填充类路径

app / build.xml

相当标准的构建过程。 代码经过编译测试和打包。 注意如何使用常春藤配置来控制类路径。

值得特别注意的是“发布”目标，它会将已构建的jar推送到本地位置 ，其他模块可将其提取。

<project name="demo-app" default="build" xmlns:ivy="antlib:org.apache.ivy.ant">

    <!--
    ================
    Build properties
    ================
    -->
    <property name="src.dir"          location="src/main/java"/>
    <property name="resources.dir"    location="src/main/resources"/>
    <property name="test.src.dir"     location="src/test/java"/>
    <property name="build.dir"        location="target"/>
    <property name="dist.dir"         location="${build.dir}/dist"/>

    <property name="jar.main.class" value="org.demo.App"/>
    <property name="jar.file"       value="${dist.dir}/${ant.project.name}.jar"/>

    <property name="pub.revision" value="1.0"/>
    <property name="pub.resolver" value="local"/>

    <!--
    ===========
    Build setup
    ===========
    -->
    <target name="resolve" description="Use ivy to resolve classpaths">
        <ivy:resolve/>

        <ivy:report todir='${build.dir}/ivy-reports' graph='false' xml='false'/>

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

    <!--
    ===============
    Compile targets
    ===============
    -->
    <target name="resources" description="Copy resources into classpath">
        <copy todir="${build.dir}/classes">
            <fileset dir="${resources.dir}"/>
        </copy>
    </target>

    <target name="compile" depends="resolve,resources" description="Compile code">
        <mkdir dir="${build.dir}/classes"/>
        <javac srcdir="${src.dir}" destdir="${build.dir}/classes" includeantruntime="false" debug="true" classpathref="compile.path"/>
    </target>

    <target name="compile-tests" depends="compile" description="Compile tests">
        <mkdir dir="${build.dir}/test-classes"/>
        <javac srcdir="${test.src.dir}" destdir="${build.dir}/test-classes" includeantruntime="false" debug="true">
            <classpath>
                <path refid="test.path"/>
                <pathelement path="${build.dir}/classes"/>
            </classpath>
        </javac>
    </target>

    <!--
    ============
    Test targets
    ============
    -->
    <target name="test" depends="compile-tests" description="Run unit tests">
        <mkdir dir="${build.dir}/test-reports"/>
        <junit printsummary="yes" haltonfailure="yes">
            <classpath>
                <path refid="test.path"/>
                <pathelement path="${build.dir}/classes"/>
                <pathelement path="${build.dir}/test-classes"/>
            </classpath>
            <formatter type="xml"/>
            <batchtest fork="yes" todir="${build.dir}/test-reports">
                <fileset dir="${test.src.dir}">
                    <include name="**/*Test*.java"/>
                    <exclude name="**/AllTests.java"/>
                </fileset>
            </batchtest>
        </junit>
    </target>

    <!--
    =====================
    Build project
    =====================
    -->
    <target name="build" depends="test" description="Create executable jar archive">
        <ivy:retrieve pattern="${dist.dir}/lib/[artifact]-[revision](-[classifier]).[ext]" conf="runtime"/>

        <manifestclasspath property="jar.classpath" jarfile="${jar.file}">
            <classpath>
                <fileset dir="${dist.dir}/lib" includes="*.jar"/>
            </classpath>
        </manifestclasspath>

        <jar destfile="${jar.file}" basedir="${build.dir}/classes">
            <manifest>
                <attribute name="Main-Class" value="${jar.main.class}" />
                <attribute name="Class-Path" value="${jar.classpath}" />
            </manifest>
        </jar>
    </target>

    <!--
    =====================
    Publish project
    =====================
    -->
    <target name="publish" depends="build" description="Publish artifacts to shared repo">
      <ivy:buildnumber organisation="${ivy.organisation}" module="${ivy.module}" revision="${pub.revision}"/>

      <ivy:publish resolver="${pub.resolver}" pubrevision="${ivy.new.revision}">
        <artifacts pattern="${build.dir}/dist/[artifact].[ext]"/>
      </ivy:publish>
    </target>

    <!--
    =============
    Clean project
    =============
    -->
    <target name="clean" description="Cleanup build files">
        <delete dir="${build.dir}"/>
    </target>

</project>

笔记：

• 常春藤buildnumber任务是确保您的内部版本号是每次运行构建时适当增加非常有用。 它查看以前发布的文件。

服务器/ivy.xml

该模块仅依赖于“ app”模块的最新版本。 实际修订号是在构建时根据本地存储库中存在的文件确定的。

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

  <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"/>
  </configurations>

  <publications>
    <artifact name="demo-server" type="war"/>
  </publications>

  <dependencies>
    <!-- runtime dependencies -->
    <dependency org="com.myspotontheweb" name="demo-app" rev="latest.integration" conf="runtime"/>
  </dependencies>

</ivy-module>

服务器/ build.xml

这个构建只是将库打包成一个WAR文件。 值得注意的是它使用了常春藤检索任务。 它将拉出“ app”模块依赖关系及其所有​​传递依赖关系。 手动跟踪这些信息可能很困难。

<project name="demo-server" default="build" xmlns:ivy="antlib:org.apache.ivy.ant">

    <!--
    ================
    Build properties
    ================
    -->
    <property name="build.dir"        location="target"/>
    <property name="dist.dir"         location="${build.dir}/dist"/>

    <property name="war.file"       value="${dist.dir}/${ant.project.name}.war"/>

    <property name="pub.revision" value="1.0"/>
    <property name="pub.resolver" value="local"/>

    <!--
    ===========
    Build setup
    ===========
    -->
    <target name="resolve" description="Use ivy to resolve classpaths">
        <ivy:resolve/>
        <ivy:report todir='${build.dir}/ivy-reports' graph='false' xml='false'/>
    </target>

    <!--
    =====================
    Build project
    =====================
    -->
    <target name="build" depends="resolve" description="Create executable jar archive">
        <ivy:retrieve pattern="${build.dir}/lib/[artifact]-[revision](-[classifier]).[ext]" conf="runtime"/>

        <war destfile="${war.file}" webxml="src/resources/web.xml">
           <lib dir="${build.dir}/lib"/>
        </war>
    </target>

    <!--
    =====================
    Publish project
    =====================
    -->
    <target name="publish" depends="build" description="Publish artifacts to shared repo">
      <ivy:buildnumber organisation="${ivy.organisation}" module="${ivy.module}" revision="${pub.revision}"/>

      <ivy:publish resolver="${pub.resolver}" pubrevision="${ivy.new.revision}">
        <artifacts pattern="${build.dir}/dist/[artifact].[ext]"/>
      </ivy:publish>
    </target>

    <!--
    =============
    Clean project
    =============
    -->
    <target name="clean" description="Cleanup build files">
        <delete dir="${build.dir}"/>
    </target>

</project>

Answer 2

一种简单的方法如下：在app的build.xml中而不是

<property name="app.build.dir" location="build"/>

采用

<property name="app.build.dir" location="../app/build"/>

如果您按位置（以及相对路径）指定属性，则ant会解析相对于当前项目的路径。 使用这种表示法，ant首先进入目录级别，然后进入应用程序目录，这对您两个项目都是正确的。

更好的方法是将两个构建脚本使用的设置放在单独的属性文件中，并包括两个构建中的该文件。