Vorgehensweise: Debuggen von Windows-Dienstanwendungen
Hinweis
Dieser Artikel gilt nicht für gehostete Dienste in .NET. Die neuesten Inhalte zu Windows-Diensten mit Microsoft.Extensions.Hosting.BackgroundService und die Workerdienstvorlage finden Sie unter:
Ein Dienst muss im Kontext des Dienststeuerelement-Managers und nicht innerhalb von Visual Studio ausgeführt werden. Aus diesem Grund ist das Debuggen eines Dienstes nicht so einfach wie das Debuggen anderer Anwendungstypen in Visual Studio. Damit ein Dienst gedebuggt werden kann, muss er gestartet werden. Danach muss ein Debugger an den Prozess angehängt werden, in dem er ausgeführt wird. Anschließend kann die Anwendung mit allen Standarddebugfunktionen von Visual Studio gedebuggt werden.
Achtung
Das Anhängen darf nur bei bekannten Prozessen durchgeführt werden. Außerdem müssen die Konsequenzen bekannt sein, wenn an den Prozess angehängt wird und dieser u. U. abgebrochen wird. Wenn z. B. an den WinLogon-Prozess angehängt und anschließend das Debuggen beendet wird, hält das System an, weil es ohne WinLogon nicht lauffähig ist.
Ein Debugger kann nur an einen Dienst angehängt werden, der ausgeführt wird. Durch den Vorgang des Anhängens wird die aktuelle Funktion des Diensts unterbrochen. Die Verarbeitung des Diensts wird nicht tatsächlich beendet oder angehalten. Das bedeutet: Wenn mit dem Debuggen eines Diensts begonnen wird, während er ausgeführt wird, befindet er sich während des Debuggens technisch gesehen weiterhin im Status Gestartet. Die Verarbeitung ist jedoch unterbrochen worden.
Nach dem Anhängen an den Prozess können Sie Haltepunkte einrichten und diese zum Debuggen des Codes verwenden. Sobald Sie das zum Anhängen des Prozesses verwendete Dialogfeld verlassen haben, befinden Sie sich im Debugmodus. Dann kann der Dienst mit dem Dienststeuerungs-Manager gestartet, beendet, angehalten und fortgesetzt werden, sodass die festgelegten Haltepunkte angesteuert werden. Nach erfolgreichem Debuggen kann der Dummydienst entfernt werden.
Dieser Artikel umfasst das Debuggen eines Dienstes, der auf dem lokalen Computer ausgeführt wird, aber Sie können auch Windows-Dienste debuggen, die auf einem Remotecomputer ausgeführt werden. Weitere Informationen finden Sie unter Remotedebuggen.
Hinweis
Das Debuggen der OnStart-Methode kann Schwierigkeiten bereiten, da vom Dienststeuerungs-Manager ein Limit von 30 Sekunden für alle Versuche erzwungen wird, einen Dienst zu starten. Weitere Informationen finden Sie unter Problembehandlung: Debuggen von Windows-Diensten.
Warnung
Um aussagekräftige Informationen für das Debuggen zu erhalten, muss der Visual Studio-Debugger Symboldateien für die Binärdateien finden, die gerade gedebuggt werden. Wenn Sie einen Dienst debuggen, den Sie in Visual Studio erstellt haben, befinden sich die Symboldateien (PDB-Dateien) in demselben Ordner wie die ausführbare Datei oder Bibliothek, und der Debugger lädt diese automatisch. Wenn Sie einen Dienst debuggen, den Sie erstellt haben, sollten Sie zuerst die Symbole für den Dienst suchen und sicherstellen, dass sie vom Debugger gefunden werden können. Weitere Informationen finden Sie unter Angeben von Symbol- und Quelldateien (PDB) im Visual Studio Debugger. Wenn Sie einen Systemprozess debuggen oder Symbole für Systemaufrufe in Ihren Diensten haben möchten, sollten Sie die Microsoft-Symbolserver hinzufügen. Weitere Informationen finden Sie unter Debugging with Symbols(Debuggen mit Symbolen).
So debuggen Sie einen Dienst
Erstellen Sie Ihren Dienst in der Debugkonfiguration.
Installieren Sie den Dienst. Weitere Informationen finden Sie unter Vorgehensweise: Installieren und Deinstallieren von Diensten.
Starten Sie den Dienst entweder mit dem Dienststeuerungs-Manager, mit dem Server-Explorer oder aus dem Code. Weitere Informationen finden Sie unter Vorgehensweise: Starten von Diensten.
Starten Sie Visual Studio mit Administratorrechten, damit Sie die Systemprozesse zuordnen können.
(Optional) Klicken Sie in Visual Studio auf der Menüleiste auf Extras und Optionen. Wählen Sie im Dialogfeld Optionen die Optionen Debuggen und Symbole aus. Aktivieren Sie das Kontrollkästchen Microsoft-Symbolserver, und klicken Sie anschließend auf die Schaltfläche OK.
Wählen Sie auf der Menüleiste aus dem Menü Debuggen oder Extras die Option An den Prozess anhängen aus. (Tastatur: STRG+ALT+P)
Das Dialogfeld Prozesse wird angezeigt.
Aktivieren Sie das Kontrollkästchen Prozesse aller Benutzer anzeigen.
Wählen Sie im Abschnitt Verfügbare Prozesse den Prozess für den Dienst aus, und klicken Sie anschließend auf Anfügen.
Tipp
Der Prozess weist den gleichen Namen wie die ausführbare Datei für den Dienst auf.
Das Dialogfeld An den Prozess anhängen wird angezeigt.
Wählen Sie die entsprechenden Optionen aus, und klicken Sie anschließend auf OK, um das Dialogfeld zu schließen.
Hinweis
Sie befinden sich jetzt im Debugmodus.
Legen Sie die Haltepunkte fest, die im Code verwendet werden sollen.
Öffnen Sie den Dienststeuerungs-Manager und bearbeiten Sie den Dienst, indem Sie Befehle zum Beenden, Anhalten und Fortsetzen ausgeben, um die festgelegten Haltepunkte anzusteuern. Weitere Informationen zum Ausführen des Dienststeuerungs-Managers finden Sie unter Vorgehensweise: Starten von Diensten. Zudem finden Sie Informationen unter Problembehandlung: Debuggen von Windows-Diensten.
Tipps zum Debuggen für Windows-Dienste
Durch das Anfügen an den Prozess des Dienstes können Sie die meisten, aber nicht alle, Codes für diesen Dienst debuggen. Z. B. weil der Dienst bereits gestartet wurde, können Sie den Code in der OnStart-Methode des Dienstes oder den Code in der Main-Methode nicht debuggen, die verwendet wird, um den Dienst auf diese Weise zu lassen. Dies kann dadurch umgangen werden, dass ein zweiter temporärer Dienst in der Dienstanweisung erstellt wird, der lediglich als Hilfsmittel für das Debuggen verwendet wird. Beide Dienste können installiert werden. Anschließend wird der Dienstprozess geladen, indem der "Dummydienst" gestartet wird. Sobald der Prozess vom temporären Dienst gestartet wurde, können Sie mit dem Anhängen an den Dienstprozess über das Menü Debuggen in Visual Studio beginnen.
Versuchen Sie, Aufrufe an die Sleep-Methode zur Verzögerung der Aktion hinzuzufügen, bis Sie sie an den Prozess anfügen können.
Versuchen Sie, das Programm in eine reguläre Konsolenanwendung umzuwandeln. Dazu schreiben Sie die Main-Methode wie folgt um, damit sie sowohl als Windows-Dienst als auch als Konsolenanwendung ausgeführt werden kann, je nachdem, wie sie gestartet wird.
Vorgehensweise: Ausführen eines Windows-Dienstes als Konsolenanwendung
Fügen Sie eine Methode zu Ihrem Dienst hinzu, die die Methoden OnStart und OnStop ausführt:
internal void TestStartupAndStop(string[] args) { this.OnStart(args); Console.ReadLine(); this.OnStop(); }Schreiben Sie die
Main-Methode wie folgt um:static void Main(string[] args) { if (Environment.UserInteractive) { MyNewService service1 = new MyNewService(args); service1.TestStartupAndStop(args); } else { // Put the body of your old Main method here. } }Legen Sie in der Registerkarte Anwendung der Projekteigenschaften den Ausgabetyp auf Konsolenanwendung fest.
Wählen Sie Debugging starten (F5) aus.
Wenn Sie das Programm als Windows-Dienst ausführen, installieren Sie es, und starten Sie sie wie gewohnt für einen Windows-Dienst. Es ist nicht notwendig, diese Änderungen rückgängig zu machen.
In einigen Fällen, z. B. beim Debuggen eines Problems, das nur beim Systemstart auftritt, müssen Sie den Windows-Debugger verwenden. Laden Sie das Windows Driver Kit (WDK) herunter, und informieren Sie sich über die Fehlerbehebung (Debugging) bei Windows-Diensten.
