Jak otworzyć launch.json w VS Code
Skuteczne debugowanie i jakość kodu to nierozłączne pojęcia w tworzeniu oprogramowania. Funkcja debugowania programu Visual Studio (VS) Code jest kontrolowana głównie przez plik launch.json. Ten plik umożliwia programistom konfigurowanie i zarządzanie ustawieniami debugowania zgodnie z ich wizją.
Ten artykuł przeprowadzi Cię przez proces otwierania i zarządzania plikiem launch.json w celu optymalnego debugowania.
Otwieranie pliku launch.json w programie Visual Studio Code
Aby skonfigurować ustawienia debugowania VS Code i zarządzać nimi, potrzebujesz dostępu do pliku launch.json. Ten plik odgrywa kluczową rolę w dostosowywaniu debugowania.
- Otwórz kod programu Visual Studio.
- Naciśnij Ctrl + Shift + P, aby otworzyć paletę poleceń.
- Wpisz „Otwórz launch.json” w palecie poleceń i naciśnij „Enter”. To powinno otworzyć plik launch.json.
- Jeśli plik launch.json nie otwiera się, sprawdź, czy folder „.vscode” istnieje w folderze głównym projektu.
- Jeśli nie istnieje, utwórz nowy folder o nazwie „.vscode” w swoim folderze użytkownika.
- Utwórz nowy plik „launch.json” i umieść go w tym folderze.
Plik launch.json będzie gotowy do skonfigurowania po jego włączeniu.
Omówienie struktury Launch.json
Plik launch.json wyświetla sekcje „wersja” i „konfiguracje”. Sekcja „konfiguracje” to tablica zawierająca różne opcje debugowania, których użyjesz do skonfigurowania schematu debugowania.
Każdy obiekt w tablicy „configurations” reprezentuje scenariusz debugowania. Te obiekty mają właściwości definiujące środowisko debugowania, takie jak ustawienia języka, programu i debugera.
Niektóre typowe właściwości, które napotkasz w konfiguracjach launch.json, obejmują:
- „nazwa” – Przyjazna dla czytelnika nazwa konfiguracji w celu jej identyfikacji w rozwijanym menu.
- „typ” — określa typ debuggera (taki jak „węzeł”, „python” lub „cppvsdbg”).
- „request” – określa typ żądania: „launch” (aby uruchomić nową instancję) lub „attach” (aby dołączyć debuger do istniejącego procesu).
- „program” — Ścieżka do pliku, który chcesz debugować.
- „args” — tablica argumentów wiersza poleceń, które mają zostać przekazane programowi podczas debugowania.
- „preLaunchTask” — zadanie do uruchomienia przed uruchomieniem debuggera.
Zrozumienie struktury pliku launch.json pozwala wiedzieć, które opcje zmienić, a które pozostawić w spokoju podczas dostosowywania środowiska debugowania.
Konfigurowanie ustawień uruchamiania dla różnych języków
Kroki konfigurowania ustawień uruchamiania mogą się nieznacznie różnić w zależności od języka. Oto kroki dla kilku popularnych języków.
JavaScript i TypeScript
- Utwórz nowy plik launch.json i skonfiguruj właściwość „type” jako „node” dla JavaScript lub „pwa-node” dla TypeScript.
- Ustaw właściwość „request” na „launch” lub „attach”.
- Powinieneś określić plik punktu wejścia za pomocą właściwości „program”.
Pyton
- Zainstaluj interpreter języka Python i rozszerzenie dla programu Visual Studio Code.
- Ustaw właściwość „type” na „python” w nowym pliku launch.json.
- Skonfiguruj właściwość „request” jako „launch” lub „attach”.
- Określ plik Pythona do uruchomienia za pomocą właściwości „program”.
- Może być konieczne dodatkowe ustawienie właściwości „pythonPath” na ścieżkę interpretera Pythona, jeśli nie znajduje się ona w lokalizacji domyślnej.
C# i. rdzeń sieciowy
- Zainstaluj rozszerzenie C# dla programu Visual Studio Code.
- W nowym pliku launch.json ustaw właściwość „type” na „coreclr” dla. NET Core lub „clr” dla. NET Framework.
- Skonfiguruj właściwość „request” jako „launch” lub „attach”.
- Określ plik punktu wejścia, używając właściwości „program”.
- W razie potrzeby ustaw właściwość „cwd” na katalog roboczy bieżącego projektu.
Jawa
- Zainstaluj pakiet rozszerzeń Java.
- Utwórz nowy plik launch.json i ustaw właściwość „type” na „java”.
- Skonfiguruj właściwość „request” jako „launch” lub „attach”.
- Określ klasę główną za pomocą właściwości „mainClass”.
- Ustaw właściwość „projectName” na nazwę swojego projektu Java.
- Skonfiguruj właściwość „classpath”, aby uwzględnić biblioteki Java, których będziesz używać podczas programowania w języku Java.
Zasady konfiguracji debugowania
W poniższej sekcji omówiono różne przepisy dotyczące konfiguracji debugowania.
Dołączanie debugera do uruchomionego procesu
Aby dołączyć debuger do uruchomionego procesu:
- Ustaw właściwość „request” na „attach”.
- Wybierz identyfikator procesu lub filtr, aby znaleźć proces do debugowania.
Zdalne debugowanie aplikacji
Do zdalnego debugowania aplikacji:
- Użyj typu „zdalnego”.
- Podaj adres hosta, port i ewentualnie informacje uwierzytelniające, aby nawiązać połączenie.
Debugowanie testów jednostkowych i zestawów testów
Podczas debugowania testów jednostkowych i zestawów testów:
- Użyj konfiguracji obejmującej platformę testową i ustawienia do debugowania testów jednostkowych i zestawów testów.
- Zdefiniuj zestaw testów lub poszczególne pliki testów we właściwościach „program” lub „args”, aby kierować określone testy.
Przekazywanie zmiennych środowiskowych
Właściwość „env” w pliku launch.json może przekazywać zmienne środowiskowe do aplikacji podczas debugowania. Ta właściwość jest obiektem zawierającym pary klucz-wartość dla zmiennych środowiskowych, które chcesz ustawić.
Zaawansowane debugowanie
Przyjrzyjmy się niektórym zaawansowanym technikom debugowania dla użytkowników, którzy chcą wycisnąć trochę więcej mocy z plików debugowania.
Warunkowe punkty przerwania i punkty logowania
Warunkowe punkty przerwania i punkty rejestrowania usprawniają debugowanie, wstrzymując lub rejestrując komunikaty tylko w określonych warunkach. Aby z nich skorzystać:
- Kliknij prawym przyciskiem myszy numer wiersza, w którym chcesz ustawić punkt przerwania lub punkt logowania.
- Wybierz „Dodaj warunkowy punkt przerwania” lub „Dodaj punkt logowania”.
- Wprowadź warunek lub wiadomość, aby uruchomić akcję.
Mapy źródłowe
Mapy źródłowe umożliwiają debugowanie kodu, który został przekształcony lub zminimalizowany.
- Ustaw właściwość „sourceMap” na „true” w konfiguracji launch.json, aby używać map źródłowych.
- Upewnij się, że proces kompilacji generuje mapy źródłowe i przekształcony kod.
Integracja zewnętrznych debugerów
Jeśli chcesz, możesz zintegrować zewnętrzne debugery i narzędzia, takie jak gdb lub lldb, z VS Code.
- Zainstaluj wybrane rozszerzenie debugera.
- Skonfiguruj ustawienia debugera w pliku launch.json.
Debugowanie aplikacji wielowątkowych
Podczas debugowania aplikacji wielowątkowych można kontrolować wykonywanie poszczególnych wątków.
- Użyj widoku „wątki” na pasku bocznym debugowania, aby zarządzać wątkami podczas sesji debugowania.
- Możesz wstrzymać, wznowić lub przejść przez wykonanie kodu dla każdego wątku osobno.
Debugowanie wielu celów
Złożone konfiguracje uruchamiania umożliwiają jednoczesne debugowanie wielu celów. Jeśli chcesz skorzystać z tej funkcji, dodaj tablicę „compounds” z nazwami konfiguracji do zgrupowania. Uruchom je, wybierając nazwę konfiguracji złożonej z menu rozwijanego Debugowanie.
Skonfiguruj wiele konfiguracji uruchamiania ukierunkowanych na różne usługi, funkcje lub punkty końcowe w celu debugowania mikrousług i aplikacji bezserwerowych. Użyj złożonych konfiguracji uruchamiania, aby uruchomić te cele razem.
W przypadku obszarów roboczych z wieloma głównymi folderami utwórz osobne pliki launch.json dla każdego folderu. Skonfiguruj ustawienia uruchamiania dla każdego folderu głównego indywidualnie, aby debugować projekty osobno lub jednocześnie za pomocą związków.
Rozwiązywanie typowych problemów z plikiem launch.json
Czasami debugowanie jest podatne na własny zestaw błędów. Przyjrzyjmy się kilku typowym problemom i sposobom ich rozwiązywania.
Błędy sprawdzania poprawności schematu
Błędy sprawdzania poprawności schematu występują, gdy plik launch.json ma nieprawidłowe właściwości lub wartości. Aby naprawić błędy schematu:
- Przejrzyj komunikaty o błędach z panelu Problemy.
- Zaktualizuj plik launch.json zgodnie z informacjami zawartymi w komunikacie o błędzie.
Błędy debugowania
Nieprawidłowe ustawienia uruchamiania mogą powodować błędy debugowania.
- Sprawdź konfiguracje uruchamiania pod kątem nieprawidłowych ścieżek plików.
- Sprawdź brakujący lub nieprawidłowy debuger lub typy żądań.
- W razie potrzeby zaktualizuj ustawienia.
Diagnozowanie problemów z konfiguracją uruchamiania
Aby zdiagnozować problemy z konfiguracjami uruchamiania:
- Włącz rejestrowanie diagnostyczne, ustawiając właściwość „śledzenie” na „verbose”.
- Przejrzyj wygenerowane dzienniki w konsoli debugowania, aby zidentyfikować i naprawić wszelkie problemy.
Wskazówki dotyczące pliku launch.json
Korzystaj optymalnie z pliku launch.json, korzystając z tych wskazówek:
- Używaj znaczących nazw konfiguracji uruchamiania, aby były łatwe do zidentyfikowania. Ta praktyka pomaga szybko znaleźć odpowiednią konfigurację podczas pracy z wieloma scenariuszami debugowania.
- Udostępnij konfiguracje uruchamiania swojemu zespołowi, umieszczając plik launch.json w systemie kontroli wersji swojego projektu. Każdy członek zespołu ma dostęp do tych samych konfiguracji i ustawień debugowania.
- Systemy kontroli wersji, takie jak Git, mogą śledzić zmiany w pliku launch.json. Możesz użyć kontroli wersji, aby powrócić do poprzednich konfiguracji i współpracować z innymi członkami zespołu, udostępniając im zalecane ustawienia.
- Zainstaluj rozszerzenia obsługujące określone języki, debuggery lub narzędzia, które odpowiadają wymaganiom projektu. Skonfiguruj plik launch.json, aby używać tych rozszerzeń i ich funkcji podczas sesji debugowania.
Uruchom debugowanie
Wykorzystując moc pliku launch.json, możesz dostosować środowisko debugowania, aby najlepiej pasowało do Twojego stylu kodowania. Poprawi to jakość i wydajność Twojego kodu.
Jak często musisz konfigurować ustawienia uruchamiania? Czy masz jakieś wskazówki dotyczące konfiguracji? Podziel się swoimi doświadczeniami w sekcji komentarzy poniżej.
Dodaj komentarz