So öffnen Sie launch.json in VS Code

Effektives Debuggen und Codequalität sind untrennbare Konzepte in der Softwareentwicklung. Die Debugging-Funktionalität von Visual Studio (VS)-Code wird hauptsächlich durch die Datei launch.json gesteuert. Mit dieser Datei können Entwickler Debugging-Einstellungen entsprechend ihrer Vision konfigurieren und verwalten.

Dieser Artikel führt Sie durch das Öffnen und Verwalten der Datei launch.json für ein optimales Debugging.

Öffnen von launch.json in Visual Studio Code

Um die Debugging-Einstellungen von VS Code zu konfigurieren und zu verwalten, benötigen Sie Zugriff auf die Datei launch.json. Diese Datei spielt eine Schlüsselrolle beim Debuggen von Anpassungen.

Öffnen Sie Visual Studio Code.
Drücken Sie Strg + Umschalt + P, um die Befehlspalette zu öffnen.
Geben Sie „Open launch.json“ in die Befehlsleiste ein und drücken Sie die Eingabetaste. Dies sollte Ihre launch.json-Datei öffnen.
Wenn die Datei „launch.json“ nicht geöffnet wird, prüfen Sie, ob der Ordner „.vscode“ im Stammordner Ihres Projekts vorhanden ist.
Wenn es nicht vorhanden ist, erstellen Sie einen neuen Ordner mit dem Namen „.vscode“ in Ihrem Benutzerordner.
Erstellen Sie eine neue Datei „launch.json“ und legen Sie sie in diesem Ordner ab.

Die Datei „launch.json“ steht nach der Aktivierung zur Konfiguration bereit.

Ein Überblick über die Launch.json-Struktur

Launch.json zeigt die Abschnitte „Version“ und „Konfiguration“. Der Abschnitt „config“ ist eine Zeichenfolge mit verschiedenen Debugging-Optionen, die Sie zum Konfigurieren Ihres Debugging-Schemas verwenden.

Jedes Objekt im Array „configuration“ stellt ein Debugging-Szenario dar. Diese Objekte verfügen über Eigenschaften, die die Debugumgebung definieren, z. B. Sprach-, Programm- und Debuggereinstellungen.

Zu den allgemeinen Eigenschaften, die Sie in launch.json-Konfigurationen finden, gehören:

„Name“ – leicht lesbarer Name der Konfiguration zur Erkennung im Dropdown-Menü.
„type“ – Gibt den Typ des Debuggers an (z. B. „node“, „python“ oder „cppvsdbg“).
„request“ – Gibt den Typ der Anfrage an, entweder „start“ (um eine neue Instanz zu starten) oder „attach“ (um einen Debugger an einen vorhandenen Prozess anzuhängen).
„Programm“ – Der Pfad zu der Datei, die Sie debuggen möchten.
„args“ – Ein Array von Befehlszeilenargumenten, die beim Debuggen an das Programm übergeben werden.
„preLaunchTask“ – eine Aufgabe, die vor dem Start des Debuggers ausgeführt werden muss.

Wenn Sie die Struktur der Datei „launch.json“ verstehen, wissen Sie, welche Optionen Sie ändern und welche beibehalten müssen, wenn Sie Ihre Debugumgebung anpassen.

Konfigurieren der Starteinstellungen für verschiedene Sprachen

Die Schritte zum Konfigurieren der Starteinstellungen können je nach Sprache leicht variieren. Hier sind die Schritte für einige beliebte Sprachen.

JavaScript und TypeScript

Erstellen Sie eine neue launch.json-Datei und konfigurieren Sie die Eigenschaft „type“ als „node“ für JavaScript oder „pwa-node“ für TypeScript.
Setzen Sie die Eigenschaft „request“ auf „run“ oder „attach“.
Sie sollten die Einstiegspunktdatei mit der Eigenschaft „Programm“ angeben.

Python

Installieren Sie den Python-Interpreter und die Erweiterung für Visual Studio Code.
Setzen Sie die Eigenschaft „type“ in der neuen Datei launch.json auf „python“.
Konfigurieren Sie die Eigenschaft „request“ als „launch“ oder „attach“.
Geben Sie die auszuführende Python-Datei mit der Eigenschaft „Programm“ an.
Möglicherweise müssen Sie zusätzlich die Eigenschaft „pythonPath“ auf den Python-Interpreterpfad festlegen, wenn dieser sich nicht am Standardspeicherort befindet.

C# und .NET Core

Installieren Sie die C#-Erweiterung für Visual Studio Code.
Setzen Sie in der neuen Datei launch.json die Eigenschaft „type“ auf „coreclr“ für .NET Core oder „clr“ für .NET Framework.
Konfigurieren Sie die Eigenschaft „request“ als „launch“ oder „attach“.
Geben Sie die Einstiegspunktdatei mit der Eigenschaft „Programm“ an.
Setzen Sie die Eigenschaft „cwd“ bei Bedarf auf das Arbeitsverzeichnis des aktuellen Projekts.

Java

Installieren Sie das Java Extension Pack.
Erstellen Sie eine neue launch.json-Datei und setzen Sie die Eigenschaft „type“ auf „java“.
Konfigurieren Sie die Eigenschaft „request“ als „launch“ oder „attach“.
Geben Sie die Hauptklasse mit der Eigenschaft „mainClass“ an.
Legen Sie die Eigenschaft „projectName“ auf den Namen Ihres Java-Projekts fest.
Konfigurieren Sie die Eigenschaft „classpath“ so, dass sie die Java-Bibliotheken enthält, die Sie während der Java-Entwicklung verwenden werden.

Konfigurationsrezepte zum Debuggen

Im folgenden Abschnitt werden verschiedene Konfigurationsrezepte zum Debuggen behandelt.

Anhängen eines Debuggers an einen laufenden Prozess

So hängen Sie einen Debugger an einen laufenden Prozess an:

Setzen Sie die Eigenschaft „request“ auf „attach“.
Wählen Sie eine Prozess-ID oder einen Filter aus, um den zu debuggenden Prozess zu finden.

Debuggen von Remote-Anwendungen

So debuggen Sie eine Anwendung remote:

Verwenden Sie den Typ „Remote“.
Geben Sie die Hostadresse, den Port und alle Authentifizierungsinformationen an, um die Verbindung herzustellen.

Debuggen Sie Unit-Tests und Testsuiten

Beim Debuggen von Komponententests und Testsuiten:

Verwenden Sie eine Konfiguration, die ein Testframework und Debugging-Einstellungen in Komponententests und Testsuiten umfasst.
Definieren Sie eine Testsuite oder einzelne Testdateien in der Eigenschaft „program“ oder „args“, um auf bestimmte Tests abzuzielen.

Übergabe von Umgebungsvariablen

Die Eigenschaft „env“ in launch.json kann während des Debuggens Umgebungsvariablen an Ihre Anwendung übergeben. Diese Eigenschaft ist ein Objekt, das die Schlüssel-Wert-Paare für die Umgebungsvariablen enthält, die Sie festlegen möchten.

Erweitertes Debugging

Lassen Sie uns einige fortgeschrittene Debugging-Techniken für Benutzer erkunden, die etwas mehr Leistung aus ihren Debugdateien herausholen möchten.

Bedingte Bruchstellen und logarithmische Punkte

Bedingte Haltepunkte und Protokollierungspunkte verbessern das Debuggen, indem sie Nachrichten nur unter bestimmten Bedingungen anhalten oder protokollieren. Um sie zu verwenden:

Klicken Sie mit der rechten Maustaste auf die Zeilennummer, in der Sie den Haltepunkt oder Protokollpunkt festlegen möchten.
Wählen Sie „Bedingten Haltepunkt hinzufügen“ oder „Logistischen Punkt hinzufügen“.
Geben Sie eine Bedingung oder Nachricht ein, um die Aktion auszulösen.

Originalkarten

Mit Quellkarten können Sie Code debuggen, der transformiert oder minimiert wurde.

Setzen Sie die Eigenschaft „sourceMap“ in der launch.json-Konfiguration auf „true“, um die Quellkarten zu verwenden.
Stellen Sie sicher, dass Ihr Build-Prozess Quellkarten und transformierten Code generiert.

Integration externer Debugging-Programme

Wenn Sie möchten, können Sie externe Debugger und Tools wie gdb oder lldb in VS Code integrieren.

Installieren Sie die ausgewählte Debugger-Erweiterung.
Konfigurieren Sie die Debugger-Einstellungen in der Datei launch.json.

Debuggen von Multithread-Anwendungen

Beim Debuggen von Multithread-Anwendungen können Sie die Ausführung einzelner Threads steuern.

Verwenden Sie die „Threads“-Ansicht in der Debug-Seitenleiste, um Threads während einer Debugging-Sitzung zu verwalten.
Sie können die Codeausführung für jeden Thread separat anhalten, fortsetzen oder schrittweise durchlaufen.

Multi-Target-Debugging

Komplexe Startkonfigurationen ermöglichen das gleichzeitige Debuggen mehrerer Ziele. Wenn Sie diese Funktion nutzen möchten, fügen Sie ein Feld „Verbindungen“ mit den Namen der Gruppierungskonfigurationen hinzu. Führen Sie sie aus, indem Sie den komplexen Konfigurationsnamen aus dem Dropdown-Menü „Debuggen“ auswählen.

Konfigurieren Sie mehrere Startkonfigurationen für unterschiedliche Dienste, Funktionen oder Endpunkte, um Microservices und serverlose Anwendungen zu debuggen. Verwenden Sie komplexe Startkonfigurationen, um diese Ziele gemeinsam zu starten.

Erstellen Sie für Multi-Root-Arbeitsbereiche separate launch.json-Dateien für jeden Ordner. Konfigurieren Sie die Starteinstellungen für jeden Stammordner separat, um Projekte einzeln oder gleichzeitig mithilfe von Joins zu debuggen.

Beheben Sie häufige Probleme mit launch.json

Manchmal ist das Debuggen anfällig für eigene Fehler. Schauen wir uns einige häufige Probleme und deren Behebung an.

Fehler bei der Schemavalidierung

Schemavalidierungsfehler treten auf, wenn die Datei launch.json ungültige Eigenschaften oder Werte aufweist. So korrigieren Sie Schemafehler:

Überprüfen Sie die Fehlermeldungen im Bereich „Probleme“.
Aktualisieren Sie die Datei launch.json entsprechend den Informationen aus der Fehlermeldung.

Debuggen

Falsche Starteinstellungen können zu Debugging-Fehlern führen.

Überprüfen Sie Ihre Startkonfigurationen auf falsche Dateipfade.
Suchen Sie nach fehlenden oder falschen Debugger- oder Anforderungstypen.
Aktualisieren Sie die Einstellungen nach Bedarf.

Diagnose von Startkonfigurationsproblemen

So diagnostizieren Sie Probleme mit Startkonfigurationen:

Aktivieren Sie die Diagnoseprotokollierung, indem Sie die Eigenschaft „trace“ auf „verbose“ setzen.
Überprüfen Sie die generierten Protokolle in der Debug-Konsole, um etwaige Probleme zu identifizieren und zu beheben.

Tipps für launch.json

Nutzen Sie launch.json optimal mit diesen Tipps:

Verwenden Sie aussagekräftige Namen für Ihre Startkonfigurationen, um sie leicht zu identifizieren. Diese Vorgehensweise hilft Ihnen, schnell die geeignete Konfiguration zu finden, wenn Sie mit mehreren Debug-Szenarien arbeiten.
Teilen Sie Startkonfigurationen mit Ihrem Team, indem Sie die Datei „launch.json“ in das Versionskontrollsystem Ihres Projekts aufnehmen. Jedes Teammitglied kann auf dieselben Konfigurationen und Debug-Einstellungen zugreifen.
Versionskontrollsysteme wie Git können Änderungen an Ihrer launch.json-Datei verfolgen. Mithilfe der Versionskontrolle können Sie zu früheren Konfigurationen zurückkehren und mit anderen Teammitgliedern zusammenarbeiten, indem Sie empfohlene Einstellungen mit ihnen teilen.
Installieren Sie Erweiterungen, die bestimmte Sprachen, Debugger oder Tools unterstützen, die den Anforderungen Ihres Projekts entsprechen. Konfigurieren Sie die Datei launch.json, um diese Erweiterungen und ihre Funktionen während Debugging-Sitzungen zu verwenden.

Beginnen Sie mit dem Debuggen

Durch die Nutzung der Leistungsfähigkeit von launch.json können Sie Ihr Debugging-Erlebnis so anpassen, dass es optimal zu Ihrem Codierungsstil passt. Dadurch wird die Qualität und Leistung Ihres Codes verbessert.

Wie oft müssen Sie Starteinstellungen konfigurieren? Irgendwelche Konfigurationstipps? Teilen Sie Ihre Erfahrungen im Kommentarbereich unten.