Maven 2.0. DRV Jahrestagung Java Würzburg Rainer Vehns, codecentric GmbH codecentric GmbH

Transkript

1 Maven 2.0 DRV Jahrestagung Java Würzburg Rainer Vehns, codecentric GmbH

2 Agenda Einführung Project Object Model (POM) Repositories Maven und Eclipse Maven - LIVE

3 1. EINFÜHRUNG

4 Einführung - Was ist Maven? Build-Management-Werkzeug Ursprung : Vereinfachen des Build-Prozesses in Jakarta Turbine weiter gefasste Definitionen vorhanden software project management and comprehension tool Build- und Deployment-Tool Features Projektübergreifende Vereinheitlichung des Build-Prozesses, ausgelegt auf komplexe Multi- Projekt-Strukturen Definition eines einheitlichen Build-Lifecycles Management von komplexen Abhängigkeiten inkl. transitiven Abhängigkeiten Automatische Erzeugung einer Projekt-Site mit Projektinformationen Abhängigkeiten, Reports (Qualität, Testfallabdeckung, ) Veröffentlichung der Builds in Repositories (zentral, eigene) und Zugriff auf zentrale Repositories Erweiterbarkeit und Anpassbarkeit durch Plugin-Konzept (zahlreiche Plugins vorhanden z.b. für Deployment, ANT-Aufrufe) Plattformunabhängig durch Pure-Java

5 Einführung Ziele von Maven Einfacher Build-Prozess für komplexe Java-Projekte Konfiguration und kein Skripting, Vereinheitlichung Strukturen und Lifecycle Sehr guten Überblick über das Projekt behalten Projekt-Site mit Reports, Beschreibung eines Projekts durch XML, Management der Abhängigkeiten Vereinheitlichung des Build-Prozesses Definition von Richtlinien und Best Practices

6 Einführung Grundkonzept (1) Grundprinzip : Convention over Configuration Vorgabe von Richtlinien und Standards nur bei Abweichungen vom Maven-Standard sollte konfiguriert werden müssen Artefakte (artifacts) Output eines Builds, kann über Abhängigkeiten wieder Input für andere Builds sein Verschiedene Typen : JAR, WAR, EAR, Maven-Koordinaten Eindeutige Identifikation eines Artefakts groupid : Gruppe, Firma, Organisation (z.b. ant ) artifactid : Namen des Artefakts, eindeutig innerhalb der groupid (z.b. antlr ) version : Version des Artefakts (z.b ) classifier : bestimmt alternativen Build-Prozess des gleichen Projekts (z.b. abhängig vom JDK) [packaging : Format des Artefakts (z.b. jar )]

7 Einführung Grundkonzept (2) Build Lifecycle Prozess zum Build und Verteilen eines speziellen Artefakts 3 vorhandene Lifecycle in Maven integriert Clean : Alle Dateien, die der vorherige Build erzeugt hat, werden entfernt Default : vollständiger Build Site : Erzeugt die Projekt-Site (Reports, Dokumentation) Kombinationen sind möglich besteht aus Phasen : Teilschritt innerhalb eines Build Lifecycles jede Phase besteht aus einzelnen Goals (einzelner Task mit definiertem Ergebnis), über Bindings definiert

8 Einführung Grundkonzept (3) Build Lifecycle Beispiel Default vereinfacht, komplette Liste : Phase validate validiert das Projekt und prüft, ob alles für den Build vorhanden ist JAR- Binding Goal compile Kompiliert den Code test Testet den Code mit Unit-Tests package Erzeugen des Distributables (Package) verify Prüfung von Qualitätsmerkmalen install Installieren des Packages in das lokale Repository deploy Kopiert das finale Package in ein zentrales Repository compile:compile surefire:test jar:jar. install:install, plugin:updateregistry deploy:deploy

9 Einführung Grundkonzept (4) Maven-Command basiert auf Lifecycles / Goals mvn archetype:create -DgroupId=codecentric -DartifactId=neue-app mvn clean dependency:copy-dependencies package Funktionalität ist in Plugins gekapselt Goals sind in Plugins programmiert (<Plugin-Name>:<Goal>) Erweiterung durch eigene Plugins möglich Liste von Maven-Built-in-Plugins : Beispiele: compiler deploy install war pmd Kompiliert Java-Sourcen Deployed Artefakte in ein entferntes Repository Installiert Artefakte in das lokale Repository Erzeugt ein WAR-Artefakt Erzeugt einen PMD-Report

10 Einführung Grundkonzept (5) Repository Einheitliche Ablage von Artefakten in verschiedenen Versionen Artefakte werden durch deploy/install dort abgelegt Externe Abhängigkeiten werden im Build über Repositories aufgelöst, d.h. benötigte Artefakte zum Build werden von dort geladen Lokales und ein oder mehrere Remote-Repositories

11 Einführung Grundkonzept (6) Project Object Model (POM) Definiert das Projekt inkl. Struktur, Abhängigkeiten, Build-Einstellungen, Plugins, etc. XML-Format Bildung von Hierarchien ist möglich, um komplexere Projekt abzubilden Standard-Maven-Filestruktur (abhängig vom Archetype)

12 Einführung Grundkonzept (7) Versionierung Einheitliche Nummerierung in Maven-Projekten major.minor.bug_fix-qualifier-build_number Beispiel : alpha-1, 1.1, SNAPSHOTs Spezieller Qualifier angehangene am Ende der Version (1.3.5-SNAPSHOT) Repräsentiert aktuelle Stände der Entwicklung, d.h. Development-Versionen Bereichsangaben in <version>-tags bei Dependencies möglich (, ) : Exklusiv der angegeben Versionsnummer [, ] : Inklusiv der angegeben Versionsnummer Beispiel für Version größer oder gleich 3.8, aber kleiner als 4 : <version>[3.8,4.0)</version>

13 2. Project Object Model (POM)

14 Project Object Model (POM) - Grundstruktur <project xmlns=" xmlns:xsi=" > <modelversion>4.0.0</modelversion> <!-- The Basics --> <groupid>...</groupid> <artifactid>...</artifactid> <version>...</version> <packaging>...</packaging> <dependencies>...</dependencies> <dependencymanagement>...</dependencymanagement> <modules>...</modules>... <!-- Build Settings --> <build>...</build> <reporting>...</reporting> <!-- More Project Information --> <name>...</name> <description>...</description> <url>...</url> <inceptionyear>...</inceptionyear> <licenses>...</licenses> <organization>...</organization> <developers>...</developers> <contributors>...</contributors> <!-- Environment Settings --> <issuemanagement>...</issuemanagement> <cimanagement>...</cimanagement> <mailinglists>...</mailinglists> <scm>...</scm> Basiseinstellungen zum Projekt (Coordinates, Dependencies, Modules, ) Build-Einstellungen (Verzeichnisse, Plugins, Reports,.) Projekt-Informationen (Entwickler, URL, Lizemz,.) Environment-Einstellungen (SCM, Buildserver, Mailinglisten,.)

15 Project Object Model (POM) Hierachien (1) SuperPOM (Grundeinstellungen von Maven) Parent-POM (Gemeinsame Einstellungen der POMs) Maven Projekte <parent> <groupid>codecentric</groupid> <artifactid>maven-vortrag</artifactid> <version>1.0-snapshot</version> </parent> POM (Projektspezifische Einstellungen) POM (Projektspezifische Einstellungen9

16 Project Object Model (POM) Hierachien (2) Vererbt werden folgende Einstellungen dependencies developer, contributors plugin list reports list plugin configuration plugin executions

17 Project Object Model (POM) Abhängigkeiten (1) Einfache und transitive Abhängigkeiten maven-vortrag-webapp (Version 1.0) dependency maven-vortrag-kern (Version 1.0) dependency log4j (Version ) transitive dependency <dependency> <groupid>codecentric</groupid> <artifactid>maven-vortrag-kern</artifactid> <version>1.0-snapshot</version> </dependency> <dependency> <groupid>log4j</groupid> <artifactid>log4j</artifactid> <version>1.2.13</version> <scope>compile</scope> </dependency> Scopes compile provided runtime test system In allen Klassenpfaden verfügbar (Default) Wird zur Laufzeit von einem Container oder JDK zur Verfügung gestellt Wird nicht zur Kompilierung, jedoch zur Ausführung benötigt Das referenzierte Artefakt ist nur für Test-Kompilierung und Ausführung notwendig nicht empfohlen und wird wahrscheinlich entfernt

18 Project Object Model (POM) Abhängigkeiten (2) Scopes definieren auch Verhalten bei transitiver Abhängigkeiten compile provided runtime compile compile - runtime provided provided provided provided runtime runtime - runtime test test - test test Exclude von transitiven Abhängigkeiten <dependency> <groupid>com.training.killerapp</groupid> <artifactid>killerapp-core</artifactid> <version>${project.version}</version> <classifier>memory</classifier> <exclusions> <exclusion> <groupid>com.training.killerapp</groupid> <artifactid>killerapp-store-xstream</artifactid> </exclusion> </exclusions> </dependency>

19 Project Object Model (POM) Abhängigkeiten (3) Aggregation von Projekten in einem POM mit dem packaging-type pom maven-vortrag-parent (Version 1.0) <modules> <module>maven-vortrag-kern</module> <module>maven-vortrag-webapp</module> </modules> maven-vortrag-webapp (Version 1.0) maven-vortrag-kern (Version 1.0) Reactor löst Abhängigkeiten automatisch auf z.b. Reihenfolge für den Build wird ermittelt i.gs. zum normalen Build werden auch die abhängigen Module gebuilded <modules> ist nicht Vererbung (z.b. bzgl. Einstellungen)! wird aber oft zusammen mit Vererbung verwendet

20 3. Repositories

21 Repositories - Überblick Einfache Verzeichnisstruktur basierend auf den Maven Coordinates Lesender Zugriff über einfachen HTTP-Zugriff definiert in den Environment -Einstellungen des POMs Unterschiedliche Repositories für Snapshots, Releases, Plugins Reihenfolge der Repositories relevant <repository> <uniqueversion>false</uniqueversion> <id>corp1</id> <name>corporate Repository</name> <url>scp://repo1/maven2</url> <layout>default</layout> </repository> <snapshotrepository> <uniqueversion>true</uniqueversion> <id>propsnap</id> <name>propellors Snapshots</name> <url>sftp://propellers.net/maven</url> <layout>legacy</layout> </snapshotrepository> Defaults im SuperPOM vorhanden (wichtig z.b. für Plugins) Zentrale, freie Repositories

22 Repositories übliche Struktur Maven Build install 1 2 deploy 3 lokales Repository (beinhaltet alle lokal verwendeten und erzeugten Artefakte) Remote Repository (beinhaltet Versionen, Builds der eigenen Komponenten, die nicht frei verfügbar sind) Öffentliches Remote Repository (beinhaltet Versionen, Builds von frei verfügbaren Komponenten)

23 4. Maven und Eclipse

24 Maven und Eclipse Zusammenspiel (1) eclipse-maven-plugin vorhanden, welches sich automatisch integriert (über Plugin- Repository) eclipse-maven-plugin definiert verschiedene Goals, um mit Eclipse zusammen zu arbeiten: eclipse:add-maven-repo Fügt die Classpath-Variable M2-REPO in Eclipse hinzu (unter Angabe der Workspace) eclipse:clean Löscht Eclipse-Files (.project,.classpath,.wtpmodules,.settings) eclipse:eclipse Erzeugt Eclipse-Konfigurationsdateien auf Basis des POMs (.project,.classpath, ) d.h. POM ist immer noch Master Abhängigkeiten werden im POMs definiert und für Eclipse erzeugt funktioniert auch für WTP-Projekte M2_REPO muss gebunden sein, damit die Projekte korrekt kompilieren: mvn -e eclipse:add-maven-repo -Declipse.workspace=c:\eclipse_ws

25 Maven und Eclipse Zusammenspiel (2) Eclipse-Plugin vorhanden : M2Eclipse Eclipse-Integration für Maven (IAM) als Proposal für offizielles Eclipse-Projekt vorhanden Erstes Release geplant für 09/2008

26 4. Maven - LIVE

27 Kontakt codecentric GmbH Grünewalder Str Solingen phone fax