□技術メモ - antによるビルド

※管理人の個人的な技術メモです。このページの内容の実行結果について
管理人はいかなる責任も負いかねますのでご自身の責任でお試しください。

-----------------------------------------------------------

〇antのDownload, インストール, 実行方法

・以下のアドレスからダウンロードする。
  http://ant.apache.org

・ファイル名は以下の通り。
  apache-ant-1.x.x-bin.zip

・antのインストールは適当なフォルダを作成して、上記のzipファイルを展開すればよい。
  ここでは c:\prg-ant としておく。
  C:\prg-ant\apache-ant-1.10.1 の直下にbinができるのが正しい。

・環境変数の設定
  ANT_HOME : C:\prg-ant\apache-ant-1.10.1
  path : %ANT_HOME%&\bin を追加。

・動作確認
  ant -version でバージョンが表示されれば問題ない。

・Antの実行
  コマンドラインで「ant ビルドファイル名」でbuild を実行。
  引数がない場合は、ant build.xml が実行される。

--------

○build.xml の内容

・strutsに、build.xml が同梱されてくるので、これを解析してみる。

・不要なコメントを外して、調査用にコメントを付加したものが以下の通り。

build.xml
--------
<project name="blank" basedir="../" default="all">

    <!-- Local system paths -->
    <property name="servlet.jar" value="../../common/lib/servlet-api.jar"/>
    <property name="distpath.project" value="dist"/>

    <!-- Project settings -->
    <property name="project.title" value="Apache Struts Blank "/>
    <property name="project.distname" value="blank"/>
    <property name="project.version" value="1.3"/>

    <!-- Path settings -->
    <property name="doc.path" value="./doc/api"/>
    <property name="doc.src" value="./src/java"/>

    <!-- classpath for Struts 1.3 -->
    <path id="compile.classpath">
        <pathelement path ="lib/commons-beanutils.jar"/>
        <pathelement path ="lib/commons-digester.jar"/>
        <pathelement path ="lib/struts.jar"/>
        <pathelement path ="${servlet.jar}"/>
        <pathelement path ="classes"/>
        <pathelement path ="${classpath}"/>
    </path>

<!--
■clean
//classesフォルダの削除、再作成
-->
    <!-- Remove classes directory for clean build -->
    <target name="clean"
      description="Prepare for clean build">
      <delete dir="classes"/>
      <mkdir  dir="classes"/>
    </target>

<!--
■prepare
-->
    <!-- Check timestamp on files -->
    <target name="prepare">
        <tstamp/>
    </target>
<!--
//タイムスタンプ関連の設定
//参照先に以下に類似する設定があると思われる。
<tstamp>
<format property="touch.time" pattern="MM/dd/yyyy hh:mm aa"
        offset="-5" unit="hour"/>
</tstamp>
-->

<!--
■resources
//**は、フォルダ名のワイルドカード
//MessageResources.properties がここで指定される。
-->
    <!-- Copy any resource or configuration files -->
    <target name="resources">
        <copy todir="classes" includeEmptyDirs="no">
            <fileset dir="src/java">
            <patternset>
                <include name="**/*.conf"/>
                <include name="**/*.properties"/>
                <include name="**/*.xml"/>
            </patternset>
            </fileset>
        </copy>
    </target>

<!--
■compile
//classpath refid= で lib\*.jar への参照を指定する。
-->
    <!-- Normal build of application -->
    <target name="compile" depends="prepare,resources">
        <javac srcdir="src/java" destdir="classes">    // src/java の下のパッケージも対象になる。
            <classpath refid="compile.classpath"/>
        </javac>
    </target>

■javadoc
//javadoc生成
-->
    <!-- Build Javadoc documentation -->
    <target name="javadoc"
     description="Generate JavaDoc API docs">
        <delete dir="./doc/api"/>
        <mkdir dir="./doc/api"/>
        <javadoc sourcepath="./src/java"
            destdir="./doc/api"
            classpath="${servlet.jar}"
            packagenames="*"
            author="false"
            private="true"
            version="true"
            windowtitle="${project.title} API Documentation"
            doctitle="&lt;h1&gt;${project.title} Documentation (Version ${project.version})&lt;/h1&gt;"
            bottom="Copyright &#169; 2002-2005">
            <classpath refid="compile.classpath"/>
        </javadoc>
    </target>

<!--
■project
-->
    <!-- Build entire project -->
    <target name="project" depends="clean,prepare,compile,javadoc"/>

<!--
■dist
//配布用warファイルの作成
-->
    <!-- Create binary distribution -->
    <target name="dist"
        description="Create binary distribution">    //配布用ファイルの生成

      <mkdir
        dir="${distpath.project}"/>    // "dist"
      <jar
        jarfile="${distpath.project}/${project.distname}.jar"    // dist\blank.jar を生成する
        basedir="./classes"/>          // jarの元ファイル
<!--
      <copy
        file="${distpath.project}/${project.distname}.jar"       // このコピーに意味があるのか不明
        todir="${distpath.project}"/>
-->
      <copy
        file="${distpath.project}/${project.distname}.jar"       // これならjarがbackupフィルダにコピーされる。jarコマンドの前に実行するのが良いと思う。
        todir="backup"/>

      <war
        basedir="../"    // WEB-INF
        warfile="../../${project.distname}.war"    // WEB-INF と同じ階層に .war を作成する
        webxml="web.xml">
        <exclude name="**/${distpath.project}/**"/>    // distフォルダ以外を全て含める
       </war>
      <move file="../../${project.distname}.war" tofile="${distpath.project}/${project.distname}.war" />
    </target>

<!--
■all
//デフォルトのターゲット 全部実行
-->
    <!-- Build project and create distribution-->
    <target name="all" depends="project,dist"/>

</project>
--------

・ターゲットを依存関係で並べると以下の通りになる。
  (例 : all は、 project, dist に依存している)

all
    project
        clean
        prepare
        compile
            resources
        javadoc
    dist

・これより処理順は以下の通りになる。

clean     //classesフォルダの削除、再作成
prepare   //タイムスタンプ関連の設定
resources //MessageResources.properties等を必要な個所にコピーする。
compile   //コンパイルする。lib\*.jar への参照を指定する。
javadoc   //javadoc生成
project   //上記のtargetをコールする。
dist      //配布用warファイルの作成
all       //デフォルトのターゲット。全部実行する。

・jarコマンドでは、META-INFフォルダと、MANIFEST.MF が自動的に追加されることに注意。

・上記を参考に、strutsで想定される TriSt02 プロジェクトのbuild.xmlを作成してみる。
  引き続き以下参照。
  http://3rd.geocities.jp/tnoguchislg/9-struts-etc/ant-build2.txt