Maven 3 - Konfigurationsmanagement mit Java - mitp.de ? 27 Kapitel 2 Maven im berblick Dieses Kapitel

  • Published on
    18-Jul-2018

  • View
    212

  • Download
    0

Transcript

  • Maven 3Konfi gurationsmanagement mit Java

    Auerdem bei mitp:

    Aus dem Inhalt:

    Lifecycles

    POM Das Project Object Model

    Dependencies

    Projektbeziehungen

    Repositories

    Plugins ausfhren

    Properties und Filtering

    Profi le

    Source Code Management

    Software verffentlichen

    Plugins schreiben

    Maven und Eclipse

    Reporting und Dokumentation

    Qualittsmanagement

    Apache Archiva und Apache Continuum

    Konfi gurationsdateien

    Referenzen

    Maven ist ein Build- und Konfigurationsmanagement-Tool der Apache Software Foundation und basiert auf Java. Mit Maven lassen sich Java-Projekte standardisiert erstellen und verwalten. Ziel ist die Automatisierung und Vereinfachung immer wieder anfallender Aufgaben.

    Der Autor erlutert die grundlegenden Konzepte und Module von Maven und zeigt, wie diese im Projektall-tag eingesetzt werden knnen. Das Buch richtet sich an Softwareentwickler und -architekten, an technische Projektleiter und alle, die sich mit Konfigurationsma-nagement beschftigen.

    Zunchst gibt der Autor einen Schnelleinstieg in Maven und erlutert die elementaren Befehle und Konfigura-tionsschritte, so dass Sie sofort erste Projekte mit Maven erstellen und bearbeiten knnen. Die folgenden Kapi-tel vermitteln die grundlegenden Konzepte und Prin-zipien z.B. zu Verzeichnis- und Namenskonventionen, Lifecycles, Dependencies, Projektbeziehungen und zum Projektmodell. Alle weiteren Kapitel behandeln einzel-ne Themen, die im Verlaufe eines Projektes eine Rolle spielen knnen wie u.a. Repositories, Plugins, das Ver-ffentlichen von Software, Reporting und Dokumenta-tion sowie Qualittsmanagement. So erhalten Sie einen umfassenden Einblick in Maven.

    Dieses Buch eignet sich sowohl als Einfhrung als auch als Referenz und Arbeitsbuch fr die tgliche Praxis.

    ber den Autor:Martin Spiller ist Diplom-Mathematiker und arbeitet als Softwareentwickler und Berater im Java-Umfeld fr die neusta GmbH. Seine Schwerpunkte sind Software-qualitt, Konfigurationsmanagement und Performance-Tuning.

    (D)

    29

    ,95

    Lifecycles, Dependencies, Projektbeziehungen

    Repositories, Plugins, Properties und Filtering

    Profi le, Reporting, Dokumentation, Qualittsmanagement

    ISBN 978-3-8266-9118-8ISBN 978-3-8266-9118-8

    Spill

    erM

    aven

    320 mm

    ISBN 978-3-8266-9066-2

    ISBN 978-3-8266-9046-4

    Martin Spiller

    ISBN 978-3-8266-5548-7

    Konfi

    gur

    atio

    nsm

    anag

    emen

    t m

    it Ja

    va

    978-3-8266-9118_umschlag03.indd 1-3 7/12/2011 11:06:46 AM

  • 27

    Kapitel 2

    Maven im berblick

    Dieses Kapitel beschreibt, wie Maven installiert und ein erstes Projekt erstelltwird. Anhand dieses Projekts werden die wichtigsten Maven-Aufrufe gezeigt. Aufdie detaillierte Beschreibung in spteren Kapiteln wird entsprechend verwiesen.

    2.1 Was ist Maven?

    Maven ist ein deklaratives Build Management System. Das heit, es wird lediglichder Inhalt des Projekts beschrieben, nicht die Struktur oder die Ablufe, die zurKompilierung und Verffentlichung notwendig sind. Die Philosophie hinterMaven heit Konvention ber Konfiguration Strukturen mssen nicht definiertwerden, sondern sind vorgegeben. So wie die Projekt- und Verzeichnisstruktur istauch die Reihenfolge der Arbeitsschritte vorgegeben, die Maven ausfhrt, um einProjekt zu bauen. In der pom.xml von Maven 2.0.9 beschreiben die EntwicklerMaven so:

    Maven is a project development management and comprehension tool. Basedon the concept of a project object model: builds, dependency management,documentation creation, site publication, and distribution publication are allcontrolled from the declarative file. Maven can be extended by plugins to utilisea number of other development tools for reporting or the build process.

    2.1.1 POM

    Maven verwendet ein Projektmodell (POM Project Object Model), um Abhngig-keiten, Projektumgebung und Projektbeziehungen zu speichern. Das Projektmo-dell wird in der Datei pom.xml gespeichert und ist vererbbar.

    Hinweis

    Maven verwendet fr alle Aufgaben Plugins, die beim ersten Aufruf aus demNetz geladen werden mssen. Wundern Sie sich also nicht, wenn die ersten Auf-rufe etwas lnger dauern. Da das Herunterladen der Bibliotheken auf der Kon-sole protokolliert wird, gehen beim ersten Aufruf eines Befehls die wesentlichenInformationen schnell unter. Rufen Sie zur Not den Befehl einfach noch mal auf.Gegebenenfalls rufen Sie vorher mvn clean auf, um generierte Dateien zulschen.

    Maven_9118-8.book Seite 27 Dienstag, 12. Juli 2011 4:43 16

    http://www.mitp.de/9118

  • Kapitel 2Maven im berblick

    28

    2.1.2 Lebenszyklen

    Die Entwickler von Maven gehen von immer wiederkehrenden Ablufen in Pro-jekten aus, die in so genannten Lebenszyklen (Lifecycles) abgebildet werden. DerStandardzyklus ist der Build-Lifecycle, der aus einer festen Abfolge von Phasenbesteht. Die einzelnen Phasen knnen mit Plugins verknpft werden, die mit derPhase ausgefhrt werden. Wird eine Phase aufgerufen, zum Beispiel test, wer-den alle Phasen des Zyklus, die vor test liegen, abgearbeitet. Das heit, um Testsauszufhren, werden immer alle notwendigen Schritte ausgefhrt:

    1. Kompilieren des Produktivcodes

    2. Kompilieren des Testcodes

    3. Ausfhren der Tests

    2.1.3 Vereinfachtes Build-Management

    Durch die Verwendung einheitlicher Verzeichnisstrukturen ist es einfach, in Pro-jekte einzusteigen, die mit Maven verwaltet werden. Der Build-Lifecycle kapselt dieeinzelnen Phasen, die langwierige Analyse von Makefiles oder Build-Skripten, umherauszufinden, welcher Befehl als Erstes aufgerufen werden muss, entfllt.

    2.1.4 Trennung von Code und Unit-Tests

    Maven trennt den produktiven Projektcode physisch vom Code der Unit-Tests. DieCode-Basen liegen parallel in unterschiedlichen Quell-Verzeichnissen und diekompilierten Klassen werden in unterschiedlichen Verzeichnissen verwaltet.Genauso sind die Konfiguration der Unit-Tests und die dazugehrigen Ressourcenvom restlichen Code getrennt.

    2.1.5 Verwaltung von Abhngigkeiten

    Maven verwendet ein einziges lokales Verzeichnis, genannt Repository, in demBibliotheken zentral fr alle Projekte abgelegt werden. Bentigte Bibliothekenwerden selbststndig ins lokale Repository kopiert und aktualisiert. Damit erbrigtsich die Notwendigkeit, in Projekten Bibliotheken in das Versionskontrollsystemeinchecken zu mssen. Transitive Abhngigkeiten, also die Abhngigkeiten vonAbhngigkeiten, werden selbststndig analysiert und aufgelst. Unter Maven ist esdaher sehr einfach, Bibliotheken auszutauschen. Auch das Entfernen von Abhn-gigkeiten aus Projekten wird deutlich einfacher: Verschwindet die Abhngigkeit,verschwinden auch die transitiven Abhngigkeiten. Es bleiben keine Dateileichenzurck.

    Maven_9118-8.book Seite 28 Dienstag, 12. Juli 2011 4:43 16

    http://www.mitp.de/9118

  • 2.2Voraussetzungen

    29

    2.1.6 Artefakte

    Maven beschreibt genau genommen keine vollstndigen Projekte, sondern Arte-fakte: eigenstndige Teile eines Projekts, die einzeln ausgeliefert werden knnen.In kleinen Projekten lsst sich das gesamte Projekt mit einem einzigen Artefaktbeschreiben. Ein Artefakt wird durch eindeutige Koordinaten beschrieben, die imPOM abgelegt sind. Jedes Maven-Projekt erzeugt ein Artefakt.

    2.1.7 Informationen zu Codequalitt und Projektzustand

    Mit Maven lassen sich Reports und Projektinformationen generieren, die in einerProjektwebseite zusammengefasst werden. Hierzu gehren unter anderem:

    API-Dokumentation

    Unit-Test-Ergebnisse und Testabdeckung

    Changelogs des Versionskontrollsystems

    Liste der Abhngigkeiten

    Reports zur Codequalitt durch Tools wie PMD, Checkstyle und FindBugs

    Informationen zu Bug-Tracking, Mailing-Listen und Continuous Integration

    Verwendete Bibliotheken und deren Benutzung

    2.2 Voraussetzungen

    2.2.1 Betriebssystem

    Maven luft auf Windows-Systemen ab NT, Mac OS X- und Linux-Systemen. Per-snlich verwendet habe ich Maven auf Windows 2000 (SP4), XP (SP2 und 3), sowieSUSE Linux 9 und Ubuntu 7.x und 8.x.

    2.2.2 JDK

    Maven bentigt zur Ausfhrung ein JDK ab Version 1.5. Es ist aber mglich, mitMaven auch Java-Projekte fr ltere JDKs zu verwalten. Die UmgebungsvariableJAVA_HOME muss auf das Java-Installationsverzeichnis verweisen.

    2.2.3 Speicherplatz

    Arbeitsspeicher

    Es ist keine Mindestanforderung fr Arbeitsspeicher angegeben. Mit den heuteblichen Speichergren sollte es auch keine Probleme geben. Maven 2.0.9 liefauf einem Ubuntu 7.04-System mit 512 MB RAM und Java5 ohne Probleme. Dasmag sich bei groen Projekten, vor allem beim Generieren der Site, aber andersverhalten.

    Maven_9118-8.book Seite 29 Dienstag, 12. Juli 2011 4:43 16

    http://www.mitp.de/9118

  • Kapitel 2Maven im berblick

    30

    Festplatte

    Maven 3.0.3 selber bentigt etwa 3 MB auf der Festplatte. Fr das lokale Repositorykann dann je nach Projekten einiges an Speicher dazukommen. Auf der Maven-Homepage sind 100 MB als Richtwert angegeben, auf meinem Arbeitsrechnersind allerdings mehr als 330 MB durch das Repository belegt (ich habe in den letz-ten Monaten allerdings auch reichlich Plugins ausprobiert ).

    2.3 Installation

    Um Maven zu installieren, sind folgende Schritte notwendig:

    1. Laden Sie Maven vom Apache-Server herunter: http://maven.apache.org/download.html.

    Verfgbar sind die Formate *.zip, *.tar.gz und *.tar.bz2.

    2. Entpacken Sie Maven in ein Verzeichnis Ihrer Wahl.

    3. Die Umgebungsvariable M2_HOME muss auf dieses Verzeichnis verweisen undder Befehlssuchpfad muss die ausfhrbaren Maven-Befehle kennen. UnterWindows mssen Sie dazu mit der Tastenkombination ()+(Pause) die Syste-meigenschaften aufrufen und dann auf dem Reiter ERWEITERT die SchaltflcheUMGEBUNGSVARIABLEN auswhlen. Fgen Sie unter BENUTZERVARIABLEN mit-tels NEU die Variable M2_HOME hinzu. Fgen Sie auerdem der Variablen PATHdas Verzeichnis %M2_HOME%\bin hinzu. Legen Sie dazu eine neue Variable PATHan und weisen Sie ihr den Wert %M2_HOME%\bin;%PATH% zu.

    Unter *nix-Systemen werden die Variablenzuweisungen in einer Konsole ein-gegeben:

    Mit Hilfe des Befehls mvn --version kann geprft werden, ob die Installationerfolgreich war:

    export M2_HOME=/usr/local/apache-maven-3.0.3

    export PATH=$M2_HOME:$PATH

    D:>mvn --version

    Apache Maven 3.0.3 (r1075438; 2011-02-28 18:31:09+0100)

    Maven home: C:\Programme\Apache\apache-maven-3.0.3

    Java version: 1.6.0_23, vendor: Sun Microsystems Inc.

    Java home: C:\Programme\Java\jdk1.6.0_23\jre

    Default locale: de_DE, platform encoding: Cp1252

    OS name: "windows xp", version: "5.1", arch: "x86", family: "windows"Maven

    Maven_9118-8.book Seite 30 Dienstag, 12. Juli 2011 4:43 16

    http://maven.apache.org/http://www.mitp.de/9118

  • 2.4Projekt erstellen

    31

    Falls der Rechner hinter einer Firewall liegt, muss noch die Datei settings.xmlerstellt werden, die im Home-Verzeichnis des Users liegt: ~/.m2/ unter Unix/Macbzw. C:\Dokumente und Einstellungen\%USERNAME%\.m2\ unter Windows-Sys-temen.

    Maven verwaltet alle Plugins und Abhngigkeiten wie JARs in einem Verzeichnis,das als lokales Repository bezeichnet wird. Standardmig wird dieses Repositoryebenfalls im ~/.m2-Verzeichnis erstellt. Sollte Ihr Benutzer-Profil auf einem Ser-ver gespeichert werden, empfiehlt es sich, ein anderes Verzeichnis fr das lokaleRepository anzugeben. Diese Einstellung wird ebenfalls in der Datei set-tings.xml vorgenommen:

    2.4 Projekt erstellen

    Um ein erstes Projekt zu generieren, wird das Archetype-Plugin aufgerufen:

    Dieser Aufruf erstellt im aktuellen Verzeichnis ein Unterverzeichnis beispiel-projekt, das ein rudimentres Java-Projekt enthlt, bestehend aus einer Projekt-beschreibungsdatei, einer Java-Klasse und dem dazugehrigen JUnit-Test.

    true

    http

    PROXYHOST

    PROXYPORT

    localhost|zaphod|...

    ...

    D:/java/Maven2/repository

    ...

    mvn archetype:create \

    -DgroupId=de.mavenbuch.beispiel \

    -DartifactId=beispiel-projekt

    Maven_9118-8.book Seite 31 Dienstag, 12. Juli 2011 4:43 16

    http://www.mitp.de/9118

  • Kapitel 2Maven im berblick

    32

    Abb. 2.1: Verzeichnisstruktur des Beispiel-Projekts

    Die angegebene groupId wurde als Vorgabe fr die Java-Paket-Struktur verwen-det.

    Die Projektbeschreibungsdatei pom.xml enthlt, neben den eben angegebenenWerten, auch die, automatisch vergebene, Version 1.0-SNAPSHOT, denpackaging-Typ jar, der angibt, dass das Projekt als Standard-Java-Archiv gepacktwerden soll, sowie JUnit als einzige Abhngigkeit:

    4.0.0

    de.mavenbuch.beispiel

    beispiel-projekt

    jar

    1.0-SNAPSHOT

    beispiel-projekt

    http://maven.apache.org

    UTF-8

    Maven_9118-8.book Seite 32 Dienstag, 12. Juli 2011 4:43 16

    http://maven.apache.org/POM/4.0.0http://www.w3.org/2001/XMLSchema-instancehttp://maven.apache.org/POM/4.0.0http://maven.apache.org/POM/4.0.0http://maven.apache.org/maven-v4_0_0.xsdhttp://maven.apache.org
  • 2.5Bauen Testen Packen

    33

    2.5 Bauen Testen Packen

    2.5.1 Basisfunktionen

    Kompilieren

    Wechseln Sie in das Verzeichnis und kompilieren Sie die Sourcen:

    Maven erstellt nun den Zielordner target/classes und kompiliert die Klasseaus dem Source-Pfad src/main/java in dieses Verzeichnis. Auf der Kommando-zeile sieht das Ergebnis so aus:

    junit

    junit

    3.8.1

    test

    Hinweis

    Eventuell ist Ihnen beim Aufruf von mvn archetype:create folgende Warnungin der Maven-Ausgabe auf der Konsole aufgefallen:

    ...[WARNING] This goal is deprecated. Please use mvn archetype:generateinstead...

    Das sollte Sie allerdings nicht weiter beunruhigen. Da die Erzeugung eines Stan-dard-Java-Projekts mit archetype:create so bequem ist, ignorieren wir dieWarnung an dieser Stelle einfach. Das Goal archetype:generate wird inAbschnitt 2.8 erlutert.

    mvn compile

    D:\beispiel-projekt>mvn compile

    [INFO] Scanning for projects...

    [INFO]

    [INFO] -----------------------------------------------------------------

    [INFO] Building beispiel-projekt 1.0-SNAPSHOT

    [INFO] -----------------------------------------------------------------

    Maven_9118-8.book Seite 33 Dienstag, 12. Juli 2011 4:43 16

    http://www.mitp.de/9118

  • Kapitel 2Maven im berblick

    34

    [INFO]

    [INFO] --- maven-resources-plugin:2.4.3:resources (default-resources) @ beispiel-projekt ---

    [INFO] Using 'UTF-8' encoding to copy filtered resources.

    [INFO] skip non existing resourceDirectory D:\Projekte\mavenbuch2\beispiel-projekt\src\main\resources

    [INFO]

    [INFO] --- maven-compiler-plugin:2.3.2:compile (default-compile) @ beispiel-projekt ---

    [INFO] Compiling 1 source file to D:\Projekte\mavenbuch2\beispiel-projekt\target\classes

    [INFO] -----------------------------------------------------------------

    [INFO] BUILD SUCCESS

    [INFO] -----------------------------------------------------------------

    [INFO] Total time: 1.125s

    [INFO] Finished at: Sun Jan 30 09:28:33 CET 2011

    [INFO] Final Memory: 5M/15M

    [INFO] -----------------------------------------------------------[INFO]

    Wichtig

    Das bersetzen des Codes wird durch das Maven-Compiler-Plugin durchge-fhrt. Die Standardeinstellung fr die Versionen von Sourcen und kompiliertenKlassen ist 1.5. Fr ltere Versionen des Compiler-Plugins war aus Kompatibili-ttsgrnden die Voreinstellung fr Source-Code Version 1.3, fr die kompiliertenKlassen Version 1.1. Wollen Sie die Features einer aktuelleren Java-Version nut-zen, mssen Sie das Compiler-Plugin in der build-Sektion des POM entspre-chend konfigurieren:

    ...

    ...

    org.apache.maven.pluginsmaven-compiler-plugin

    1.61.6

    ...

    ...

    Maven_9118-8.book Seite 34 Dienstag, 12. Juli 2011 4:43 16

    http://www.mitp.de/9118

  • 2.5Bauen Testen Packen

    35

    Unit-Tests ausfhren

    Um den Unit-Test auszufhren, rufen Sie

    auf. Nun werden folgende Schritte ausgefhrt:

    1. Der Zielordner target/test-classes wird erstellt, der die kompilierten Test-klassen aufnimmt.

    2. Die Testklassen werden kompiliert

    3. und die Unit-Tests werden ausgefhrt.

    Anschlieend erscheint die Ausgabe ber den erfolgreichen Durchlauf der Tests:

    Packen und Installieren

    Der Aufruf der Phase package mit

    erzeugt ein JAR-Archiv im Ordner target des Projekts.

    Der Aufruf von

    schlielich legt eine Kopie des JAR-Archivs und der Datei pom.xml im lokalenRepository ab.

    Aufrumen

    Um das Projektverzeichnis aufzurumen, sprich das target-Verzeichnis zulschen, wird

    mvn test

    ...

    ------------------------------------------------------

    T E S T S

    -------------------------------------------------------

    Running de.mavenbuch.beispiel.AppTest

    Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.016 sec

    Results :

    Tests run: 1, Failures: 0, Errors: 0, Skipped: 0

    Running de.mavenbuch.beispiel.AppTest

    ...

    mvn package

    mvn install

    Maven_9118-8.book Seite 35 Dienstag, 12. Juli 2011 4:43 16

    http://www.mitp.de/9118

  • Kapitel 2Maven im berblick

    36

    aufgerufen.

    Die Aufrufe lassen sich auch kombinieren. So ergibt der Aufruf

    ein erneutes Kompilieren und Packen des Projekts, nachdem der target-Ordnergelscht wurde. Genau genommen ruft mvn package die Phase package desBuild-Zyklus auf. Deren Ausfhrung beinhaltet alle notwendigen Schritte vomKompilieren bers Testen bis zur jar-Erzeugung. Wie das alles genau zusammen-hngt, beschreibt Kapitel L.

    2.5.2 Dokumentation

    Mit Maven lsst sich aus den Informationen der POM eine Sammlung von ver-linkten Webseiten generieren.

    Rufen Sie

    auf und ffnen Sie nach Ablauf des Programms die Datei target/site/index.html in einem Browser:

    mvn clean

    mvn clean package

    Wichtig

    In Maven 3 wurde das Reporting gendert und funktioniert nicht mehr mit den2.*-Versionen des Reporting-Plugins. Daher mssen Maven-3-Anwender hierdie Datei pom.xml anpassen und eine 3.*-Version des Reporting-Plugins ange-ben:

    ...

    org.apache.maven.pluginsmaven-site-plugin3.0-beta-3

    mvn site

    Maven_9118-8.book Seite 36 Dienstag, 12. Juli 2011 4:43 16

    http://www.mitp.de/9118

  • 2.5Bauen Testen Packen

    37

    Abb. 2.2: Durch Maven generierte Webseite

    Probieren Sie einfach mal die Links im Men auf der linken Seite aus. Unter PRO-JECT INFORMATION findet sich zum Beispiel eine Auflistung und Beschreibung dererzeugten Seiten (siehe Abbildung 2.3).

    Abb. 2.3: Projektinformationen in der generierten Webseite

    Maven_9118-8.book Seite 37 Dienstag, 12. Juli 2011 4:43 16

    http://www.mitp.de/9118

  • Kapitel 2Maven im berblick

    38

    Sie knnen zustzlich zu den Informationen aus der POM auch verschiedeneReports zu Change-Listen des Versionskontrollsystems, Codequalitt und Tester-gebnissen sowie Links in die Javadoc und den Sourcecode generieren lassen.Zustzlich kann die komplette Projektdokumentation in Gestalt von Dokumentati-onen und FAQs durch Maven generiert werden. Um zum Beispiel eine Analysedes Sourcecodes mit PMD durchfhren zu lassen und das Ergebnis in die Webs-eite einzubinden, wird die Datei pom.xml um eine reporting-Sektion erweitertund das PMD-Plugin dort eingetragen:

    Kapitel 17 beschreibt die mglichen Elemente der von Maven generierten Doku-mentation und ihre Konfiguration. Weitere Informationen zur Qualittssicherungmit Maven und zu Werkzeugen wie PMD, FindBugs und anderen finden sich inKapitel 18.

    Javadoc

    Der Aufruf

    erzeugt aus den Javadoc-Kommentaren im Code die entsprechende API-Doku-mentation des Projekts im Verzeichnis target/site/apidocs.

    Soll die Javadoc auch in der generierten Webseite eingebunden werden, muss diereporting-Sektion ergnzt und das Javadoc-Plugin dort eingetragen werden:

    ...

    org.apache.maven.plugins

    maven-pmd-plugin

    ...

    mvn javadoc:javadoc

    ...

    Maven_9118-8.book Seite 38 Dienstag, 12. Juli 2011 4:43 16

    http://www.mitp.de/9118

  • 2.5Bauen Testen Packen

    39

    Nach einem weiteren Aufruf von

    findet sich nun auf der generierten Webseite

    unterhalb von PROJECT INFORMATION ein neuer Link PROJECT REPORTS, unter demsich die Punkte JAVADOCS und TEST JAVADOCS befinden.

    Wie das Javadoc-Tool kann auch das Javadoc-Plugin konfiguriert werden, um zumBeispiel eigene Stylesheets oder Doclets zu verwenden.

    Um durch mvn package auch ein Archiv mit der Schnittstellenbeschreibungerzeugen zu lassen, wird die pom.xml um folgenden Eintrag ergnzt:

    org.apache.maven.plugins

    maven-javadoc-plugin

    ...

    mvn site

    target/site/index.html

    ...

    org.apache.maven.plugins

    maven-javadoc-plugin

    attach-javadocs

    jar

    Maven_9118-8.book Seite 39 Dienstag, 12. Juli 2011 4:43 16

    http://www.mitp.de/9118

  • Kapitel 2Maven im berblick

    40

    Wird das Projekt nun mit mvn package gebaut, so wird ein weiteres Java-Archiverstellt:

    Analog lsst sich mit dem Plugin maven-source-plugin ein Java-Archiv mit denProjektquellen erzeugen:

    2.6 Projekte erweitern

    Um das erstellte Projekt um Bibliotheken zu erweitern, muss ebenfalls die Dateipom.xml angepasst werden. Nehmen wir an, das Logging-Framework Log4J sollverwendet werden. Dazu erweitern wir die Sektion dependencies, in der Abhn-

    ...

    target/beispiel-programm-1.0-SNAPSHOT-javadoc.jar

    ...

    org.apache.maven.plugins

    maven-source-plugin

    attach-sources

    jar

    ...

    Vorsicht

    Die so erstellten Archive mit Dokumentation und Quellcode werden beim Auf-ruf von mvn deploy auch auf ein externes Repository kopiert. Das ist vielleichtnicht bei allen Projekten unbedingt erwnscht.

    Maven_9118-8.book Seite 40 Dienstag, 12. Juli 2011 4:43 16

    http://www.mitp.de/9118

  • 2.7Ein Web-Projekt

    41

    gigkeiten des Projekts verwaltet werden. In unserem Beispiel-Projekt befindet sichbereits ein Eintrag fr JUnit, unter dem wir nun Log4J hinzufgen:

    Dazu geben wir die Koordinaten der Bibliothek an: groupId, artifactId undversion. Der Eintrag fr JUnit enthlt auerdem den Eintrag test, der den Gltigkeitsbereich angibt: JUnit wird nur fr die Phasen test-compile und test bentigt. Lassen wir die scope-Angabe weg, wird automatischder Gltigkeitsbereich compile angenommen. Fhren wir nun wieder den Befehlmvn compile aus, wird die Datei log4j-1.2.14.jar in das Verzeichnis log4j/log4j/1.2.14/ des lokalen Repositorys heruntergeladen und in unser Projekteingebunden.

    Mehr zu Abhngigkeiten, Gltigkeitsbereichen und wie Maven damit umgeht,erklrt Kapitel 7.

    2.7 Ein Web-Projekt

    2.7.1 Generieren einer Web-Applikation

    Mit mvn archetype:create lassen sich auch andere Arten von Projekten, wiezum Beispiel ein Web-Projekt erzeugen:

    Anstelle der Verzeichnisse src/main/java und src/test/java stehen hier amAnfang src/main/webapp und src/main/resources zur Verfgung:

    junit

    junit

    3.8.1

    test

    log4j

    log4j

    1.2.14

    mvn archetype:create \

    -DgroupId=de.mavenbuch.beispiele \

    -DartifactId=webapp-beispiel \

    -DarchetypeArtifactId=maven-archetype-webapp

    Maven_9118-8.book Seite 41 Dienstag, 12. Juli 2011 4:43 16

    http://www.mitp.de/9118

  • Kapitel 2Maven im berblick

    42

    Abb. 2.4: Struktur des Web-Projekts

    Die generierte pom.xml unterscheidet sich in ein paar Punkten von der aus demersten Beispiel:

    1. Der Eintrag war gibt an, dass ein war-Archiverzeugt werden soll.

    2. Mit dem Eintrag webapp-beispiel wird festge-legt, dass als Archivname immer webapp-beispiel.war verwendet wird,anstatt der Kombination aus artifactId und Version.

    4.0.0

    de.mavenbuch.beispiele

    webapp-beispiel

    war

    1.0-SNAPSHOT

    webapp-beispiel Maven Webapp

    http://maven.apache.org

    junit

    junit

    3.8.1

    test

    webapp-beispiel

    Maven_9118-8.book Seite 42 Dienstag, 12. Juli 2011 4:43 16

    http://maven.apache.org/POM/4.0.0http://www.w3.org/2001/XMLSchema-instancehttp://maven.apache.org/POM/4.0.0\http://maven.apache.org/POM/4.0.0\http://maven.apache.org/maven-v4_0_0.xsdhttp://maven.apache.org
  • 2.7Ein Web-Projekt

    43

    2.7.2 Servlet-API

    Um die erstellte Web-Anwendung auch mit Leben zu fllen, bentigen wir dieServlet-API in unserem Klassenpfad. Allerdings nur zum Kompilieren, da norma-lerweise jeder Servlet-Container die Servlet-API in seiner Laufzeitumgebung mit-bringt. Binden wir die Bibliothek auch zur Laufzeit ein, wrde dies deshalbhchstwahrscheinlich zu einem Versionskonflikt fhren. Um dies zu vermeiden,verwendet Maven den Gltigkeitsbereich provided, der angibt, dass die Biblio-thek nicht durch Maven zur Laufzeit zur Verfgung gestellt werden muss:

    2.7.3 Ausfhren der Web-Anwendung

    Normalerweise muss, um eine Web-Applikation auszufhren, ein Servlet-Contai-ner wie Tomcat oder Jetty konfiguriert und die Applikation deployed werden. Ver-wendet man jedoch das Jetty-Plugin jetty-maven-plugin, kann die Web-Applikation direkt mit Maven gestartet werden. Dazu muss lediglich die Dateipom.xml um einen Plugin-Eintrag erweitert werden:

    javax.servlet

    servlet-api

    2.4

    provided

    ...

    webapp-beispiel

    org.mortbay.jetty

    jetty-maven-plugin

    6.1.22

    Maven_9118-8.book Seite 43 Dienstag, 12. Juli 2011 4:43 16

    http://www.mitp.de/9118

  • Kapitel 2Maven im berblick

    44

    Wird nun auf der Konsole

    aufgerufen, steht eine Jetty-Instanz auf Port 8080 zur Verfgung. Ein anderer Portkann mittels -Djetty.port= bergeben werden.

    [jetb] enthlt eine ausfhrliche Beschreibung ber die Konfigurationselemente desPlugins.

    Der Befehl mvn package erzeugt im Verzeichnis target/${finalname} ein kom-plettes Abbild der Web-Applikation. Dieser Pfad kann einem lokalen Servlet-Con-tainer als Basisverzeichnis mitgeteilt werden, um die Applikation whrend derEntwicklungsphase zu testen. Um unser Beispiel in Tomcat 6.0.* anzumelden,muss dazu im Tomcat-Installationsverzeichnis die Datei conf/Catalina/local-host/webapp-beispiel.xml mit folgendem Inhalt angelegt werden:

    2.8 Weitere Projekttypen

    Fr einfache Java-Projekte mag die Projekterzeugung mittels mvn arche-type:create ausreichend sein, sobald aber andere (oder eigene) Templates ver-wendet werden sollen, sollte das bereits erwhnte Goal

    verwendet werden.

    Nach dem Aufruf bietet Maven eine Liste von Projekt-Archetypen an. Darunterbefinden sich unter anderem Vorlagen fr J2EE-, JPA- und Portlet-Projekte. MitVersion 2.0 des Plugins werden 401 verschiedene Projektvorlagen angeboten.

    Der aufgefhrte Typ maven-archetype-quickstart ist brigens der Standard-projekttyp, der beim Aufruf des Goals archetype:create ohne den ParameterarchetypeArtifactId verwendet wird.

    Wurde einer der angegebenen Archetypen aus der Liste ausgewhlt, fragt Mavennoch nach groupId, artifactId, version und package und generiert dann einProjekt des ausgewhlten Typs.

    mvn jetty:run

    mvn archetype:generate

    Maven_9118-8.book Seite 44 Dienstag, 12. Juli 2011 4:43 16

    http://www.mitp.de/9118

  • 2.9Entwicklungsumgebungen

    45

    In Abschnitt 18.4 wird gezeigt, wie eigene Vorlagen fr die Verwendung mit demArchetype-Plugin erzeugt werden knnen.

    2.9 Entwicklungsumgebungen

    Normalerweise benutzen, von einigen Puristen mal abgesehen, Entwicklermoderne IDEs (Integrated Development Environment), die oft eigene, proprietreKonfigurationsdateien verwenden.

    Da Maven aber alle notwendigen Informationen des Projekts in der pom.xmlzusammenhlt, gibt es fr die verbreitetsten IDEs auch Plugins, die die Projekteautomatisch importierbar machen.

    Da ich meine tgliche Arbeit mit Eclipse erledige, werden die anderen IDEs hiernur oberflchlich behandelt.

    2.9.1 Eclipse

    Fr Eclipse gibt es mehrere Lsungen, um Maven-Projekte zu integrieren. Derdirekteste ist die Generierung der Projektdateien .classpath und .project mitHilfe des Maven-Eclipse-Plugins:

    Die Datei .project im unserem beispiel-projekt sieht danach wie folgt aus:

    Choose a number:(1/2/3/4/5/6/7/8/9/10/11/12/13/14/15/16/17/18/19/20/\

    21/22/23/24/25/26/27/28/29/30/31/32/33/34/35/36/37/38/39/40/41) \

    15: : 10

    Define value for groupId: : de.mavenbuch.beispiele

    Define value for artifactId: : j2ee-beispiel

    Define value for version: 1.0-SNAPSHOT: :

    Define value for package: de.mavenbuch.beispiele: :

    Confirm properties configuration:

    groupId: de.mavenbuch.beispiele

    artifactId: j2ee-beispiel

    version: 1.0-SNAPSHOT

    package: de.mavenbuch.beispiele

    Y: :

    mvn eclipse:eclipse

    beispiel-projekt

    Maven_9118-8.book Seite 45 Dienstag, 12. Juli 2011 4:43 16

    http://www.mitp.de/9118

  • Kapitel 2Maven im berblick

    46

    Die Datei .classpath hat folgenden Inhalt:

    Dabei fllt auf, dass die Abhngigkeit des Projekts beispiel-projekt von JUnitrelativ zu M2_REPO hergestellt wird. Damit Eclipse den Pfad M2_REPO auflsenkann, muss im Build-Pfad eine Classpath-Variable angelegt werden. Dies kanndurch den Aufruf von

    geschehen oder manuell eingegeben werden (siehe Abbildung 2.5).

    Dazu muss in Eclipse unter Windows/Preferences/Java/Build Path/Class-path Variables eine neue Variable mit dem Namen M2_REPO eingetragen wer-den, die dann auf das Verzeichnis des lokalen Repositorys verweist.

    Nun kann das Projekt importiert werden. Hierzu wird der Projektordner angege-ben, wenn im Kontextmen des aktuellen Workspace der Befehl Import -> Exis-ting projects into workspace ausgefhrt wird:

    org.eclipse.jdt.core.javabuilder

    org.eclipse.jdt.core.javanature

    mvn -Declipse.workspace= \

    eclipse:add-maven-repo

    Maven_9118-8.book Seite 46 Dienstag, 12. Juli 2011 4:43 16

    http://www.mitp.de/9118

  • 2.9Entwicklungsumgebungen

    47

    Abb. 2.5: Einstellung der Classpath-Variablen in Eclipse

    Abb. 2.6: Import von Projekten in Eclipse

    Maven_9118-8.book Seite 47 Dienstag, 12. Juli 2011 4:43 16

    http://www.mitp.de/9118

  • Kapitel 2Maven im berblick

    48

    Nach diesem Schritt steht im Eclipse-Workspace das Projekt beispiel-projektzur Verfgung.

    Kapitel 16 beschftigt sich ausfhrlich mit der Konfiguration des Eclipse-Pluginsund mglicher Alternativen.

    2.9.2 Netbeans

    Netbeans untersttzt Maven direkt. Fr Netbeans Versionen vor 6.7 existiert dasProjekt Mevenide (http://mevenide.codehaus.org), ein Plugin, das den Importvon Maven-Projekten in Netbeans erlaubt.

    Fr ltere Netbeans-Versionen (4.x und 5.0) ist es auch mglich, mit

    die notwendigen Konfigurationsdateien zu erzeugen. Das Maven-Plugin net-beans-freeform wird aber anscheinend nicht mehr weiterentwickelt.

    Die Maven-Homepage bietet weitere Informationen zur Verwendung von net-beans-freeform: http://maven.apache.org/guides/mini/guide-ide-netbeans/guide-ide-

    netbeans.html

    2.9.3 IntelliJ IDEA

    IntelliJ IDEA untersttzt Maven seit der Version 8 von sich aus. Fr ltere Versio-nen lassen sich mit

    die notwendigen Konfigurationsdateien erzeugen.

    mvn netbeans-freeform:generate-netbeans-project

    mvn idea:idea

    Maven_9118-8.book Seite 48 Dienstag, 12. Juli 2011 4:43 16

    http://mevenide.codehaus.orghttp://maven.apache.org/guides/mini/guide-ide-netbeans/guide-ide-netbeans.htmlhttp://maven.apache.org/guides/mini/guide-ide-netbeans/guide-ide-netbeans.htmlhttp://maven.apache.org/guides/mini/guide-ide-netbeans/guide-ide-netbeans.htmlhttp://www.mitp.de/9118

    Copyright: des Titels Maven 3 - Konfigurationsmanagement mit Java (ISBN 978-3-8266-9118-8) 2011by Verlagsgruppe Hthig Jehle Rehm GmbH, Heidelberg.Nhere Informationen unter: http://www.mitp.de/9118

Recommended

View more >