Verwaltung von Java-Projekten in VS Code

Die Erweiterung Project Manager for Java hilft Ihnen bei der Verwaltung Ihrer Java-Projekte und deren Abhängigkeiten. Sie unterstützt Sie außerdem beim Erstellen neuer Java-Projekte, Pakete und Klassen. Um die vollständige Java-Sprachunterstützung in Visual Studio Code zu erhalten, können Sie das Extension Pack for Java installieren, das die Erweiterung „Project Manager for Java“ bereits enthält.

Extension Pack for Java installieren

Weitere Informationen zum Einstieg in das Erweiterungspaket finden Sie im Tutorial Erste Schritte mit Java.

Projekte-Ansicht

Die Ansicht Java-Projekte hilft Ihnen dabei, Ihre Java-Projekte und deren Abhängigkeiten zu betrachten, und bietet Einstiegspunkte für Projektverwaltungsaufgaben.

Standardmäßig wird die Ansicht „Java-Projekte“ unterhalb der Explorer-Ansicht angezeigt. Falls Sie diese nicht sehen, klicken Sie auf die Schaltfläche ... in der EXPLORER-Titelleiste und wählen Sie Java-Projekte aus.

In der Überlauf-Schaltfläche der Navigationsleiste finden Sie weitere Optionen. Sie können beispielsweise zwischen einer hierarchischen Ansicht und einer flachen Ansicht wechseln.

Neben den Knoten im Explorer finden Sie Schaltflächen, die nützliche Abkürzungen für einige Aktionen bieten.

Darüber hinaus gibt es viele hilfreiche Funktionen im Kontextmenü jedes Knotens; Sie können mit der rechten Maustaste auf den Knoten im Explorer klicken, um diese aufzurufen.

Neues Java-Projekt erstellen

Sie können ein neues Java-Projekt erstellen, indem Sie auf die +-Schaltfläche in der Navigationsleiste klicken oder den Befehl Java: Create Java Project... in der Befehlspalette (⇧⌘P (Windows, Linux Ctrl+Shift+P)) ausführen. Während der Erstellung unterstützt Sie VS Code bei der Installation der erforderlichen Erweiterung(en) für Ihren Projekttyp, falls diese noch nicht installiert sind.

Java-Projekte importieren

Sie können vorhandene Java-Projekte und -Module direkt über Datei > Ordner öffnen... in Ihren Arbeitsbereich importieren (stellen Sie sicher, dass der geöffnete Ordner Ihre Build-Tool-Skripte enthält, z. B. pom.xml oder build.gradle). VS Code für Java erkennt Ihre Projekte und importiert diese automatisch.

Wenn Sie ein neues Modul zu Ihren Projekten hinzufügen, können Sie den Befehl Java: Import Java projects in workspace ausführen, um diese in Ihren Arbeitsbereich zu importieren. Dieser Befehl hilft dabei, neue Projekte in den Arbeitsbereich zu importieren, ohne das VS Code-Fenster neu laden zu müssen.

In JAR exportieren

Sie können Ihren Build über die Projektansicht oder durch Ausführen des Befehls Java: Export Jar... als JAR exportieren.

Laufzeit für Projekte konfigurieren

Da sich Java ständig weiterentwickelt, arbeiten Entwickler häufig mit mehreren JDK-Versionen. Sie können diese über die Einstellung java.configuration.runtimes Ihren lokalen Installationspfaden zuordnen. Die Einstellung hat das folgende Format:

"java.configuration.runtimes": [
  {
    "name": "JavaSE-1.8",
    "path": "/usr/local/jdk1.8.0_201"
  },
  {
    "name": "JavaSE-11",
    "path": "/usr/local/jdk-11.0.3",
    "sources" : "/usr/local/jdk-11.0.3/lib/src.zip",
    "javadoc" : "https://docs.oracle.com/en/java/javase/11/docs/api",
    "default":  true
   },
   {
    "name": "JavaSE-12",
    "path": "/usr/local/jdk-12.0.2"
   },
   {
    "name": "JavaSE-13",
    "path": "/usr/local/jdk-13"
   }
]

Hinweis: Sie können eine davon als Standard festlegen, indem Sie "default": true zum Eintrag hinzufügen. Das Standard-JDK wird für Ihre nicht verwalteten Ordner (ohne Build-Tools) verwendet.

Um zu sehen, welche JDKs für Ihre Projekte verwendet werden, können Sie den Befehl Java: Configure Java Runtime in der Befehlspalette (⇧⌘P (Windows, Linux Ctrl+Shift+P)) ausführen. Dieser Befehl öffnet eine Ansicht, die die Laufzeitinformationen für Ihre Projekte anzeigt.

JDK für Maven- und Gradle-Projekte ändern

Wenn Sie die JDK-Version für Ihre Maven- oder Gradle-Projekte ändern möchten, müssen Sie diese in Ihren Build-Skripten (pom.xml oder build.gradle) aktualisieren. Sie können auf klicken, um zu erfahren, wie Sie solche Änderungen vornehmen. Ein Klick auf navigiert Sie direkt zur Build-Skriptdatei des Projekts.

JDK für nicht verwaltete Ordner ändern

Um das JDK für nicht verwaltete Ordner (ohne Build-Tools) zu ändern, können Sie auf die Schaltfläche klicken. Es werden alle JDKs aufgelistet, und Sie können eines für Ihre nicht verwalteten Ordner auswählen.

JDKs herunterladen

Wenn Sie ein neues JDK herunterladen möchten, können Sie auf den download-Link klicken oder den Befehl Java: Install New JDK in der Befehlspalette (⇧⌘P (Windows, Linux Ctrl+Shift+P)) ausführen. Dies öffnet eine neue Ansicht, die Sie beim Herunterladen von JDKs anleitet.

Hinweis: Um Java-Vorschau-Funktionen zu aktivieren, siehe Wie kann ich VS Code mit neuen Java-Versionen verwenden?.

Classpath für nicht verwaltete Ordner konfigurieren

Die Erweiterung „Project Management for Java“ bietet eine Benutzeroberfläche zur Konfiguration des Classpaths für nicht verwaltete Ordner. Der Classpath kann manuell auf der Classpath-Konfigurationsseite festgelegt werden. Sie können diese durch Ausführen des Befehls Java: Configure Classpath aus der Befehlspalette (⇧⌘P (Windows, Linux Ctrl+Shift+P)) öffnen.

In seltenen Fällen müssen Sie möglicherweise den Java-Arbeitsbereich bereinigen, indem Sie den Befehl Java: Clean Java Language Server Workspace aus der Befehlspalette (⇧⌘P (Windows, Linux Ctrl+Shift+P)) ausführen, damit der Language Server Ihre Abhängigkeiten neu aufbauen kann.

Abhängigkeitsverwaltung

Maven-Abhängigkeit hinzufügen

Für Maven-Projekte können Sie eine Abhängigkeit hinzufügen, indem Sie auf das +-Symbol neben dem Knoten Maven Dependencies in der Projektansicht klicken.

Abhängigkeiten für nicht verwaltete Ordner verwalten

Wenn Ihr Projekt ein nicht verwalteter Ordner ohne Build-Tools ist, können Sie die Abhängigkeiten verwalten, indem Sie auf das +- oder --Symbol am Knoten Referenced Libraries (Referenzierte Bibliotheken) oder den Elementen darunter klicken. Alternativ können Sie Ihre JAR-Bibliotheken direkt auf den Knoten Referenced Libraries ziehen.

Sie können die Abhängigkeiten auch auf der Classpath-Konfigurationsseite verwalten. Siehe: Classpath für nicht verwaltete Ordner konfigurieren

Im Hintergrund gibt es eine Einstellung java.project.referencedLibraries in der Datei settings.json. Nachfolgend finden Sie Details zur Anpassung dieser Einstellung.

Bibliotheken einschließen

Die zu referenzierenden Bibliotheken werden mithilfe einer Reihe von Glob-Mustern beschrieben.

Zum Beispiel

"java.project.referencedLibraries": [
    "library/**/*.jar",
    "/home/username/lib/foo.jar"
]

Die oben genannten Einstellungen fügen alle .jar-Dateien im Bibliotheksordner des Arbeitsbereichs sowie die Datei foo.jar von einem angegebenen absoluten Pfad zu den externen Abhängigkeiten des Projekts hinzu.

Die referenzierten Bibliotheken werden dann von VS Code überwacht, und das Projekt wird aktualisiert, wenn sich eine dieser abhängigen Dateien ändert.

Standardmäßig referenziert VS Code alle JAR-Dateien im lib-Verzeichnis des Arbeitsbereichs unter Verwendung des Glob-Musters lib/**/*.jar.

Einige Bibliotheken ausschließen

Wenn Sie einige Bibliotheken vom Projekt ausschließen möchten, können Sie java.project.referencedLibraries erweitern, um die Felder include/exclude zu nutzen und ein exclude-Glob-Muster hinzuzufügen.

"java.project.referencedLibraries": {
    "include": [
        "library/**/*.jar",
        "/home/username/lib/foo.jar"
    ],
    "exclude": [
        "library/sources/**"
    ]
}

Im obigen Beispiel werden alle binären JAR-Dateien im Ordner library/sources als externe Abhängigkeiten des Projekts ignoriert.

Quell-JARs anhängen

Standardmäßig versucht eine referenzierte {binary}.jar, im selben Verzeichnis nach {binary}-sources.jar zu suchen und diese als Quelle anzuhängen, falls eine Übereinstimmung gefunden wird.

Wenn Sie manuell eine JAR-Datei als Quellanhang angeben möchten, können Sie eine Schlüssel-Wert-Zuordnung im Feld sources bereitstellen.

"java.project.referencedLibraries": {
    "include": [
        "library/**/*.jar",
        "/home/username/lib/foo.jar"
    ],
    "exclude": [
        "library/sources/**"
    ],
    "sources": {
        "library/bar.jar": "library/sources/bar-src.jar"
    }
}

Auf diese Weise wird bar-src.jar an bar.jar als Quelle angehängt.

Leichtgewichtsmodus (Lightweight Mode)

VS Code für Java unterstützt zwei Modi: „Leichtgewicht“ (Lightweight) und „Standard“. Im Leichtgewichtsmodus werden nur Quelldateien und das JDK vom Language Server aufgelöst; im Standardmodus werden importierte Abhängigkeiten aufgelöst und das Projekt vom Language Server erstellt. Der Leichtgewichtsmodus eignet sich am besten, wenn Sie eine schnell startende und schlanke Umgebung benötigen, um mit Ihren Quelldateien zu arbeiten, z. B. zum Lesen von Quellcode, Navigieren zwischen Quellcode und JDK, Anzeigen der Gliederung und Javadoc sowie zum Erkennen und Beheben von Syntaxfehlern. Auch Code-Vervollständigung wird innerhalb des Bereichs der Quelldateien und des JDK unterstützt.

Der Leichtgewichtsmodus löst weder importierte Abhängigkeiten auf noch erstellt er das Projekt; daher unterstützt er kein Ausführen, Debuggen, Refactoring, Linting oder Erkennen semantischer Fehler. Damit diese Funktionen verfügbar sind, müssen Sie Ihren Arbeitsbereich vom Leichtgewichtsmodus in den Standardmodus umschalten.

Sie können steuern, mit welchem Modus gestartet werden soll, indem Sie java.server.launchMode mit den folgenden Optionen konfigurieren:

• Hybrid (Standard) – Zunächst wird ein Arbeitsbereich im Leichtgewichtsmodus geöffnet. Sie werden gefragt, ob Sie in den Standardmodus wechseln möchten, wenn Ihr Arbeitsbereich nicht aufgelöste Java-Projekte enthält. Wenn Sie Später wählen, bleibt er im Leichtgewichtsmodus. Sie können auf das Sprachstatus-Element in der Statusleiste klicken, um manuell in den Standardmodus zu wechseln.
• Standard – Ein Arbeitsbereich wird im Standardmodus geöffnet.
• LightWeight – Ein Arbeitsbereich wird im Leichtgewichtsmodus geöffnet. Sie können auf das Sprachstatus-Element in der Statusleiste klicken, um manuell in den Standardmodus zu wechseln.

Das Sprachstatus-Element zeigt mithilfe verschiedener Symbole an, in welchem Modus sich der aktuelle Arbeitsbereich befindet.

Ein Klick auf das Sprachstatus-Element wechselt in den Standardmodus.

Build-Status

Wenn Sie Java-Quellcode in Visual Studio Code bearbeiten, erstellt der Java Language Server Ihren Arbeitsbereich, um Ihnen die notwendigen Sprachfunktionen bereitzustellen. Sie können den detaillierten Build-Task-Status sehen und beobachten, was im Hintergrund geschieht, indem Sie auf das Sprachstatus-Element in der Statusleiste klicken. Sie können auch den Link Details prüfen auswählen, wenn eine Benachrichtigung anzeigt, dass der Language Server Java-Projekte öffnet, um den Status der Build-Aufgabe zu sehen.

Zusätzliche Ressourcen

Es gibt mehrere Visual Studio Code-Erweiterungen zur Unterstützung verschiedener Build-Systeme für Java. Nachfolgend finden Sie Erweiterungen für einige gängige Build-Systeme.

• Maven für Java
• Gradle für Java
• Bazel for Java (Bazel ist für BUILD-Dateien gedacht, ohne Java-Integration)

Wenn Sie bei der Verwendung der oben genannten Funktionen auf Probleme stoßen, können Sie uns kontaktieren, indem Sie ein Issue erstellen.

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 können.
• Java-Testen – Verwenden 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.