Verteilte Systeme (WS 2013/14) Übung 0: Einführung in Maven und Git. Oliver Kleine Institut für Telematik, Universität zu Lübeck

Transkript

1 Verteilte Systeme (WS 2013/14) Übung 0: Einführung in Maven und Git Oliver Kleine Institut für Telematik, Universität zu Lübeck

2 Build-Management in JAVA

3 3 Build-Management? Wozu? Traditionelle manuelle Eingabe von Kommandos auf der Konsole: Verzeichnisstruktur anlegen für Sourcefiles Kompilierte Classfiles JAR(s) Sourcen kompilieren JAR erzeugen Classfiles / JARs löschen (clean) Testen Javadoc erstellen Es existieren Werkzeuge zur Automatisierung dieser Prozesse (z.b. Apache ant)

4 Apache ant Apronym für Another Neat Tool Aufteilung des Build-Prozesses in targets, z.b. init (erstellen der Verzeichnisstruktur) compile (kompilieren der Sourcefiles) dist (erstellen der Distribution (jar-file(s)) clean (löschen der Classfiles, JAR(s) doc (erstellen von Javadoc) Targets können voneinander abhängen compile ist abhängig von init beim Aufruf von compile wird zunächst automatisch init ausgeführt Konsole: ant targetname (z.b. ant compile)

5 Definition von Targets Targets bestehen aus einem oder mehreren tasks Abarbeitung der tasks in definierter Reihenfolge Tasks Ant enthält bereits viele eingebaute tasks z.b. mkdir, javac, clean Konkrete Definition erfolgt über XML (i.d.r. build.xml)

6 Beispiel für eine build.xml 6

7 7 Zuerst JAR bauen ( ant dist ) Dann testen ( ant test )

8 Dann Javadoc erzeugen ( ant doc ) 8

9 Apache Maven Maven can manage a project's build, reporting and documentation from a central piece of information. ( Im Unterschied zu Ant deklarativ Ant: Befehl für Befehl vorgeben (in build.xml) Maven: WAS soll passieren (aber nicht WIE)!

10 Feste Ordnerstruktur für Maven- Projekte: Quelltext der Anwendung

11 Was ist die pom.xml? Akronym für Project Object Model deklarative Beschreibung des Projekts, z.b. Projektbeschreibung Was ist zu tun? Kompilieren und als JAR Datei packen

12 Wie erzeugt man ein neues Maven Projekt? Kaum manueller Aufwand dank Mavens Archetypes-Plugin Archetypes definieren u.a. initiale Verzeichnisstruktur initiale pom.xml ggf. initiale Sourcefiles (-Skeletons) Kommando mvn archetype:generate öffnet Archetype-Auswahl und Konfiguration erstellt initiales Projekt

13 Was ist mit dem Classpath? Abhängigkeiten (Dependencies) zu anderen Projekten Definition in der pom.xml als Tripel <GroupID, ArtifactID, Version> Tripel definiert ein artifact (= Datei im Maven-Repository) Automatisch erfolgt der Download der notwendigen artifacts in lokales Repository das Hinzufügen zum Class-/Buildpath Lokales Maven-Repository für externe artifacts (heruntergeladen von Maven-Repositories im Internet) selbst erstellte artifacts aus eigenen Projekten (z.b. mittels mvn install )

14 Dependency Management Vollständige Auflösung von Abhängigkeiten Artifacts, von denen das eigene Projekt abhängt Abhängigkeiten von Artifacts, von denen das eigene Projekt abhängt usw. bis alles aufgelöst ist Beispiel für ein größeres Projekt (tr.runtime.wsn-app):

15 Beispiel: Log-Ausgaben mit log4j Vermeidung von System.out.println( ); Bekanntes Projekt: Apache log4j Verschiedene Log-Level logger.debug( Nachricht ); logger.info( Nachricht ); logger.warn( Nachricht ); logger.error( Nachricht ); logger.fatal( Nachricht ); Das wollen wir jetzt in unserem Projekt benutzen Abhängigkeit zu log4j muss definiert werden.

16 Wo findet man denn die log4j.jar?

17 Wie definiert man diese Abhängigkeit dann in der pom.xml? Abhängigkeiten zu anderen Projekten

18 Etwas Theorie: Die 3 Maven Build-Lifecycle Lifecycle besteht aus Phasen validate Default-Lifecyle Phasenauswahl siehe Grafik deploy initialize Clean-Lifecycle pre-clean, clean, post-clean install Default-Lifecycle compile Site-Lifecycle pre-site, site, post-side, site-deploy verify testcompile Kommando mvn <phasex> startet Build- Prozess Sequentielle Abarbeitung der Phasen im entsprechenden Lifecycle bis phasex z.b. mvn compile: validate initialize compile package test

19 Und wie werden nun Phasen definiert? Phasen bestehen aus Goals (sind aber zunächst leer) Goals sind konkrete vordefinierte Aufgaben werden an eine oder mehrere Phasen gebunden 1. durch Definition des packaging in pom.xml z.b. <packaging>jar</packaging> 2. durch Maven-Plugins z.b. maven-compiler-plugin» bindet Goal compiler:compile an Phase compile (Kompilieren der Applikations-Sourcefiles)» bindet Goal compiler:testcompile an Phase test-compile (Kompilieren der Test-Sourcefiles) Maven definiert Standard-Plugins in Super POM

20 Package erzeugen (hier: JAR) mit mvn package Download von log4j jar aus einem Maven Repository

21 Package erneut erzeugen: mvn package Kein erneuter Download von artifacts (sind bereits im lokalen Repository)! Applikations- Sourcefiles kompilieren JAR-erzeugen

22 Kompilieren der Anwendung: mvn compile

23 Generierte Dateien löschen: mvn clean

24 Einbinden externer Repositories Nicht alle Abhängigkeiten können über Maveneigene Repositories aufgelöst werden Definition externer Repositories in pom.xml

25 Beispiel: JBoss Netty Definition des Repository Definition der Abhängigkeit als artifact

26 Maven-Integration in IDEs Eclipse Plugin erforderlich (m2eclipse) Update Site: NetBeans und IntelliJ integrieren Maven-Support von Haus aus

27 27 Literatur Entwurfsmuster. Elemente wiederverwendbarer objektorientierter Software Erich Gamma, Richard Helm, Ralph E. Johnson, John Vlissides, Addison Wesley, München 2004, ISBN Design Patterns. Elements of Reusable Object-Oriented Software Erich Gamma, Richard Helm, Ralph Johnson, John Vlissides, Addison Wesley, 1995, ISBN (englisch) How to Write Doc Comments for the Javadoc Tool Doxygen documentation system Für C++, C, Java, Objective-C, Python, IDL, Fortran, VHDL, PHP, C#, D Ant Maven

28 Source-Code-Verwaltung mit Git

29 Git-Features Dezentrales, verteiltes System Alles passiert lokal: git clone kopiert komplette Repositories inkl. der kompletten Historie in lokales Repository Parallele Entwicklungszweige (Branches) Entwicklung neuer Features ohne funktionierendes zu beeinflussen git checkout <branchname> zum wechseln des Branch Remote Repository zum veröffentlichen Einschränkung des Zugriffs möglich Push: Export vom eigenen lokalen zu anderem Repository Fetch: Import vom anderen ins eigene lokale Repository Einfache lokale Zusammenführung von Branches (merge) Staging area als Zwischenstufe zwischen Working Directory und lokalem Repository

30 Git: Basic workflow Entferntes Repository in ein lokales klonen git clone cd testbed-runtime git branch > master * ('*' kennzeichnet den aktiven Branch) > [...] Editere einige Dateien und prüfe, wo sich etwas geändert hat git add (Hinzufügen zur Staging Area) git status Änderungen von der Staging Area ins lokale Repository übernehmen git commit -a -m Beschreibung der Änderungen Übertrage die Änderungen vom lokalen (origin) ins entfernte (master) Repository git push origin master

31 31 Literatur Git-Website: Einführung für SVN-Benutzer: