2.3. Maven-Grundlagen

Dieser Abschnitt liefert eine kurze Einführung in einige grundlegende Konzepte von Maven, die Ihnen dabei helfen, die fundamentalen Ideen des Maven Build-Systems zu verstehen.

Maven definiert einen Standardsatz von Phasen im Build-Lebenszyklus, wobei die genaue Abfolge von Phasen davon abhängt, für welches Paket der Build erfolgt. Ein JAR-Paket zum Beispiel beinhaltet (unter anderem) die Phasen: compile, test, package und install.

Beim Ausführen von Maven wird die Phase in der Regel als ein Argument des mvn Befehls festgelegt um anzugeben, wie weit der Build voranschreiten soll. Hier sind ein paar der am häufigsten verwendeten Maven-Befehle:

Beispiel 2.1, »Standard Maven Verzeichnislayout« zeigt das Standard-Verzeichnislayout von Maven. Am wichtigsten ist die Maven POM-Datei, pom.xml, die den Build für dieses Maven-Projekt konfiguriert.

ProjectDir/
    pom.xml
    src/
        main/
            java/
                ...
            resources/
                META-INF/
                    spring/
                        *.xml
                OSGI-INF/
                    blueprint/
                        *.xml
        test/
            java/
            resources/
    target/
        ...

Die Java-Quelldateien des Projekts müssen unter ProjectDir/src/main/java/ gespeichert und alle Ressourcendateien sollten unter ProjectDir/src/main/resources/ gespeichert werden. Insbesondere Spring XML-Dateien (die mit dem Muster *.xml übereinstimmen) sollten unter dem folgenden Verzeichnis gespeichert werden:

ProjectDir/src/main/resources/META-INF/spring/

Blueprint XML Dateien (die mit dem Muster *.xml übereinstimmen), sollten unter dem folgenden Verzeichnis gespeichert werden:

ProjectDir/src/main/resources/OSGI-INF/blueprint/

Ein wichtiges Prinzip ist bei Maven das der Konvention vor Konfiguration. Dies bedeutet, dass Mavens Funktionen und Plugins mit vernünftigen Standardkonventionen initialisiert werden, so dass die grundlegende Funktionalität von Maven nur wenig oder keine Konfiguration erfordert.

Insbesondere der Speicherort der Dateien innerhalb von Mavens standardmäßigem Verzeichnis-Layout bestimmt effektiv, wie diese verarbeitet werden. Wenn Sie zum Beispiel ein Maven Projekt für den Build eines JAR haben, so werden alle Java-Dateien im src/main/java Verzeichnis automatisch kompiliert und dem JAR hinzugefügt. Alle Ressourcen-Dateien im src/main/resources Verzeichnis werden ebenfalls dem JAR hinzugefügt.

Maven definiert eine Vielfalt an Packtypen, die das Build-Grundverhalten bestimmen. Die gängigsten Packtypen lauten wie folgt:

Das Endprodukt eines Maven-Builds ist ein Maven Artifakt (zum Beispiel eine JAR-Datei). Maven Artifakte werden normalerweise in einem Maven-Repository installiert, von wo aus auf diese zugegriffen werden kann und wo diese als Bausteine für andere Maven-Projekte verwendet werden können (indem sie als Abhängigkeiten deklariert werden).

Artifakte werden durch einen Tupel von Maven Koordinaten eindeutig identifiziert, die in der Regel aus groupId:artifactId:version bestehen. Bei der Bereitstellung eines Maven Artifakts in den Red Hat JBoss Fuse Container, können Sie es mit einem Maven URI der Form mvn:groupId/artifactId/version referenzieren.

Weitere Informationen zu Maven Koordinaten finden Sie unter Bereitstellung in den Container.

Die häufigste Änderung, die Sie an der POM-Datei Ihres Projekts werden vornehmen müssen ist das Hinzufügen oder Entfernen von Maven Abhängigkeiten. Eine Abhängigkeit ist einfach eine Referenz zu einem Maven Artifakt (in der Regel eine JAR-Datei), das benötigt wird, um Ihr Projekt auszuführen. Genau genommen übernimmt die Verwaltung der Collection von Abhängigkeiten im Kontext eines Maven Builds den Platz der Verwaltung der Collection von JAR-Dateien in einem Klassenpfad.

Der folgende Schnipsel aus einer POM-Datei zeigt, wie eine Abhängigkeit am camel-blueprint Artifakt festgelegt wird:

<project ...>
    ...
    <dependencies>
        <dependency>
            <groupId>org.apache.camel</groupId>
            <artifactId>camel-blueprint</artifactId>
            <version>2.15.1.redhat-621084</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>
    ...
</project>

Das dependency Element deklariert eine Abhängigkeit vom Maven Artifakt mit Koordinaten org.apache.camel:camel-blueprint:6.2.1.redhat-084. Sie können so viele dependency Elemente wie Sie möchten innerhalb des dependencies Elements hinzufügen.

Das scope-Element ist optional und liefert zusätzliche Informationen darüber, wann diese Abhängigkeit benötigt wird. Es wird standardmäßig angenommen (mit weggelassenem scope Element), dass die Abhängigkeit beim Build, dem Testen der Einheit und zur Runtime benötogt wird. Mit am Wert eingestelltem scope provided, hängt die Auswirkung davon ab, welche Art von Artifakt erstellt wird:

Um die Liste von Abhängigkeiten in Ihrem POM zu vereinfachen und nicht jede einzelne Abhängigkeit explizit auflisten zu müssen, bietet Maven einen rekursiven Algorithmus, um die für Ihr Projekt erforderlichen Abhängigkeiten zu ermitteln.

Wenn Ihr Projekt A zum Beispiel von B1 und B2 abhängt, B1 von C1, C2 und C3 und B2 von D1 und D2 abhängt, so zieht sich Maven zum Zeitpunkt des Build automatisch alle explizit und implizit benötigten Abhängigkeiten und erstellt einen Klassenpfad, der die Abhängigkeiten B1, B2, C1, C2, C3, D1 und D2 beinhaltet. Von diesen Abhängigkeiten erscheinen nur B1 und B2 explizit in As POM-Datei. Der Rest der Abhängigkeiten—die von Maven herausgefunden werden—sind als transitive Abhängigkeiten bekannt.

Ein Maven Repository ist ein Ort, an dem Maven nach Artifakten suchen kann. Da Maven Repositorys überall sein können—und das beinhaltet überall im Internet—ist das Maven Build-System inhärent distribuiert. Nachfolgend sehen Sie die Hauptkategorien des Maven Repository:

Weitere Informationen zu Maven Repositories finden Sie unter Bereitstellung in den Container.

Falls Sie die Maven zugänglichen Remote Repositories anpassen müssen, so müssen Sie zunächst die Speicherorte für die Build- und Runtime Repositorys wie folgt separat konfigurieren: