Verwenden von Ablaufverfolgungs- und Debugklassen in Visual Basic .NET

2024-07-30

Dieser Artikel enthält Informationen zur Verwendung der Debug Klassen und Trace Klassen in Visual Basic .NET.

Originalproduktversion: Visual Basic .NET
Ursprüngliche KB-Nummer: 313417

Übersicht

In diesem Artikel wird die Verwendung der Debug Klassen und der Trace Klassen veranschaulicht. Diese Klassen sind in Microsoft .NET Framework verfügbar. Mithilfe dieser Klassen können Sie Informationen zur Leistung einer Anwendung während der Anwendungsentwicklung oder nach der Bereitstellung in der Produktion bereitstellen. Diese Klassen sind nur ein Teil der Instrumentierungsfeatures, die in .NET Framework verfügbar sind.

Anforderungen

In der folgenden Liste sind die empfohlenen Hardware-, Software-, Netzwerkinfrastruktur- und Service Packs aufgeführt, die Sie benötigen:

Windows
Visual Basic .NET

In diesem Artikel wird auch davon ausgegangen, dass Sie mit dem Programmdebugging vertraut sind.

Beschreibung der Technik

Die Schritte im Abschnitt "Erstellen eines Beispiels mit der Debugklasse " veranschaulichen das Erstellen einer Konsolenanwendung, die die Debug Klasse verwendet, um Informationen zur Programmausführung bereitzustellen.

Wenn das Programm ausgeführt wird, können Sie Methoden der Debug Klasse verwenden, um Nachrichten zu erzeugen, die helfen, Fehlfunktionen zu überwachen, zu erkennen oder Leistungsmessungsinformationen bereitzustellen. Standardmäßig werden die von der Debug Klasse erzeugten Nachrichten im Ausgabefenster der integrierten Entwicklungsumgebung (IDE) von Microsoft Visual Studio angezeigt.

Der Beispielcode verwendet die WriteLine Methode, um eine Nachricht zu erzeugen, auf die ein Zeilenterminator folgt. Wenn Sie diese Methode verwenden, um eine Nachricht zu erzeugen, wird jede Nachricht in einer separaten Zeile im Ausgabefenster angezeigt.

Wenn Sie die Assert Methode der Debug Klasse verwenden, zeigt das Ausgabefenster eine Meldung nur an, wenn eine angegebene Bedingung als falsch ausgewertet wird. Die Meldung wird auch in einem modalen Dialogfeld für den Benutzer angezeigt. Das Dialogfeld enthält die Meldung, den Projektnamen und die Debug.Assert Anweisungsnummer. Das Dialogfeld enthält auch drei Befehlsschaltflächen:

Abbrechen: Die Anwendung wird beendet.
Wiederholen: Die Anwendung wechselt in den Debugmodus.
Ignorieren: Die Anwendung wird fortgesetzt. Der Benutzer muss auf eine dieser Schaltflächen klicken, bevor die Anwendung fortfahren kann.

Sie können die Ausgabe auch von der Debug Klasse an andere Ziele als das Ausgabefenster weiterleiten. Die Debug Klasse verfügt über eine Auflistung mit dem Namen Listeners Listener-Objekte. Jedes Listener-Objekt überwacht Debug die Ausgabe und leitet die Ausgabe an ein angegebenes Ziel weiter. Jeder Listener in der Listeners Auflistung empfängt jede Ausgabe, die die Debug Klasse generiert. Verwenden Sie die TextWriterTraceListener Klasse, um Listener-Objekte zu definieren. Sie können das Ziel für eine TextWriterTraceListener Klasse über den Konstruktor angeben. Zu den möglichen Ausgabezielen gehören:

Das Konsolenfenster mithilfe der System.Console.Out Eigenschaft.
Eine Textdatei mithilfe der System.IO.File.CreateText("FileName.txt")) Anweisung.

Nachdem Sie ein TextWriterTraceListener Objekt erstellt haben, müssen Sie das Objekt der Debug.Listeners Auflistung hinzufügen, um die Ausgabe zu empfangen Debug .

Erstellen eines Beispiels mit der Debug-Klasse

Verwenden Sie Visual Basic .NET, um ein neues Konsolenanwendungsprojekt namens conInfo zu erstellen. Dem Projekt wird standardmäßig ein öffentliches Modul Module1 hinzugefügt.
Um Variablen zu initialisieren, die Informationen zu einem Produkt enthalten sollen, fügen Sie die folgenden Dim Anweisungen hinzu:
```
Dim sProdName As String = "Widget"
Dim iUnitQty As Integer = 100
Dim dUnitCost As Decimal = 1.03
```
Geben Sie die Nachricht an, die die Klasse als ersten Eingabeparameter der WriteLine Methode erzeugt. Drücken Sie die TASTENkombination STRG+ALT+O, um sicherzustellen, dass das Ausgabefenster sichtbar ist.
```
Debug.WriteLine("Debug Information-Product Starting ")
```
Verwenden Sie zur Lesbarkeit die Indent Methode, um nachfolgende Meldungen im Ausgabefenster einzurücken:
```
Debug.Indent()
```

Um den Inhalt ausgewählter Variablen anzuzeigen, verwenden Sie die WriteLine Methode wie folgt:

Debug.WriteLine("The product name is " & sProdName)
Debug.WriteLine("The available units on hand are " & iUnitQty)
Debug.WriteLine("The per unit cost is " & dUnitCost)

Sie können die WriteLine Methode auch verwenden, um den Namespace und den Klassennamen für ein vorhandenes Objekt anzuzeigen. Der folgende Code zeigt beispielsweise den System.Xml.XmlDocument Namespace im Ausgabefenster an:
```
Dim oxml As New System.Xml.XmlDocument()
Debug.WriteLine(oxml)
```
Um die Ausgabe zu organisieren, können Sie eine Kategorie als optionalen, zweiten Eingabeparameter der WriteLine Methode einschließen. Wenn Sie eine Kategorie angeben, lautet das Format der Meldung des Ausgabefensters "Kategorie: Nachricht". Die erste Zeile des folgenden Codes zeigt z. B. "Feld: Der Produktname ist Widget" im Ausgabefenster an:
```
Debug.WriteLine("The product name is " & sProdName, "Field")
Debug.WriteLine("The units on hand are " & iUnitQty, "Field")
Debug.WriteLine("The per unit cost is " & dUnitCost, "Field")
Debug.WriteLine("Total Cost is" & iUnitQty * dUnitCost, "Calc")
```
Das Ausgabefenster kann Meldungen nur anzeigen, wenn eine festgelegte Bedingung mithilfe WriteLineIf der Methode der Debug Klasse auf "true" ausgewertet wird. Die zu bewertende Bedingung ist der erste Eingabeparameter der WriteLineIf Methode. Der zweite Parameter ist WriteLineIf die Meldung, die nur angezeigt wird, wenn die Bedingung im ersten Parameter als wahr ausgewertet wird.
```
Debug.WriteLineIf(iUnitQty > 50, "This message WILL appear")
Debug.WriteLineIf(iUnitQty < 50, "This message will NOT appear")
```
Verwenden Sie die Assert-Methode der Debug Klasse, sodass im Ausgabefenster die Meldung nur angezeigt wird, wenn eine angegebene Bedingung als "false" ausgewertet wird:
```
Debug.Assert(dUnitCost > 1, "Message will NOT appear")
Debug.Assert(dUnitCost < 1, "Message will appear")
```
Erstellen Sie die TextWriterTraceListener Objekte für das Konsolenfenster (tr1) und für eine Textdatei mit dem Namen Output.txt (tr2), und fügen Sie dann jedes Objekt der Debug Listeners Auflistung hinzu:
```
Dim tr1 As New TextWriterTraceListener(System.Console.Out)
Debug.Listeners.Add(tr1)

Dim tr2 As New _
    TextWriterTraceListener(System.IO.File.CreateText("Output.txt"))
Debug.Listeners.Add(tr2)
```
Verwenden Sie zur Lesbarkeit die Unindent Methode, um den Einzug für nachfolgende Nachrichten zu entfernen, die von der Debug Klasse generiert werden. Wenn Sie die Indent Und die Unindent Methoden zusammen verwenden, kann der Leser die Ausgabe als Gruppe unterscheiden.
```
Debug.Unindent()
Debug.WriteLine("Debug Information-Product Ending")
```
Um sicherzustellen, dass jedes Listener-Objekt die gesamte Ausgabe empfängt, rufen Sie die Flush Methode für die Debug Klassenpuffer auf:
```
Debug.Flush()
```

Verwenden der Trace-Klasse

Sie können die Trace Klasse auch verwenden, um Nachrichten zu erstellen, die die Ausführung einer Anwendung überwachen. Die Trace klassen Debug teilen die meisten der gleichen Methoden für die Ausgabe, einschließlich:

WriteLine
WriteLineIf
Indent
Unindent
Assert
Flush

Sie können die Trace Klassen und Die Debug Klassen separat oder in derselben Anwendung verwenden. In einem Debuglösungskonfigurationsprojekt sind beide Trace und Debug die Ausgabe aktiv. Das Projekt generiert ausgaben aus beiden Klassen für alle Listener-Objekte. Ein Projekt für die Versionslösungskonfiguration generiert jedoch nur Ausgaben aus einer Trace Klasse. Das Projekt für die Versionslösungskonfiguration ignoriert alle Debug Klassenmethodenaufrufe.

Trace.WriteLine("Trace Information-Product Starting ")
Trace.Indent()

Trace.WriteLine("The product name is " & sProdName)
Trace.WriteLine("The product name is " & sProdName, "Field")
Trace.WriteLineIf(iUnitQty > 50, "This message WILL appear")
Trace.Assert(dUnitCost > 1, "Message will NOT appear")

Trace.Unindent()
Trace.WriteLine("Trace Information-Product Ending")
Trace.Flush()
Console.ReadLine()

Überprüfen, ob sie funktioniert

Stellen Sie sicher, dass "Debuggen " die aktuelle Lösungskonfiguration ist.
Wenn das Projektmappen-Explorer Fenster nicht sichtbar ist, drücken Sie die TASTENkombination STRG+ALT+L, um dieses Fenster anzuzeigen.
Klicken Sie mit der rechten Maustaste auf conInfo, und klicken Sie dann auf "Eigenschaften".
Stellen Sie im linken Bereich der conInfo-Eigenschaftenseite unter dem Konfigurationsordner sicher, dass der Pfeil auf "Debuggen" zeigt.
Klicken Sie oberhalb des Konfigurationsordners im Dropdown-Listenfeld "Konfiguration " auf "Aktiv " (Debuggen) oder "Debuggen", und klicken Sie dann auf "OK".
Drücken Sie STRG+ALT+O, um das Ausgabefenster anzuzeigen.
Drücken Sie F5, um den Code auszuführen. Wenn das Dialogfeld "Assertion fehlgeschlagen" angezeigt wird, klicken Sie auf "Ignorieren".

Drücken Sie im Konsolenfenster die EINGABETASTE. Das Programm sollte abgeschlossen sein, und das Ausgabefenster sollte die folgende Ausgabe anzeigen:

Debug Information-Product Starting
    The product name is Widget
    The available units on hand are 100
    The per unit cost is 1.03
    System.Xml.XmlDocument
    Field: The product name is Widget
    Field: The units on hand are 100
    Field: The per unit cost is 1.03
    Calc: Total cost is 103
    This message WILL appear
    ---- DEBUG ASSERTION FAILED ----
---- Assert Short Message ----
Message will appear
---- Assert Long Message ----

at Module1.Main() C:\Documents and Settings\Administrator\My
Documents\Visual Studio Projects\conInfo\Module1.vb(29)

    The product name is Widget
    The available units on hand are 100
    The per unit cost is 1.03
Debug Information-Product Ending
Trace Information-Product Starting
    The product name is Widget
    Field: The product name is Widget
    This message WILL appear
Trace Information-Product Ending

Das Konsolenfenster und die datei Output.txt sollte die folgende Ausgabe anzeigen:

(The Output.txt file is located in the same directory as the conInfo
executable, conInfo.exe. Normally this is the \bin folder of where the
project source has been stored. By default that would be C:\Documents and
Settings\User login\My Documents\Visual Studio Projects\conInfo\bin)
    The product name is Widget
    The available units on hand are 100
    The per unit cost is 1.03
Debug Information-Product Ending
Trace Information-Product Starting
    The product name is Widget
    Field: The product name is Widget
    This message WILL appear
Trace Information-Product Ending

Vollständige Codeliste

Module Module1
    Sub Main()
        Dim sProdName As String = "Widget"
        Dim iUnitQty As Integer = 100
        Dim dUnitCost As Decimal = 1.03

        Debug.WriteLine("Debug Information-Product Starting ")
        Debug.Indent()

        Debug.WriteLine("The product name is " & sProdName)
        Debug.WriteLine("The available units on hand are " & iUnitQty)
        Debug.WriteLine("The per unit cost is " & dUnitCost)

        Dim oxml As New System.Xml.XmlDocument()
        Debug.WriteLine(oxml)

        Debug.WriteLine("The product name is " & sProdName, "Field")
        Debug.WriteLine("The units on hand are " & iUnitQty, "Field")
        Debug.WriteLine("The per unit cost is " & dUnitCost, "Field")
        Debug.WriteLine("Total cost is " & iUnitQty * dUnitCost, "Calc")

        Debug.WriteLineIf(iUnitQty > 50, "This message WILL appear")
        Debug.WriteLineIf(iUnitQty < 50, "This message will NOT appear")

        Debug.Assert(dUnitCost > 1, "Message will NOT appear")
        Debug.Assert(dUnitCost < 1, "Message will appear")

        Dim tr1 As New TextWriter`Trace`Listener(System.Console.Out)
        Debug.Listeners.Add(tr1)

        Dim tr2 As New _
            TextWriterTraceListener(System.IO.File.CreateText("Output.txt"))

        Debug.Listeners.Add(tr2)

        Debug.WriteLine("The product name is " & sProdName)
        Debug.WriteLine("The available units on hand are " & iUnitQty)
        Debug.WriteLine("The per unit cost is " & dUnitCost)

        Debug.Unindent()
        Debug.WriteLine("Debug Information-Product Ending")

        Debug.Flush()

        Trace.WriteLine("`Trace` Information-Product Starting ")

        Trace.Indent()

        Trace.WriteLine("The product name is " & sProdName)
        Trace.WriteLine("The product name is " & sProdName, "Field")
        Trace.WriteLineIf(iUnitQty > 50, "This message WILL appear")
        Trace.Assert(dUnitCost > 1, "Message will NOT appear")

        Trace.Unindent()
        Trace.WriteLine("Trace Information-Product Ending")

        Trace.Flush()

        Console.ReadLine()
    End Sub
End Module

Problembehandlung

Wenn der Lösungskonfigurationstyp "Release" lautet, wird die Debug Klassenausgabe ignoriert.
Nachdem Sie eine TextWriterTraceListener Klasse für ein bestimmtes Ziel erstellt haben, TextWriterTraceListener wird die Ausgabe der Trace Klassen und der Debug Klassen empfangen. Dies geschieht unabhängig davon, ob Sie die Add Methode der Trace Klasse oder die Debug Klasse verwenden, um sie der Listeners Klasse hinzuzufügenTextWriterTraceListener.
Wenn Sie in den Trace Klassen Debug ein Listener-Objekt für dasselbe Ziel hinzufügen, wird jede Ausgabezeile dupliziert, unabhängig davon, ob Debug die Ausgabe generiert wird.Trace
```
Dim tr1 As New TextWriterTraceListener(System.Console.Out)
Debug.Listeners.Add(tr1)
Dim tr2 As New TextWriterTraceListener(System.Console.Out)
Trace.Listeners.Add(tr2)
```

Freigeben über