Java-Entwicklung mit Ant

Transkript

1 Erik Hatcher, Steve Loughran Java-Entwicklung mit Ant Übersetzung aus dem Amerikanischen von Reinhard Engel

2 Vorwort 19 Einleitung 21 Über dieses Buch 25 Wer dieses Buch lesen sollte 25 Wie dieses Buch aufgebaut ist 26 Online-Ressourcen 28 Konventionen in diesem Buch 28 Ant-Versionen und andere Projekte 29 Author-Online 29 Über die Autoren 30 Teil 1: Ant lernen 31 Kapitel 1: Eine Einführung in Ant Was ist Ant? Was ist ein Build-Prozess und warum brauchen Sie einen? Warum halten wir Ant für ein großartiges Build-Werkzeug? Die Kernkonzepte von Ant Ein Beispielprojekt Warum sollten Sie Ant verwenden? Integrierte Development Environments Make Andere Build-Werkzeuge Schnell produktiv arbeiten Die Entwicklung von Ant Ant und Methoden zur Software-Entwicklung Extreme Programming Unser Beispielprojekt Dokumentations-Suchmaschine - Ant-Beispielprojekt 47

3 1.7 Schön und gut, aber kann Ant auch Jenseits der Java-Entwicklung Webpublishing-Engine Einfache Workflow-Engine Microsoft.Net und andere Sprachen Zusammenfassung 50 Kapitel 2: Der Einstieg in Ant Unser erstes Projekt definieren Schritt 1: Prüfen, ob die Tools einsatzbereit sind Schritt 2: Das erste Ant-Buildfile schreiben Das Buildfile analysieren Schritt 3: Den ersten Build ausführen Wenn der Build scheitert Den Build genauer analysieren Schritt 4: Struktur schaffen Die Source-Verzeichnisse strukturieren Die Build-Verzeichnisse strukturieren Die Dist-Verzeichnisse strukturieren Das Buildfile erstellen Target-Abhängigkeiten Das neue Buildfile ausführen Den Build erneut ausführen Wie Ant mehrere Targets auf der Kommandozeile verarbeitet Schritt 5: Das Programm ausführen Warum ein Programm aus Ant heraus ausführen Ein execute-target hinzufügen Das neue Target ausführen Kommandozeilenoptionen von Ant Das Buildfile angeben, das ausgeführt werden soll Den Umfang der angezeigten Informationen steuern Information über ein Projekt abfragen Das endgültige Buildfile Zusammenfassung 78 Kapitel 3: Ant-Datentypen und Properties verstehen Grundkonzepte Ein Überblick über die Datentypen Property-Überblick Die Datentypen und Properties von <javac> Pfade Filesets Fileset-Beispiele Default Excludes Pattemsets 87

4 3.6 Selektoren Die Benennung von Datentyp-Elementen Filterset Zeitstempel zur Build-Zeit in Dateien einfügen FilterChains und FilterReader. ~ Mapper Identity-Mapper Flatten-Mapper Merge-Mapper Glob-Mapper Regexp-Mapper Package-Mapper Zusätzliche Ant-Datentypen ZipFileset Dirset Filelist ClassFileset Properties Properties mit dem <property>-task setzen Warum der <property>-task etwas Spezielles ist Die Verfügbarkeit von Ressourcen prüfen: <available> Zeit durch Überspringen unnötiger Schritte sparen: <uptodate> Bedingungen testen: <condition> Properties von der Kommandozeile aus setzen Einen Build-Zeitstempel erstellen: <tstamp> Properties aus einer XML-Datei laden Ant mit Properties steuern Targets bedingt ausführen Patternsets bedingt ein- oder ausschließen Builds bedingt abbrechen Referenzen Properties und Referenzen Eingebettete Patternsets referenzieren Best Practices Zusammenfassung 119 Kapitel 4: Mit JUnit testen Refactoring DieJava-main()-Methode testen Eine Einführung in JUnit Einen Testfall schreiben 123 "4.3.2 Einen Testfall ausführen Gewünschte Ergebnisse zusichern Der Lebenszyklus eines Testfalls Eine Testsuite schreiben JUnit beschaffen und installieren Erweiterungen von JUnit 127

5 4.4 Unit-Tests auf unsere Anwendung anwenden Den Test zuerst schreiben Beim Testen externe Ressourcen nutzen DerJUnit-Task: <junit> Die Verzeichnisstruktur an das Testen anpassen JUnit in den Build-Prozess einfügen Scheitern eines Tests ist ein Scheitern des Builds Testergebnisse sammeln Mehrere Tests ausführen Einen eigenen Ergebnis-Formatierer erstellen Testergebnisberichte erstellen Berichte erzeugen und bei Testmisserfolgen ein Scheitern des Builds zulassen Einen einzelnen Testfall von der Kommandozeile aus ausführen Die Testumgebung initialisieren Andere Testprobleme Tests abkürzen Eine große Anzahl von Tests bewältigen Best Practices Zusammenfassung 147 Kapitel 5: Programme ausführen Warum Sie externe Programme ausführen müssen Java-Programme ausführen Eine Einführung in den <java>-task Den Klassenpfad setzen Argumente System-Properties definieren Das Programm in einer neuen JVM ausführen Umgebungsvariablen setzen Die neue JVM steuern Fehler mit»failonerror«behandeln JAR-Dateien ausführen Programme von Drittanbietern aufrufen Vor dem Aufruf eines Java-Programms seine Existenz prüfen Ein Timeout setzen Native Programme mit <exec> starten Umgebungsvariablen setzen Fehler behandeln Timeouts bearbeiten Shell-Befehle erstellen und ausführen Die Existenz eines Programms vor seinem Aufruf prüfen 167" 5.4 Mehrere Dateien auf einmal bearbeiten: <apply> Ausgaben verarbeiten Einschränkungen bei der Ausführung Best Practices Zusammenfassung 171

6 Kapitel 6: Projekt-Packaging Dateien verschieben, kopieren und löschen Dateien löschen Dateien kopieren Dateien verschieben Filtern Das Packaging vorbereiten Den Release-Code erstellen und dokumentieren Datendateien hinzufügen Die Dokumentation vorbereiten Installationsskripts und Dokumente vorbereiten Libraries für die Distribution vorbereiten Archivdateien erstellen JAR-Dateien EineJAR-Datei erstellen DieJAR-Datei testen EinJAR-Manifest erstellen Zusätzliche Metadaten zu der JAR-Datei hinzufügen Best Practices für JAR-Dateien JAR-Dateien signieren Zip-Dateien erstellen Eine Binär-Distribution erstellen Eine Source-Distribution erstellen Zip-Dateien vereinigen Best Practices für Zip-Dateien Tar-Dateien erstellen Webanwendungen mit WAR-Dateien erstellen Ein Package testen Zusammenfassung 201 Kapitel 7: Deployment Deployment-Beispielprobleme Die Tasks überprüfen Tools für das Deployment Tasks für das Deployment Dateiübertragung mit <ftp> Die Verfügbarkeit des Servers testen Mit <sleep> Pausen in den Build einfügen Der -Task von Ant Remote-Dateien mit <get> abrufen Die Deployment-Tasks anwenden FTP-basierte Distribution eines Anwendungs-Packages Information mit dem <input>-task abfragen basierte Distribution eines Anwendungs-Packages Ein lokales Deployment auf Tomcat 4.x 214

7 Kapitel 8: Das Tomcat Management Servlet API Mit Ant nach Tomcat deployen 216 Remote-Deployment auf Tomcat Zwischenspiel - Targets mit <antcall> aufrufen Den <antcall>-task beim Deployment verwenden 225 Das Deployment testen 226 Zusammenfassung 227 Alle Schritte zusammensetzen 229 Unsere Anwendung bis jetzt 229 Unsere eigene Ant-Task-Library erstellen 230 Gemeinsame Properties in mehreren Projekten laden 235 Abhängigkeiten bei verschiedenen Versionen bearbeiten Eine neue Library-Version installieren 240 Die Buildfile-Philosophie Denken Sie bereits am Anfang an das Ende Integrieren Sie Tests in den Build Unterstützen Sie ein automatisiertes Deployment Machen Sie Ihren Code portabel Planen Sie Anpassungsmöglichkeiten ein 243 Zusammenfassung 243 Teil 2: Ant anwenden 245 Kapitel 9: Ant für Entwicklungsprojekte einsetzen Einen Ant-basierten Build-Prozess entwerfen Ein Projekt analysieren Das Kern-Buildfile erstellen Das Buildfile ausbauen Auf Ant umsteigen Die zehn Schritte einer Migration Der Umstieg von Make-basierten Projekten Der Umstieg von IDE-basierten Projekten Große Projekte mit Master-Builds verwalten Refactoring der Buildfiles Der <ant>-task - eine Einführung Beispiel: ein grundlegendes Master-Buildfile Ein skalierbares, flexibles Master-Buildfile erstellen Die Builds von Unterprojekten verwalten Die Properties von Unterprojekten steuern Properties und Referenzen von einem Master-Buildfile erben 265 i Properties und Referenzen in <ant> deklarieren Properties mit XML-Dateifragmenten gemeinsam nutzen Targets mit XML-Dateifragmenten gemeinsam nutzen Wiederverwendbare Library-Buildfiles erstellen

8 9.7 Ein Blick voraus - wie wird die Entwicklung großer Projekte in Zukunft unterstützt? Best Practices für Ant-Projekte Libraries verwalten Prozesse implementieren Zusammenfassung 274 Kapitel 10: Jenseits der Core-Tasks von Ant Die Typen von Tasks verstehen Was also ist ein»optionaler«task? Die hauptsächlichen optionalen Tasks von Ant Warum Drittanbieter-Tasks? Optionale Tasks in Aktion Property-Dateien manipulieren Audiovisuelles Feedback zu einem Build hinzufügen Abhängigkeitsprüfungen hinzufügen Grammatiken mitjavacc parsen Reguläre Ausdrücke ersetzen Tasks zum Software Configuration Management CVS ClearCase Drittanbieter-Tasks verwenden Tasks mit <taskdef> definieren Erwähnenswerte Drittanbieter-Tasks Checkstyle Torque - objektrelationales Mapping Die»ant-contrib«-Tasks Task-Definitionen projektübergreifend nutzen Best Practices Zusammenfassung 299 Kapitel 11: XDocIet XDoclet installieren To-do-Listen generieren Die XDoclet-Architektur Die Ant-Tasks von XDoclet Templating Wie XDoclet funktioniert Ein eigenes XDoclet-Template schreiben Code-Generierung Klassenweise oder dateiweise Generierung Verarbeitete Klassen filtern Fortgeschrittene Aufgaben mit XDoclet lösen Eigene Subtasks Einen eigenen Tag-Handler erstellen

9 11.6 Die Richtung von XDoclet! XDocletim Vergleich zu C# Ein Blick in Javas Zukunft: jsr 175 und Best Practices für XDoclet Abhängigkeitsprüfungen Zusammenfassung 318 Kapitel 12: Für das Web entwickeln Welche speziellen Eigenschaften haben Webanwendungen? Mit Tag-Libraries arbeiten Eine Tag-Library erstellen Tag-Libraries integrieren Zusammenfassung der Taglib-Entwicklung mit Ant JSP-Seiten kompilieren Den <jspc>-task installieren Den <jspc>-task anwenden JSP-Seiten für das Deployment kompilieren Andere Tasks für das Kompilieren von JSP-Seiten Webanwendungen anpassen Anpassung auf der Basis eines Filtersets Deployment-Deskriptoren mit XDoclet anpassen Libraries in der WAR-Datei anpassen Statische Inhalte erzeugen Neue Inhalte erzeugen Neue Dateien erstellen Vorhandene Dateien ändern Webanwendungen mit HttpUnit testen HttpUnit-Tests schreiben Die Tests kompilieren Die Ausführung von HttpUnit-Tests von Ant aus vorbereiten Die HttpUnit-Tests ausführen Die Tests integrieren Die Grenzen von HttpUnit Canoo WebTest Serverseitiges Testen mit Cactus Cactus aus der Sicht von Ant Wie Cactus funktioniert Und jetzt unser Testfall Cactus: Zusammenfassung Zusammenfassung 355 Kapitel 13: Mit XML arbeiten Präambel: Alles über XML-Libraries XML validieren Wenn eine Datei nicht validiert wird

10 XML-DTDs auflösen Alternative XML-Validierungsmechanismen unterstützen XML mit XSLT transformieren Den XMLCatalog-Datentyp verwenden PDF-Dateien aus XML-Source generieren Styler - ein Drittanbieter-Task für Transformationen Ein XML-Buildlog erzeugen Stylesheets Ausgabedateien Das Buildlog nachbearbeiten XML-Daten in Ant-Properties laden JAXB und Castor Zusammenfassung 372 Kapitel 14: Enterprise JavaBeans EJB im Überblick Die viele Arten von Enterprise JavaBeans EJBJAR Anbieterspezifische Situationen Ein einfacher EJB-Build Die EJB-Tasks von Ant anwenden <ejbjar> verwenden Anbieterspezifische <ejbjar>-verarbeitung XDoclet für die EJB-Entwicklung verwenden XDoclet-Sübtasks von XDoclet Verschiedene Application Server mit XDoclet unterstützen Ant-Properties ersetzen Middlegen Deployment auf einem J2EE Application Server Ein vollständiges EJB-Beispiel Best Practices für EJB-Projekte Zusammenfassung 394 Kapitel 15: Mit Webservices arbeiten Was sind Webservices, und was ist SO AP? Das SOAP-API Webservices zu Java hinzufügen Eine SOAP-Client-Anwendung mit Ant erstellen 397. " Unser Buildfile vorbereiten Die Proxy-Klassen erstellen Die SOAP-Proxy-Klassen verwenden Den SOAP-Client kompilieren Den SOAP-Client ausführen Die Erstellung des SOAP-Clients überprüfen :

11 15.3 Einen SOAP-Service mit Axis und Ant erstellen Die einfache Methode, um einen Webservice zu erstellen Webservices zu einer vorhandenen Webanwendung hinzufügen Die Webanwendung konfigurieren Die Libraries hinzufügen SOAP-Services in den Build einfügen Die Existenz benötigter Klassen auf dem Server testen Den SOAP-Endpoint implementieren Unseren Webservice deployen Einen Client für unseren SOAP-Service schreiben Die WSDL importieren Die Tests implementieren Den Java-Client schreiben Was ist Interoperabilität, und warum ist sie ein Problem? Einen C#-Client erstellen Die Existenz von Klassen prüfen Die WSDL nach C# importieren Die C#-Client-Klasse schreiben Den C#-Client erstellen Den C#-Client ausführen Überblick über den C#-Client-Build-Prozess Die rigorose Methode, um einen Webservice zu erstellen Die Webservice-Entwicklung überprüfen Ant per SOAP aufrufen Zusammenfassung 425 Kapitel 16: Fortlaufende Integration Ant-Builds mit dem Betriebssystem planen Die Windows-Methode Die Unix-Version Mit Skripts arbeiten CruiseControl Wie CruiseControl funktioniert Den Build Runner starten Build-Log-Berichte Benachrichtigungen und Build-Zähler Zusammenfassung von CruiseControl Tipps und Tricks Vor- und Nachteile von CruiseControl Anthill Anthill einrichten Wie Anthill funktioniert Zusammenfassung: Anthill Gump Gump installieren und ausführen Wie Gump funktioniert Zusammenfassung: Gump

12 16.5 Ein Vergleich von Werkzeugen zur fortlaufenden Integration Zusammenfassung 446 Kapitel 17: Nativen Code entwickeln Spezielle Probleme bei nativem Code Vorhandene Build-Werkzeuge nutzen Delegation an eine IDE Mit Make arbeiten Eine Einführung in den <cc>-task Die Tasks installieren Einen Compiler hinzufügen Eine schnelle Einführung in den <cc>-task EineJNI-Library in Ant erstellen Die Schritte, um einejni-library zu erstellen Denjava-Stub schreiben Die C-H-Klasse schreiben AA Den C++-Source kompilieren Die Library testen und deployen Plattformübergreifend arbeiten Den C++-Source migrieren Das Buildfile erweitern Die Migration testen Den Code portieren Den <cc>-task ausführlicher studieren Präprozessor-Makros definieren Libaries beim Linken mit <libset> einbinden Compiler und Linker konfigurieren Linker anpassen Native Libraries distribuieren Zusammenfassung 469 Kapitel 18: Produktiver Einsatz (Deployment) Das Problem der verschiedenen Application Server Grundsätzlich verschiedenes Basisverhalten Unterschiedliches Java Runtime-Verhalten Mit verschiedenen API-Implementierungen umgehen Anbieterspezifische Libraries Deployment-Deskriptoren Serverspezifische Deployment-Prozesse Serverspezifische Verwaltung Mit den Operatoren arbeiten Anwendungsfälle für den laufenden Betrieb Operative Tests Defect Tracking beim operativen Einsatz Den operativen Betrieb in den Build-Prozess integrieren

13 18.3 Deployment-Aufgaben mit Ant lösen Arbeiten Sie mit einem einzigen Source-Baum Erstellen Sie die Archivdateien mit einem vereinheitlichten Target Ant serverseitig für ein Deployment ausführen Den Upload- und Deployment-Prozess automatisieren Eine Einführung in Deployment-Powertools von Ant Der <copy>-task Der <serverdeploy>-task Remote-Kontrolle mit <telnet> Einen Deployment-Prozess für den produktiven Einsatz erstellen Der Plan Die Verzeichnisstruktur Die Konfigurationsdateien Die Buildfiles Das Remote-Buildfile build.xml Das Buildfile für die Installation auf einem Server schreiben Auf den Remote-Server hinaufladen Das Remote-Deployment in Aktion Der Deployment-Prozess im Überblick Das Deployment auf speziellen Application Servern Tomcat 4.0 und BEA WebLogic HP Bluestone Application Server Andere Server Das Deployment verifizieren Die Zeitstempeldatei erstellen Die Zeitstempeldatei in die Anwendung einfügen Den Zeitstempel testen Best Practices Zusammenfassung 503 Teil 3: Ant erweitern 505 Kapitel 19: Ant-Tasks schreiben Was genau ist ein Ant-Task? Der einfachste Ant-Task der Welt Einen Task in demselben Build kompilieren und anwenden Der Lebenszyklus eines Tasks Ein Leitfaden für das Ant-API Task Project Path Fileset DirectoryScanner

14 EnumeratedAttribute FileUtils Wie Tasks Daten erhalten Attribute setzen Eingebettete Elemente unterstützen Datentypen unterstützen Formatfreien Body-Text zulassen Eine grundlegende Unterklasse der Ant-Task erstellen Ein Attribut zu einem Task hinzufügen Elementtext verarbeiten Mit einem Fileset arbeiten Fehlerbehandlung Ant-Tasks testen Externe Programme ausführen Prozessausgaben verarbeiten Zusammenfassung der nativen Ausführung Ein Java-Programm innerhalb eines Tasks ausführen Ein Beispiel-Task, der ein Java-Programm per Forking ausführt Beliebig benannte Elemente und Attribute unterstützen Eine Task-Library erstellen Mehrere Versionen von Ant unterstützen Zusammenfassung 538 Kapitel 20: Weitere Möglichkeiten, Ant zu erweitern Scripting innerhalb von Ant Implizite Objekte, die für <script> bereitgestellt werden Skripting-Zusammenfassung Listener und Logger Einen eigenen Listener schreiben Die Logging-Funktionen von Log4j verwenden Einen eigenen Logger schreiben MailLogger verwenden Einen eigenen Mapper entwickeln :4 Custom-Selektoren erstellen Einen Custom-Selektor in einem Build verwenden Einen Custom-Filter implementieren Einen Custom-FilterReader codieren Zusammenfassung

15 Anhang A: Installation 565 Anhang B: XML für Ant - eine kurze Einführung 573 Anhang C: IDE-Integration 577 Anhang D: Die Elemente des Ant-Stils 583 Anhang E: Die Ant-Task-Referenz 601 Anhang F: Quellen 655 Anhang G: Stichwortverzeichnis