23.4Ant
Die Arbeit eines Softwareentwicklers ist nicht immer so spannend, wie es einem die Fantasie vorgaukelt. Der Alltag besteht daraus, Code zu schreiben, aus Compilieren, Testen, Debuggen, Profiling, dem Erstellen von Dokumentationen, dem Aktualisieren von Webseiten, dem Ausliefern von Archiven und Ähnlichem. Der schlaue Zeitgenosse schreibt sich für wiederholende Aufgaben Skripte. Unter Unix wurde für die Sammlung dieser Skripte ein so genanntes make-Tool benutzt. Eine besondere Aufgabe von make war es, Zusammenhänge zwischen verschiedenen Quellcodedateien zu erkennen und dann die benötigten neu zu übersetzen. Wenn sich zum Beispiel eine Header-Datei ändert, muss auch die C‐Datei, die diese Header-Datei einbindet, neu übersetzt werden.
Unter Java können wir mit diesem make-Tool nicht so viel anfangen, doch Aufgaben wie das Erstellen von Archiven, die Neuübersetzung aller Quellen und das Erzeugen von Dokumentationen bleiben. Für diese Aufgaben wurde von der Apache-Gruppe ein Tool mit dem Namen Ant (http://ant.apache.org/) entwickelt. Der Name selbst ist ein Akronym aus Another Neat Tool. Ein weiteres populäres Produkt der Apache Software Foundation ist Maven (http://maven. apache.org/). Es geht einen Schritt weiter und bietet standardisiertes Erstellen von Anwendungen zusammen mit der jeweiligen Dokumentation und Tests für den gesamten Build-Prozess.
23.4.1Bezug und Installation von Ant
Wir erhalten ein Archiv von Ant auf den Seiten der Indianer-Gruppe, genauer gesagt unter http://ant.apache.org/bindownload.cgi. Nach dem Entpacken sollten wir unsere Umgebungsvariable (PATH) so erweitern, dass sie auf das bin/-Verzeichnis von Ant zeigt.
Wenn wir jetzt ant auf der Kommandozeile aufrufen, sollte folgende Ausgabe zu sehen sein:
Buildfile: build.xml does not exist!
Build failed
Die Installation liefert alle benötigten Bibliotheken gleich mit.
Beispielklasse, die Ant übersetzen soll
Wir begnügen uns am Anfang mit einer einfachen Java-Klasse, die Ant verwalten soll:
Listing 23.4ant/AntDemo.java
public class AntDemo {
public static void main( String[] args ) {
System.out.println( "Ant is beautiful." );
}
}
Dieses Mal soll die Quellcodedatei nicht von Hand übersetzt werden, sondern ein Ant-Skript soll dies erledigen.
23.4.2Das Build-Skript build.xml
Eine XML-Datei beschreibt, welche Schritte Ant auszuführen hat. Ant nennt die Dateien Build-Files, und eine solche Datei heißt oft build.xml. Wir wollen sie in das gleiche Verzeichnis stellen, in dem auch unsere Java-Quellcodedatei steht:
Listing 23.5build.xml
<project name="Insel" default="build" basedir=".">
<target name="build">
<javac srcdir="." />
</target>
</project>
Eine DTD-Referenzierung ist für die XML-Datei nicht zwingend nötig, da der Parser die Datei nicht validierend abarbeitet. Der Eintrag <project> definiert das Projekt unter dem Namen Insel. Das Attribut default definiert weiterhin, dass der einfache Aufruf von Ant automatisch das Ziel build aufrufen soll.
23.4.3Build den Build
Im Inneren des Eintrags <project> folgen <target>-Einträge. Wir definieren das Ziel build, das den Compiler starten soll. Das übernimmt der Task <javac>, der alle Dateien compiliert, die sich im aktuellen Verzeichnis befinden. Neben <javac> stellt Ant eine große Zahl zusätzlicher Tasks bereit. Wechseln wir auf der Kommandozeile in das Verzeichnis mit den Dateien, dann reicht es, Ant aufzurufen, und der Konstruktionsprozess beginnt. Ant sucht selbstständig nach der Datei build.xml. Folgendes erscheint:
Buildfile: build.xml
build:
[javac] Compiling 1 source file
BUILD SUCCESSFUL
Die Option -verbose gibt zusätzliche Informationen über den Entstehungsprozess aus. Die Datei build.xml lässt sich vielfältig anpassen. Nehmen wir uns den Eintrag <javac> noch einmal vor, und erweitern wir ihn zu:
Das weist Ant an, während der Übersetzung zu optimieren und Debug-Informationen mit aufzunehmen. Das Attribut includes befiehlt, nicht nur Quellcodedateien des aktuellen Verzeichnisses zu übersetzen, sondern auch alle Dateien aller Unterverzeichnisse. Die Notation **/ ist eine Vereinfachung, die für alle Unterverzeichnisse steht. An ihrer Stelle ist auch eine Aufzählung der Verzeichnisse zulässig.
23.4.4Properties
Eine gute Idee ist es, sich von den konkreten Pfaden im <javac>-Element zu lösen, denn Ant erlaubt es, Eigenschaften zu definieren, die Platzhaltern oder Makros ähneln. Um Programme aus einem Verzeichnis (nennen wir es src) in ein Zielverzeichnis (nennen wir es build) zu übersetzen, schreiben wir:
<property name="build" value="build" />
<target name="compile" depends="init">
<javac srcdir="${src}" destdir="${build}" />
</target>
Bisher haben wir uns mit der Übersetzung beschäftigt. Dennoch wissen wir, dass wir auch noch andere target-Elemente verwenden können. Und obwohl die Benennung dieser Targets prinzipiell willkürlich ist, gibt es eine vorgeschlagene Namenskonvention:
Eintrag | Bedeutung |
---|---|
init | Erstellt Verzeichnisse und Initialisierungsdateien. |
build | inkrementeller Aufbau |
test | Ablaufen der Tests mit JUnit |
clean | Ausgabeverzeichnisse löschen |
deploy | *.jar, *.war und sonstige Archive erstellen |
publish | Veröffentlichen der Ergebnisse |
fetch | Bezieht Quellcodedateien aus der Versionsverwaltung. |
docs, javadocs | Erstellt die Dokumentation. |
all | Abfolge von clean, fetch, build, test, docs, deploy |
main | Erstellt das Projekt, in der Regel build oder build, test. |
Tabelle 23.1Namenskonvention für Targets
Der Eintrag init soll eine initiale Verzeichnisstruktur aufbauen. Nehmen wir an, der Compiler soll in unser oben genanntes Verzeichnis build übersetzen. Dann muss dieses Verzeichnis natürlich existieren. Das Anlegen des Verzeichnisses kann in init geschehen:
<mkdir dir="${build}" />
</target>
Um die erstellten Verzeichnisse in einem Target clean zu löschen, wollen wir eine Property dist für das Distributionsverzeichnis hinzunehmen:
<delete dir="${build}" />
<delete dir="${dist}" />
</target>
23.4.5Externe und vordefinierte Properties
Falls sich das Versionsrad eine Nummer weiter dreht, ist es ungünstig, wenn Änderungen an der XML-Datei vorzunehmen sind. Eine gute Lösung für das Problem besteht darin, eine externe Datei anzugeben, die die Version definiert. Das kann so aussehen:
Listing 23.6version.properties
Jetzt fehlt nur noch der Bezug zu dieser Eigenschaften-Datei in der XML-Datei. Bisher kennen wir zwar einen Eintrag property name und value, aber eine zweite Variante mit dem Attribut file bindet eine Datei ein, die Schlüssel-Wert-Paare wie bei unserer version.properties beschreibt:
Jetzt lässt sich auf die Variable version ganz normal zugreifen, um zum Beispiel eine zweite Eigenschaft einzuführen:
version ist unsere Variable, und ${version} setzt den Inhalt der Variablen ein. Daneben gibt es aber noch einige Standard-Properties:
Property | Bedeutung |
---|---|
Basedir | absoluter Pfad zum Basisverzeichnis des Projekts; in basedir gesetzt |
ant.file | absoluter Pfad der Build-Datei |
ant.version | Version von Ant |
ant.project.name | Name des Projekts, wie in <project> gesetzt |
ant.java.version | JVM-Version, wie von Ant entdeckt, etwa »1.6« |
Tabelle 23.2Standard-Properties
23.4.6Weitere Ant-Tasks
Ant kann Programme mit automatischen Tests mit JUnit überprüfen, Klassendateien zu einem Archiv zusammenbinden oder E-Mails verschicken. Die Archive lassen sich automatisch auf einen FTP-Server übertragen. Für Ant gibt es viele Tasks; http://ant.apache.org/manual/tasksoverview.html gibt einen Überblick. Die wichtigsten Tasks sind:
Ant-Task | Aufgabe |
---|---|
javac | Übersetzt mit Java-Compiler. |
jar | Bündelt Dokumente in ein Java-Archiv. |
manifest | Erzeugt eine Manifest-Datei. |
signjar | Signiert ein Java-Archiv. |
unjar | Packt Java-Archive aus. |
javadoc | Erzeugt die Java-Dokumentation. |
exec | Startet ein externes Programm. |
copy | Kopiert Dateien. |
mkdir | Legt ein Verzeichnis an. |
move | Verschiebt Dateien. |
echo | Schreibt Ausgaben auf die Konsole. |
sql | Sendet SQL-Anweisungen zur Datenbank. |
javah | Erzeugt C-Header-Dateien für JNI. |
junit | Arbeitet JUnit-Tests ab. |
Tabelle 23.3Ausgewählte Ant-Tasks
Neben Tasks spielen FileSets eine wichtige Rolle. Sie bilden Gruppen von Dateien. Die Gruppen werden nach bestimmten Kriterien gebildet, etwa nach der Dateiendung. Folgendes FileSet umfasst alle Java-Quellcodedateien, schließt aber alle Testdateien aus, die sich in Unterverzeichnissen ausgehend von der Angabe des Wurzelpfades über der Property src befinden:
<include name="**/*.java"/>
<exclude name="**/*Test*"/>
</fileset>
[zB]Beispiel
Das ClassFileSet (http://ant.apache.org/manual/Types/classfileset.html) ist ein besonderes FileSet, das nicht einfach alle Dateien von Verzeichnissen auswählt, sondern durch Bytecode-Analyse herausfindet, welche Abhängigkeiten es wirklich gibt. So gelangen nur die Klassendateien in die Gruppe, die vom angegebenen Wurzelelement referenziert werden.