Java-Build-Tools in VS Code

Dieses Dokument bietet einen Überblick über die Arbeit mit Ihren Java-Build-Tools in Visual Studio Code. Es behandelt die Erweiterungen Maven for Java und Gradle for Java sowie weitere Werkzeuge.

Wenn bei der Verwendung der unten aufgeführten Funktionen Probleme auftreten, können Sie uns kontaktieren, indem Sie ein Problem melden.

Maven

Maven ist ein Software-Tool, das Sie bei der Verwaltung von Java-Projekten und der Automatisierung von Anwendungs-Builds unterstützt. Die Erweiterung Maven for Java für Visual Studio Code bietet eine vollständig integrierte Maven-Unterstützung, mit der Sie Maven-Projekte durchsuchen, Maven-Befehle ausführen und Ziele des Build-Lebenszyklus sowie Plugins ausführen können. Wir empfehlen die Installation des Extension Pack for Java, das Maven-Unterstützung sowie weitere wichtige Funktionen für die Java-Entwicklung enthält.

Extension Pack for Java installieren

Erkunden von Maven-Projekten

Sobald ein Maven-Projekt geladen ist, wird die Erweiterung aktiviert. Sie scannt automatisch Ihren Arbeitsbereich nach pom.xml-Dateien und zeigt alle Maven-Projekte und deren Module in der Seitenleiste an.

Unbekannten Typ auflösen

Die Maven-Erweiterung unterstützt auch die Suche in Maven Central, um unbekannte Typen in Ihrem Quellcode aufzulösen. Dies können Sie tun, indem Sie den Link Resolve unknown type (Unbekannten Typ auflösen) auswählen, der beim Darüberfahren mit der Maus angezeigt wird.

Arbeiten mit POM.xml

Die Erweiterung bietet Code-Snippets und Auto-Vervollständigung zum Hinzufügen von Maven-Abhängigkeiten basierend auf lokalen Maven-Repositories. Sehen Sie, wie einfach es ist, mit diesen komfortablen Funktionen eine neue Abhängigkeit zu Ihrer pom.xml hinzuzufügen.

Die Erweiterung ermöglicht es Ihnen auch, ein effektives POM zu generieren.

Sie können auch den Befehl Maven: Add a Dependency (oder maven.project.addDependency) verwenden, um eine neue Abhängigkeit zur pom.xml hinzuzufügen. Der Prozess ist interaktiv.

Sie können Abhängigkeiten auch über die Projektansicht hinzufügen, welche denselben Maven-Befehl aufruft.

Darüber hinaus unterstützt VS Code die Anzeige von Abhängigkeiten in einer Baumansicht, wodurch Sie alle Abhängigkeiten Ihres Projekts an einem Ort untersuchen und auf potenzielle Probleme prüfen können.

Ausführen von Maven-Befehlen und Zielen

Durch Rechtsklick auf jedes Maven-Projekt im Explorer können Sie bequem Maven-Ziele (Goals) ausführen.

Die Erweiterung speichert zudem den Verlauf der Ziele für jedes Projekt, sodass Sie den vorherigen Befehl schnell erneut ausführen können – nützlich, wenn Sie ein langes, benutzerdefiniertes Ziel ausführen.

Es gibt zwei Möglichkeiten, ein Ziel erneut auszuführen

1. Führen Sie in der Befehlspalette Maven: History aus und wählen Sie dann ein Projekt sowie einen Befehl aus dessen Verlauf.
2. Klicken Sie mit der rechten Maustaste auf ein Projekt und wählen Sie History. Sie können dann einen früheren Befehl aus dem Verlauf auswählen.

Sie können in den Einstellungen auch Ihre bevorzugten Befehle für zukünftige Ausführungen festlegen.

Für jedes Plugin, das Sie in Ihrem Projekt verwenden, bietet die Erweiterung einen einfachen Zugriff auf die Ziele innerhalb des jeweiligen Plugins.

Um Maven-Ziele zu debuggen, klicken Sie mit der rechten Maustaste auf ein Ziel und starten das Debugging. Die Maven-Erweiterung ruft den Java-Debugger mit den richtigen Parametern auf. Dies ist eine praktische und zeitsparende Funktion.

Projekt aus Maven-Archetyp generieren

Eine weitere praktische Funktion dieser Erweiterung ist das Generieren eines Maven-Projekts aus einem Archetyp. Die Erweiterung lädt Archetypen, die in lokalen/entfernten Katalogen gelistet sind. Nach der Auswahl sendet die Erweiterung mvn archetype:generate -D... an das Terminal.

Es gibt mehrere Möglichkeiten, ein Maven-Projekt zu erstellen

1. Wählen Sie im Maven-Explorer die Schaltfläche + Create Maven Project.

   

2. Öffnen Sie die Befehlspalette (⇧⌘P (Windows, Linux Ctrl+Shift+P)) und suchen Sie nach dem Befehl Create Java Project.

3. Klicken Sie mit der rechten Maustaste auf einen Zielordner und wählen Sie Create Maven Project.

Gradle

VS Code unterstützt Gradle-Java-Projekte (außer Android) durch die Erweiterung Gradle for Java. Diese Erweiterung bietet verschiedene Komponenten, um Ihre Erfahrung mit Gradle-Java-Projekten zu verbessern:

• Gradle Build Server: Der Gradle Build Server wird zum Importieren von Gradle-Projekten verwendet und delegiert Build-Aufgaben an den Gradle-Daemon, wodurch konsistente Projektergebnisse wie bei der Ausführung von Gradle-Aufgaben über die Befehlszeile sichergestellt werden.
• Visuelle Schnittstelle: Ermöglicht es Ihnen, Gradle-Aufgaben und Projektabhängigkeiten anzuzeigen und zu verwalten sowie Gradle-Aufgaben direkt in VS Code auszuführen.
• Gradle Language Server: Bietet eine verbesserte Bearbeitungserfahrung für Gradle-Build-Dateien, einschließlich Syntax-Hervorhebung, Fehlerberichterstattung und Auto-Vervollständigung.

Gradle Build Server

Wenn die Erweiterung "Gradle for Java" installiert ist, wird standardmäßig der Gradle Build Server für den Import von Gradle-Projekten verwendet. Sie können den Gradle Build Server ein- oder ausschalten, indem Sie java.gradle.buildServer.enabled konfigurieren.

Sie können die Gradle-Build-Ausgabe im Ausgabekanal "Build Server for Gradle (Build)" einsehen und die Interaktionen zwischen VS Code und dem Gradle Build Server im Ausgabekanal "Build Server for Gradle (Log)" nachverfolgen.

Delegierung von Tests an Gradle

Die Erweiterung unterstützt die Delegierung der Testausführung an Gradle. Sie können das zu verwendende Testprofil im Testing Explorer konfigurieren.

Hinweis: Stellen Sie sicher, dass Sie die Erweiterung Test Runner for Java installiert haben, um diese Funktion nutzen zu können.

Arbeiten mit Gradle-Aufgaben

Wenn Sie ein Gradle-Projekt in VS Code öffnen, finden Sie nützliche Gradle-Ansichten, indem Sie auf das Gradle-Element in der Seitenleiste klicken. Die Ansicht Gradle Projects listet alle im Arbeitsbereich gefundenen Gradle-Projekte auf. Hier können Sie Gradle-Aufgaben anzeigen, ausführen oder debuggen.

Wenn es viele Gradle-Aufgaben im Arbeitsbereich gibt, kann es schwierig sein, eine bestimmte Aufgabe zu finden. Die Erweiterung bietet eine Ansicht Pinned Tasks (Angepinnte Aufgaben), mit der Sie Ihre bevorzugten Aufgaben anpinnen können, um sie leicht in einer separaten Ansicht zu finden. Sie können auch kürzlich ausgeführte Aufgaben in der Ansicht Recent Tasks sehen.

Anzeigen von Gradle-Abhängigkeiten

In der Ansicht Gradle Projects finden Sie unter jedem Gradle-Projektelement einen Punkt Dependencies. Er enthält alle Abhängigkeiten in Ihrer angegebenen Konfiguration; so können Sie den Abhängigkeitsstatus Ihres Projekts leicht überprüfen.

Verwaltung von Gradle Daemons

Die Ansicht Gradle Daemons zeigt den Daemon-Status des aktuellen Arbeitsbereichs. Sie listet alle laufenden Gradle-Daemons auf, die dieselbe Version wie der Arbeitsbereich haben. Sie können in dieser Ansicht einen bestimmten oder alle Daemons stoppen.

Erstellen von Build-Dateien

Die Erweiterung bietet einige nützliche Funktionen zum Erstellen von Gradle-Build-Dateien.

Beim Öffnen einer Groovy-Gradle-Datei analysiert die Erweiterung die Datei und liefert semantische Token-Informationen, was zu präziseren Hervorhebungsergebnissen führt.

In der Ansicht Outline bietet die Erweiterung die Dokumentsymbole der geöffneten Gradle-Datei, was Ihnen hilft, leicht zu jedem Teil der Datei zu navigieren.

Falls in der geöffneten Gradle-Datei Syntaxfehler vorliegen (fehlende Zeichen, Typ nicht gefunden, etc.), können Sie diese in der Ansicht Problems sehen.

Die Erweiterung unterstützt grundlegende Auto-Vervollständigungen für Gradle-Dateien. Wenn Sie versuchen, Gradle-Closures oder Eigenschaften in einem Gradle-Skript zu tippen, schlägt die Erweiterung verfügbare Closures oder Eigenschaften für Sie vor.

Wenn Sie versuchen, eine neue Abhängigkeit zu deklarieren, stellt Ihnen die Erweiterung eine Liste mit Kandidaten zur Verfügung.

Zusätzliche Ressourcen

Besuchen Sie das GitHub-Repo der Maven-Erweiterung für zusätzliche Konfigurationen und eine Fehlerbehebungsanleitung.

Zusätzlich zu Maven gibt es auch eine Bazel-Erweiterung, falls Sie Bazel zum Erstellen und Testen Ihres Projekts verwenden.

Nächste Schritte

Lesen Sie weiter, um mehr über Folgendes zu erfahren:

• Java-Bearbeitung – Entdecken Sie die Bearbeitungsfunktionen für Java in VS Code.
• Java-Debugging – Finden Sie heraus, wie Sie Ihr Java-Projekt mit VS Code debuggen.
• Java-Testing – Nutzen Sie VS Code für Ihre JUnit- und TestNG-Fälle.
• Java-Erweiterungen - Erfahren Sie mehr über nützliche Java-Erweiterungen für VS Code.