Das Build Tool Ant. Sebastian Mancke,

Transkript

1 Das Build Tool Ant Sebastian Mancke,

2 Grundlagen Motivation Bei der Übersetzung und Pflege von Software treten viele, gleich bleibende Arbeitsschritte auf. Übersetzen des Codes Dokumentation generieren Distribution zusammenpacken Temporäre Dateien löschen Eine Automatisierung dieser Abläufe liegt nahe. Das Build Tool Ant, Sebastian Mancke 1

3 Grundlagen Ant als Plattform unabhängiges make Für die Automatisierung des Build Vorganges von C und C++ haben sich Tools wie make, gnumake und nmake schon lange etabliert. Die vorhandenen Lösungen setzen sehr stark auf eine Shell auf und sind damit nicht völlig Plattform unabhängig. Die Apache Group hat ein Tool entwickelt, das auf Java und XML aufbaut. Es ist vor allem für Java Projekte geeignet: ANT Das Build Tool Ant, Sebastian Mancke 2

4 Grundlagen Installation Ant benötigt nicht viele Voraussetzungen: Das Build Tool Ant, Sebastian Mancke 3

5 Grundlagen Installation Ant benötigt nicht viele Voraussetzungen: Java muss installiert sein. Das Build Tool Ant, Sebastian Mancke 3

6 Grundlagen Installation Ant benötigt nicht viele Voraussetzungen: Java muss installiert sein. Das bin Verzeichnis der Ant Distribution mit.bat und Shell Scripten muss im Pfad sein. Das Build Tool Ant, Sebastian Mancke 3

7 Grundlagen Targets (1) Um Aufgaben ab zu arbeiten benötigt Ant Verarbeitungsregeln. Sie werden Targets genannt und werden in einem XML Buildfile definiert. Ant sucht dazu nach./build.xml oder der mit der Option -buildfile angegebenen Datei. Aufruf: ant target1 target2 target3.. Der Aufruf von Ant ohne Argumente startet ein Default Target. Das Build Tool Ant, Sebastian Mancke 4

8 Grundlagen Targets (2) Eine Auflistung aller möglichen Targets samt Beschreibung liefert: ant -projecthelp Die Befehle von Ant arbeiten intelligent: Bei einem erneuten Aufruf aktualisieren sie nur das, was sich geändert hat. Das Build Tool Ant, Sebastian Mancke 5

9 Grundlagen Aufbau des Buildfile <? xml version ="1.0" encoding =" ISO " standalone =" yes "?> < project name =" meinprojekt " default =" target2 " basedir ="."> <!-- Property Definitionen --> < property file =" build. properties "/> < property name =" key " value =" value "/> <!-- Pfad Definitionen --> < path id =" compile. classpath ">.. </ path > <!-- Target Definitionen --> < target name =" target1 " description =" Beschreibung von t1 "/>.. </ target > < target name =" target2 " depends =" target1 "/> </ project > Das Build Tool Ant, Sebastian Mancke 6

10 Grundlagen Aufbau eines Targets Die Targets bestehen aus einer Abfolge von Befehlen mit Optionen und Argumenten in XML. Diese Befehle werden Tasks genannt. < target name =" compile " depends =" prepare " descriptionü=" bersetzen von./ src nach./ build "> < mkdir dir ="./ build "/> < javac srcdir =" src " destdir ="./ build / classes " debug =" true "> < classpath refid =" compile. classpath "/> </ javac > </ target > Das Build Tool Ant, Sebastian Mancke 7

11 Grundlagen Pfade und Dateimuster Um einen Befehl auf eine Auswahl von Dateien anzuwenden gibt es path, pathelement, fileset und patternset Elemente: < path id =" compile. classpath "> < fileset dir ="./ lib "> < include name ="*. jar "/> < exclude name =" old - lib. jar "/> </ fileset > < pathelement location ="./ src "/> < fileset dir ="./ modules "> < patternset refid =" special. patternset "/> </ fileset > </ path > Das Build Tool Ant, Sebastian Mancke 8

12 Tasks Es gibt drei Arten von Tasks: Das Build Tool Ant, Sebastian Mancke 9

13 Tasks Es gibt drei Arten von Tasks: Eine Menge wichtiger Tasks sind direkt in Ant integriert. Einige werden im Folgenden gezeigt. Das Build Tool Ant, Sebastian Mancke 9

14 Tasks Es gibt drei Arten von Tasks: Eine Menge wichtiger Tasks sind direkt in Ant integriert. Einige werden im Folgenden gezeigt. Optionale Taskbibliotheken, die leicht eingebunden werden können. Das Build Tool Ant, Sebastian Mancke 9

15 Tasks Es gibt drei Arten von Tasks: Eine Menge wichtiger Tasks sind direkt in Ant integriert. Einige werden im Folgenden gezeigt. Optionale Taskbibliotheken, die leicht eingebunden werden können. Um völlig flexibel sein zu können, gibt es die Möglichkeit in Java eigene Tasks zu schreiben. Das Build Tool Ant, Sebastian Mancke 9

16 Java Compiler Übersetzen von Java Quellen: < javac srcdir ="./ srcdir " destdir ="./ builddir " includes =" mypackage /p1 /**, mypackage /p2 /**" excludes =" mypackage / p1/ testpackage /**" classpath =" xyz. jar " debug =" on" /> Verzeichnisse und Classpath können auch global definiert und hier referenziert werden. Das Build Tool Ant, Sebastian Mancke 10

17 Dateiverwaltung Anlegen eines Verzeichnisses: < mkdir dir ="./ verzeichnisname /"/> Das Build Tool Ant, Sebastian Mancke 11

18 Dateiverwaltung Anlegen eines Verzeichnisses: < mkdir dir ="./ verzeichnisname /"/> Löschen: < delete file ="/ lib / ant. jar "/> oder : < delete dir ="./ build "/> oder : < delete > < fileset dir ="." includes ="**/*. bak "/> </ delete > Das Build Tool Ant, Sebastian Mancke 11

19 Kopieren einer Datei: Dateiverwaltung < copy file =" myfile. txt " tofile =" mycopy. txt "/> Das Build Tool Ant, Sebastian Mancke 12

20 Kopieren einer Datei: Dateiverwaltung < copy file =" myfile. txt " tofile =" mycopy. txt "/> Kopieren eines Verzeichnisses: < copy todir ="../ new / dir "> < fileset dir =" src_dir "/> </ copy > Das Build Tool Ant, Sebastian Mancke 12

21 Kopieren einer Datei: Dateiverwaltung < copy file =" myfile. txt " tofile =" mycopy. txt "/> Kopieren eines Verzeichnisses: < copy todir ="../ new / dir "> < fileset dir =" src_dir "/> </ copy > Kopieren einer Auswahl: < copy todir ="../ dest / dir " > < fileset dir =" src_dir " > < exclude name ="**/*. java "/> </ fileset > </ copy > Das Build Tool Ant, Sebastian Mancke 12

22 Java Starten Mit dem java Task kann eine Klasse innerhalb der Ant JVM oder in einem eigenen Prozess gestartet werden: < java classname =" test. Main " > < arg value ="- h "/> < classpath > < pathelement location ="./ lib / test. jar "/> </ classpath > </ java > Das Build Tool Ant, Sebastian Mancke 13

23 Weitere Tasks Auflistung weiterer Tasks (auswahl): Ant: Target aus anderem Buildfile aufrufen Cvs: CVS Komandos Exec: Beliebiges Systemkomando Get: URL holen GZip: Packen Jar: Packen Javadoc: Doku generieren Mail: SMTP Mail Versandt Patch: Patchen einer Datei Replace: Textersetzung in einer Dateiauswahl Sql: SQL Kommandos über JDBC Das Build Tool Ant, Sebastian Mancke 14

24 Eigene Tasks definieren Selbst Tasks für Ant zu schreiben ist recht einfach. Das Build Tool Ant, Sebastian Mancke 15

25 Eigene Tasks definieren Selbst Tasks für Ant zu schreiben ist recht einfach. 1. Eine Klasse muss org.apache.tools.ant.task erweitern. Das Build Tool Ant, Sebastian Mancke 15

26 Eigene Tasks definieren Selbst Tasks für Ant zu schreiben ist recht einfach. 1. Eine Klasse muss org.apache.tools.ant.task erweitern. 2. Es muss eine entsprechende Methode zum Setzen der Attribute bzw. der eingebetteten Elemente existieren. Das Build Tool Ant, Sebastian Mancke 15

27 Eigene Tasks definieren Selbst Tasks für Ant zu schreiben ist recht einfach. 1. Eine Klasse muss org.apache.tools.ant.task erweitern. 2. Es muss eine entsprechende Methode zum Setzen der Attribute bzw. der eingebetteten Elemente existieren. 3. Die Klasse muss eine public void execute Methode für die eigentliche Aktion haben. Das Build Tool Ant, Sebastian Mancke 15

28 Eigene Tasks definieren Selbst Tasks für Ant zu schreiben ist recht einfach. 1. Eine Klasse muss org.apache.tools.ant.task erweitern. 2. Es muss eine entsprechende Methode zum Setzen der Attribute bzw. der eingebetteten Elemente existieren. 3. Die Klasse muss eine public void execute Methode für die eigentliche Aktion haben. Um das Task zu benutzen muss dieses im Buildfile durch ein taskdef Element Deklariert werden und im Classpath sein. Das Build Tool Ant, Sebastian Mancke 15

29 Einstellungen über Properties Um Buildfiles flexibel zu halten ist es möglich für alles, was sich ändern kann, Properties zu verwenden. Properties sind ähnlich wie Variablen, können aber nur einmal gesetzt werden. Direkte Definition: < property name =" build. dir " value ="./ build. classes "/> In externer Datei: < property file =" build. properties "/> Benutzt werden sie wie Variablen in der Shell: < delete dir ="${ build. dir }"/> Das Build Tool Ant, Sebastian Mancke 16

30 Geschachtelte Builds Bei großen Projekten kann es Sinn machen, für einzelne Teilen separate Buildfiles zu verwenden. Diese können dann einzeln aufgerufen, oder von einem globalen Buildfile gesteuert werden. Dabei werden die Properties des Aufrufenden geerbt. Das kann zu Problemen führen, da diese nur einmal eine Zuweissung bekommen und nicht wieder überschieben werden können. Das Build Tool Ant, Sebastian Mancke 17

31 Integration in andere Wergzeuge Nicht nur im Open Source Bereich ist Ant dabei, sich als Java Build Tool durchzusetzen. Daher wird Ant mittlerweile von einer Reihe von Tools und IDE s unterstützt: Für Eclipse gibt es eine freie Erweiterung eclipse-antview, die den integrierten Ant Wizard erweitern soll. NetBeans bietet vollen Ant support: Integration vorhandener Buildfiles und Unterstützung bei deren Erstellung. Das JDE Modul für den (X)Emacs ermöglicht den Build mit Ant. Das Build Tool Ant, Sebastian Mancke 18

32 Links und Doku jakarta.apache.org/ant/ - Apache Ant Homepage mit guter Doku sourceforge.net/projects/eclipse-antview/ - Ant Erweiterung für Eclipse jde.sunsite.dk - Jde Module für den (X)Emacs Das Build Tool Ant, Sebastian Mancke 19