Laden Sie Quellen und Javadocs mit Maven herunter

1. Übersicht

Ein Blick auf den Quellcode und die Dokumentation verschiedener Bibliotheken und Frameworks ist eine gute Möglichkeit, mehr über sie zu erfahren.

In diesem kurzen Tutorial erfahren Sie, wie Sie Maven konfigurieren oder Maven bitten, die Abhängigkeitsquellen und ihre Javadocs für uns herunterzuladen.

2. Befehlszeile

Standardmäßig lädt Maven nur die eigentliche JAR-Datei jeder Abhängigkeit herunter, nicht die Quellen und Dokumentationsdateien.

Um nur die Quellen herunterzuladen , müssen wir zuerst zu dem Verzeichnis navigieren, das die Datei pom.xml enthält, und dann den folgenden Befehl ausführen:

mvn dependency:sources

Das Herunterladen der Quellen kann eine Weile dauern. In ähnlicher Weise zum Download einfach die Javadocs, können wir den Befehl :

mvn dependency:resolve -Dclassifier=javadoc

Natürlich können wir beide auch in einem Befehl herunterladen:

mvn dependency:sources dependency:resolve -Dclassifier=javadoc

Wenn wir nach der Ausgabe dieser Befehle eine neue Abhängigkeit hinzufügen, müssen wir die Befehle erneut ausgeben, um Quellen und Javadocs für die neue Abhängigkeit herunterzuladen.

3. Maven-Einstellungen

Es ist auch möglich, Quellen und Dokumentationen systemweit für alle Maven-Projekte herunterzuladen . Dazu sollten wir die Datei ~ / m2 / settings.xml bearbeiten oder eine erstellen und die folgende Konfiguration hinzufügen:

    downloadSources  true true     downloadSources  

Wie oben gezeigt, erstellen wir ein Profil und aktivieren es standardmäßig. In diesem Profil legen wir zwei Eigenschaften fest, die Maven anweisen, Quellen und Dokumentation herunterzuladen. Darüber hinaus wendet Maven diese Einstellungen auf alle Projekte an.

4. Die pom.xml

Es ist sogar möglich, diese Konfiguration in die Datei pom.xml einzufügen . Auf diese Weise zwingen wir alle Projektmitarbeiter, im Rahmen der Abhängigkeitsauflösung Quellen und Dokumentationen herunterzuladen :

   org.apache.maven.plugins maven-dependency-plugin 3.1.2    sources resolve   javadoc      

Hier konfigurieren wir das Maven-Dependency-Plugin , um die Quellen und die Dokumentation herunterzuladen.

5. IDE-Setup

Wir können auch unsere bevorzugten IDEs einrichten, um dies für uns zu tun. In IntelliJ IDEA müssen wir beispielsweise nur zu Einstellungen> Erstellen, Ausführen, Bereitstellen> Build-Tools> Maven> Importieren gehen und die Kontrollkästchen für Quellen und Dokumentation aktivieren und aktivieren:

6. Fazit

In diesem kurzen Tutorial haben wir gesehen, wie Abhängigkeitsquellen und Dokumentation in Maven auf verschiedene Arten heruntergeladen werden können, von Befehlszeilenlösungen bis hin zu projekt- oder systemweiten Konfigurationen.