Erstellen einer ausführbaren JAR-Datei mit Abhängigkeiten mithilfe von Maven

Packen von Maven-Projekten in ein einziges ausführbares JAR

Bei der Arbeit mit Java-Projekten ist es häufig erforderlich, Ihre Anwendung zur einfachen Verteilung in eine einzige ausführbare JAR-Datei zu packen. Maven, ein leistungsstarkes Build-Automatisierungstool, ermöglicht es Entwicklern, alle erforderlichen Abhängigkeiten in dieses einzige Ausgabe-JAR einzubinden.

Dieser Artikel führt Sie durch die Schritte, die zum Konfigurieren Ihres Maven-Projekts erforderlich sind, um alle Abhängigkeits-JARs in Ihr endgültiges ausführbares JAR aufzunehmen. Wenn Sie diese Anweisungen befolgen, vereinfachen Sie den Bereitstellungsprozess und stellen sicher, dass Ihre Anwendung in verschiedenen Umgebungen reibungslos läuft.

Erstellen und Ausführen einer ausführbaren JAR-Datei mit Maven

Die oben bereitgestellten Skripte veranschaulichen, wie ein Maven-Projekt so konfiguriert wird, dass alle seine Abhängigkeiten in einer einzigen ausführbaren JAR-Datei zusammengefasst werden. Das erste Skript ist ein Maven pom.xml Datei, die die Konfiguration des Projekts enthält. In dieser Datei befindet sich die <plugin> Tag wird verwendet, um das Maven Assembly Plugin zu definieren. Dieses Plugin ist entscheidend für die Erstellung einer ausführbaren JAR-Datei, die alle Abhängigkeiten enthält. Der <descriptorRefs> -Tag innerhalb der Plugin-Konfiguration gibt die Verwendung des an jar-with-dependencies Deskriptor, der sicherstellt, dass alle Abhängigkeiten des Projekts in die endgültige JAR-Datei gepackt werden. Der <mainClass> Tag innerhalb der <manifest> Der Abschnitt ist wichtig, da er Maven mitteilt, welche Klasse die Hauptmethode enthält, die ausgeführt werden soll, wenn das JAR ausgeführt wird.

Der <execution> Der Block innerhalb der Plugin-Konfiguration ist der Ort, an dem die Aktion stattfindet. Es gibt das Ziel des Plugins an single sollte während des ausgeführt werden package Phase des Build-Lebenszyklus. Dies löst die Erstellung der JAR-Datei mit Abhängigkeiten aus. Das zweite Skript ist eine einfache Befehlszeilenanweisung: mvn clean package. Dieser Befehl bereinigt das Projekt (entfernt frühere Build-Artefakte), kompiliert den Quellcode, führt Tests aus und packt das Projekt in eine JAR-Datei. Die endgültige JAR-Datei befindet sich im target Verzeichnis des Projekts erstellt und entsprechend benannt artifactId Und version angegeben in der pom.xml.

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>my-app</artifactId>
    <version>1.0-SNAPSHOT</version>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-assembly-plugin</artifactId>
                <version>3.3.0</version>
                <configuration>
                    <descriptorRefs>
                        <descriptorRef>jar-with-dependencies</descriptorRef>
                    </descriptorRefs>
                    <archive>
                        <manifest>
                            <mainClass>com.example.MainClass</mainClass>
                        </manifest>
                    </archive>
                </configuration>
                <executions>
                    <execution>
                        <id>make-assembly</id>
                        <phase>package</phase>
                        <goals>
                            <goal>single</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

mvn clean package
# This command will compile the code, run the tests, and create the JAR file
# The JAR file will include all dependencies specified in the pom.xml
# It will be located in the target directory of the project
# The final JAR file will be named my-app-1.0-SNAPSHOT-jar-with-dependencies.jar

# To run the JAR file, use the following command:
java -jar target/my-app-1.0-SNAPSHOT-jar-with-dependencies.jar
# Ensure that the mainClass specified in the pom.xml is correct
# This will start your application with all dependencies included

Erweiterte Maven-Techniken für Verpackungsabhängigkeiten

Über die Grundkonfiguration zum Erstellen einer ausführbaren JAR-Datei mit Maven hinaus gibt es zusätzliche Techniken, die Ihren Build-Prozess verbessern können. Eine solche Technik beinhaltet die Verwendung von shade Plugin anstelle des assembly Plugin. Das Maven Shade Plugin bietet erweiterte Funktionen zum Erstellen von Uber-JARs (JARs mit enthaltenen Abhängigkeiten). Es ermöglicht Ihnen, Pakete umzubenennen, um Klassenpfadkonflikte zu vermeiden, und bietet eine bessere Handhabung doppelter Klassen und Ressourcen. Darüber hinaus bietet es eine detaillierte Kontrolle darüber, welche Abhängigkeiten im endgültigen JAR enthalten sind.

Ein weiterer wichtiger Aspekt ist die Verwaltung der Größe Ihrer JAR-Datei. Die Übertragung oder das Laden großer JAR-Dateien kann umständlich und langsam sein. Der maven-shade-plugin kann dabei helfen, indem es Ihnen ermöglicht, unnötige Dateien und Klassen auszuschließen und so die Größe des endgültigen JAR zu reduzieren. Sie können das Plugin auch so konfigurieren, dass die JAR-Datei minimiert wird, indem nicht wesentliche Informationen wie ungenutzte Klassen oder redundante Ressourcen entfernt werden. Diese erweiterten Konfigurationen können besonders nützlich sein, wenn Sie an großen Projekten mit zahlreichen Abhängigkeiten arbeiten.

Abschließende Gedanken zu ausführbaren Maven-JARs

Das Erstellen einer ausführbaren JAR-Datei mit Abhängigkeiten mithilfe von Maven vereinfacht den Bereitstellungsprozess für Java-Anwendungen. Durch die richtige Konfiguration des pom.xml Durch die Verwendung von Plugins wie dem Maven Assembly Plugin oder dem Maven Shade Plugin können Entwickler alle erforderlichen Abhängigkeiten in einer einzigen JAR-Datei packen. Dieser Ansatz stellt sicher, dass die Anwendung nahtlos in verschiedenen Umgebungen ausgeführt werden kann, was die Verteilung und Ausführung vereinfacht. Wenn Sie diese Schritte befolgen, können Sie die Abhängigkeiten Ihres Projekts effektiv verwalten und zuverlässige, ausführbare JAR-Dateien erstellen.