Ant用build.xml事始め

「Ant椿は恋の花」「Ant驚くタメゴロウ」等Antについて薀蓄を述べようというのではありません。Apache Jakartaプロジェクトのサブプロジェクトの一つであるAnt用のbuild.xmlの書き方について簡単に説明しようと思います。

Unixを使ったソフトウェア開発ならば通常makeを使いますし、Windows上では所謂統合開発環境と呼ばれるツールを使うことが多いと思います。ただmakeはとても便利で汎用的に使える反面、依存関係をちゃんと書くのが非常に難しいのが難点です。依存関係を自動作成してくれるツールもありますが、なかなか思うように動いてくれない事が多いのです。もう少し何とかならないかと思うことはしばしばです。一方Windows上の統合開発環境と呼ばれるツールの場合、何をやってくれているのかが外からは見えにくく、また別のツールとの組み合わせをしたくてもできないことが多く、何だかなぁと思う人は少なくないでしょう。

Antがそういう悩みを100%解決するとは言いませんが、Javaのプログラム開発を行うのであれば、使って損はないツールだと思います。またJakartaプロジェクトで提供されるツールを始めとして、フリーのJavaプログラムのソースをコンパイルする場合、今やMakefileではなく、build.xml(AntのMakefileみたいなの)がついてくる時代ですので、全く知らないでは済ませられません。ちょっとだけ勉強してみましょう(私もそんなに詳しいわけではありませんが)。

Antの取得方法は省略します。Apache Jakartaプロジェクトといえば判るでしょう。この文書を書いている時点での最新バージョンは1.5.1です。

Antはそれ自身がJavaで記述されているツールですので、動作にはJavaVMが必須です。起動用にantというシェルスクリプト(Windows用にはant.bat)が用意されています。ちなみにスタートアップ用のクラスはorg.apache.tools.ant.Mainです。Javaで書かれているということは、JavaコンパイラやCoreクラスのバージョンやら、クラスパスやら、その辺の設定で悩まなければならない要素はあります。

Antのbuild.xmlの考え方はmakeを知っている人なら、それほど難しいものではありません。Makefileに相当するのがbuild.xmlです。Makefile内のall::やらclean::といったmakeターゲットはbuild.xmlではまさしく<target>タグになります。makeとは少し違うのは、makeがMakefileで指定される色々な作業そのものについては気にしないのに対し、Antは<target>でやってよいことが予め用意されている、という点です。このやってよい事をタスクと呼んでいます。ようするにAntは用意されたタスクを実行するツールな訳です。

タスクにはJavaのプログラムの開発に必要なものが概ね用意されています。javacやらjavadoc、jarやrmic、はたまたディレクトリの作成や削除、コピー、zip、cvs等がCoreタスクとしてありますし、オプションタスクとしてJavaCCやJavah、rpm、telnetといった、思いつくものは大体あるので、適当なタスクが無くて困ることは特に無いと思われます。

<project>

さて実際のbuild.xmlの書き方について、Ant自身のbuild.xmlを見てゆきましょう。まず先頭に

    <?xml version="1.0"?>

    <?xml version="1.0" encoding="Shift_JIS"?>

    <project default="main" basedir=".">

<project>タグには3つの属性を指定することができます。name、defaultそしてbasedirです。defaultだけが必須です。nameはプロジェクトの名前、defaultはデフォルトのターゲット名、basedirはbuild.xml中の相対パスを指定する基点のディレクトリを指定します。

<property>

<project>タグの下位ノードの主なものは<property>タグと<target>タグになります。<property>タグはいわばマクロ置換のような機能を提供します。例えば、

    <property name="Name" value="Apache Ant"/>

    <property file="${user.home}/.ant.properties"/>

<target>

<target>タグでの記述が、build.xmlの中心になります。ここでやりたいことを記述するわけです。Antを起動するときに、

    % ant hoge

    <target name="hoge">

    <target name="main"
          description="--> creates a minimum distribution in ./dist"
          depends="dist-lite"/>

タスク

<target>タグの下位ノードには、そのターゲットで実行したい様々なことをタスクとして記述します。タスクは

    <mkdir dir="${build.dir}"/>

    <copy todir="${dist.lib}">
      <fileset dir="${build.lib}"/>
    </copy>

Antのbuild.xmlの場合、

    <javac srcdir="${java.dir}"
           destdir="${build.classes}"
           debug="${debug}"
           deprecation="${deprecation}"
           target="${javac.target}"
           optimize="${optimize}" >

クラスパスは属性classpathで指定することも可能ですが、多くの場合は複数のjarやclassファイルを参照したいでしょう。その場合は<javac>タグの子ノードとして<classpath<タグを指定します。クラスパスだけでなくソースディレクトリ等パス形式の値を指定するにはみな同じ方法が取れます。

    <classpath>
      <pathelement path="${classpath}"/>
    </classpath>

Antのマニュアルにはクラスパス設定のサンプルとして、

    <classpath>
      <pathelement path="${classpath}"/>
      <fileset dir="lib">
        <include name="**/*.jar"/>
      </fileset>
      <pathelement location="classes"/>
      <dirset dir="${build.dir}">
        <include name="apps/**/classes"/>
        <exclude name="apps/**/*Test*"/>
      </dirset>
      <filelist refid="third-party_jars">
    </classpath>

それから