Ant Build Script

In diesem Tutorial möchte ich beschreiben wie ein Apache Ant Build Script aufgebaut ist und wie man ein Target erstellt und ein Kompilierungsvorgang startet.

Ausführen von Apache Ant

Das Builttool Apache Ant lässt sich auf der Kommandozeile mit dem Befehl „ant“ starten. Dazu wechseln Sie in das Verzeichnis, indem die Datei „build.xml“ liegt und führen den Befehl „ant“ aus.

Wenn Sie kein Target angeben so wird das DefaultTarget gewählt und ausgeführt, wollen Sie jedoch ein spezielles Target ausführen so geben Sie hinter dem Befehl „ant“ das Target ein.

In der Grafik kann man gut erkennen das zuerst der Befehl „ant“ ausgeführt wurde und das Default Target ausgeführt wird, im zweiten Aufruf wird der Befehl „ant“ mit dem Parameter für das Target ausgeführt und es wird das Target gestartet.

Ein Build Script erstellen

Für das nachfolgende Script erkläre ich wie ich das Apache Ant Build Script für das Projekt TypeUpperCaseWarn geschrieben habe.

Nun nachdem wir unser erstes Script ausgeführt haben wollen wir unser Java Projekt mit Apache Ant bauen und veröffentlichen.

Als Erstes erstellen wir die Grundstruktur der XML Datei diese besteht aus dem XML Header und dem Project Tag.

<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
<project name="TypeUpperCaseWarn" default="createAll" basedir=".">

</project>

Als erstes definieren wir die „Variablen“ mit den Verzeichnissen, Versionsnummern und anderen Eigenschaften für unser Script (diese Liste wird später immer mehr erweitert.)

<!-- Version des Projektes -->
<property name="projectversion" value="1.3" />

<!-- Buildversion, wird mit jedem ausführen des Ant incrementiert -->
<buildnumber file="${basedir}\ant\build.number"/>

<!-- Pfadangabe zu dem Quellcode -->
<property name="src" value="${basedir}/src" />

<!-- Pfadangabe zu dem Zielverzeichnis -->
<property name="target" value="${basedir}/target\${ant.project.name}-V${projectversion}.${build.number}" />

Möchte man diese Variablen benutzen so schreibt man ein ${Variablenname}, dieses ist gut in der Zeile 11 zu erkennen.

Nun zur ersten Aufgabe.

Kompilieren einer Anwendung

Ein erstes Target soll die Kompilierung des Quellcodes sein, denn sollte hier schon etwas schieflaufen so brauch erst gar nicht weiter gemacht werden.

Unser Ziel bekommen den Namen „compile“.

Der Task „javac“ startet den Java Compiler mit den Parametern für die Quelle (srcdir), dem Ziel (destdir) sowie weiteren Parametern für den Classpath und der Version.

Das Attribut includeantruntime=“false“ wird benötigt da Apache Ant sonst die ant.jar mit in den Classpath hinzufügt, dieses könnte von Vorteil sein, wenn Bibliotheken verwendet werden welche sowieso ein Apache Ant zum Benutzen voraussetzen.

<target name="compile">
  <echo message="compile" />
  <javac
      srcdir="${src}"
      destdir="${target}"
      classpath="${basedir}\lib\JNativeHook.jar"
      source="1.7"
      debug="on"
      includeantruntime="false" />
</target>

Dieses Target ist noch nicht lauffähig da hier noch eventuell die Verzeichnisse fehlen, um dieses zu lösen, geben wir dem Target tag ein Attribut „depends“ welches wiederum ein Target enthält welches uns die Verzeichnisse generiert. Das Attribut „depends“ kann eine Kommaseparierte Liste mit targets enthalten, welche nacheinander ausgeführt werden.

<target name="compile" depends="createFolder">
...
</target>

<target name="createFolder">
   <echo message="compile.createFolder" />
   <mkdir dir="${target}"/>
</target>

Wenn wir nun unser Script auf der Kommandozeile ausführen erhalten wir die Ausgabe, das die Verzeichnisse erstellt werden und dass, das Projekt kompiliert wird.

Jetzt haben wir unser erstes, lauffähiges Ant Script geschrieben.
Es ist immer sinnvoll das Script mit Kommentaren zu versehen zBsp. könnte dieses dann so aussehen:

<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
<project name="TypeUpperCaseWarn" default="createAll" basedir="./.." >

    <!-- Version des Projektes -->
    <property name="projectversion" value="1.3" />

    <!-- Buildversion, wird mit jedem ausführen des Ant incrementiert -->
    <buildnumber file="${basedir}\ant\build.number"/>

    <!-- Pfadangabe zu dem Quellcode -->
    <property name="src" value="${basedir}/src" />

    <!-- Pfadangabe zu dem Zielverzeichnis -->
    <property name="target" value="${basedir}/target\${ant.project.name}-V${projectversion}.${build.number}" />

    <!-- default Aufgabe zum erstellen des Projektes sowie der JavaDoc und Checkstyle Dateien -->
    <target name="createAll" depends="compile">
		<echo message="createAll" />
    </target>

Das Arbeiten mit Kommentaren erleichtert einem später auch die Sinnhaftigkeit von Propertytags oder Targets wieder zuerkennen, auch wird, wenn ein Kommentar geschrieben wird einem klar, ob man das wirklich benötigt oder ob das ganze vielleicht zusammengefasst werden kann / soll.