Verwenden von Ablaufverfolgungs- und Debugklassen in Visual Basic .NET

Artikel
03/21/2024

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

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

Zusammenfassung

In diesem Artikel wird veranschaulicht, wie die Debug -Klasse und die Trace -Klasse verwendet werden. Diese Klassen sind im Microsoft .NET Framework verfügbar. Sie können diese Klassen verwenden, um Informationen zur Leistung einer Anwendung bereitzustellen, entweder während der Anwendungsentwicklung oder nach der Bereitstellung in der Produktion. Diese Klassen sind nur ein Teil der Instrumentierungsfeatures, die im .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 Debuggen von Programmen 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 Meldungen zu erzeugen, die bei der Überwachung, Erkennung von Fehlfunktionen oder zur Bereitstellung von Informationen zur Leistungsmessung helfen. Standardmäßig werden die von der Debug Klasse erzeugten Meldungen 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 Zeilenabschlusszeichen 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 nur dann eine Meldung an, wenn eine angegebene Bedingung als false ausgewertet wird. Die Meldung wird dem Benutzer auch in einem modalem Dialogfeld angezeigt. Das Dialogfeld enthält die Meldung, den Projektnamen und die Debug.Assert Anweisungsnummer. Das Dialogfeld enthält auch drei Befehlsschaltflächen:

Abbruch: Die Anwendung wird nicht mehr ausgeführt.
Wiederholen: Die Anwendung wechselt in den Debugmodus.
Ignorieren: Die Anwendung wird fortgesetzt. Der Benutzer muss auf eine dieser Schaltflächen klicken, bevor die Anwendung fortgesetzt werden kann.

Sie können die Ausgabe der Debug -Klasse auch an andere Ziele als das Ausgabefenster weiterleiten. Die Debug -Klasse verfügt über eine Auflistung namens Listeners , die Listenerobjekte enthält. Jedes Listenerobjekt ü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 Listenerobjekte zu definieren. Sie können das Ziel für eine TextWriterTraceListener Klasse über ihren Konstruktor angeben. Einige mögliche Ausgabeziele sind:

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 Auflistung hinzufügen, um die Debug.Listeners Ausgabe zu erhalten Debug .

Erstellen eines Beispiels mit der Debug-Klasse

Verwenden Sie Visual Basic .NET, um ein neues Konsolenanwendungsprojekt mit dem Namen conInfo zu erstellen. Dem Projekt wird standardmäßig ein öffentliches Modul mit dem Namen Module1 hinzugefügt.
Um Variablen so zu initialisieren, dass sie Informationen zu einem Produkt enthalten, 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 Meldung an, die die Klasse als ersten Eingabeparameter der WriteLine -Methode erzeugt. Drücken Sie die Tastenkombination STRG+ALT+O, um sicherzustellen, dass das Ausgabefenster angezeigt wird.
```
Debug.WriteLine("Debug Information-Product Starting ")
```
Verwenden Sie aus Gründen der 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 z. B. 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 Ausgabefenstermeldung "Category: message". In der ersten Zeile des folgenden Codes wird beispielsweise "Field: The product name is Widget" (Feld: Der Produktname ist Widget) im Ausgabefenster angezeigt:
```
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")
```
Im Ausgabefenster können Meldungen nur angezeigt werden, wenn eine angegebene Bedingung mithilfe der WriteLineIf -Methode der Debug -Klasse als true ausgewertet wird. Die auszuwertende Bedingung ist der erste Eingabeparameter der WriteLineIf Methode. Der zweite Parameter von WriteLineIf ist die Meldung, die nur angezeigt wird, wenn die Bedingung im ersten Parameter als true 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, damit 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 NamenOutput.txt(tr2), und fügen Sie dann jedes Objekt der DebugListeners 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 aus Gründen der Lesbarkeit die Unindent -Methode, um den Einzug für nachfolgende Nachrichten zu entfernen, die von der Debug Klasse generiert werden. Wenn Sie die Indent -Methode und die Unindent -Methode zusammen verwenden, kann der Reader die Ausgabe als Gruppe unterscheiden.
```
Debug.Unindent()
Debug.WriteLine("Debug Information-Product Ending")
```
Um sicherzustellen, dass jedes Listenerobjekt seine 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 erzeugen, die die Ausführung einer Anwendung überwachen. Die Trace Klassen und Debug verwenden die meisten der gleichen Methoden, um eine Ausgabe zu erzeugen, einschließlich:

WriteLine
WriteLineIf
Indent
Unindent
Assert
Flush

Sie können die Trace Klassen und separat Debug oder zusammen in derselben Anwendung verwenden. In einem Debugprojekt für die Projektmappenkonfiguration sind sowohl als Debug auch Trace die Ausgabe aktiv. Das Projekt generiert die Ausgabe beider Klassen für alle Listenerobjekte. Ein Projekt für die Releaselösungskonfiguration generiert jedoch nur eine Ausgabe aus einer Trace Klasse. Das Projekt Release Solution Configuration ignoriert alle Debug Aufrufe von Klassenmethoden.

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 es funktioniert

Stellen Sie sicher, dass Debuggen die aktuelle Projektmappenkonfiguration 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 Ordner Konfiguration sicher, dass der Pfeil auf Debuggen zeigt.
Klicken Sie über dem Ordner Konfiguration 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 Assertionsfehler angezeigt wird, klicken Sie auf Ignorieren.

Drücken Sie im Konsolenfenster die EINGABETASTE. Das Programm sollte beendet werden, und im Ausgabefenster sollte die folgende Ausgabe angezeigt werden:

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

Im Konsolenfenster und in der datei Output.txt sollte die folgende Ausgabe angezeigt werden:

(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 Codeauflistung

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 Konfigurationstyp der Lösung Release ist, wird die Debug Klassenausgabe ignoriert.
Nachdem Sie eine TextWriterTraceListener Klasse für ein bestimmtes Ziel erstellt haben, TextWriterTraceListener empfängt die Ausgabe der Trace -Klasse und der Debug -Klasse. Dies geschieht unabhängig davon, ob Sie die Add -Methode von Trace oder die Debug -Klasse verwenden, um der Listeners -Klasse hinzuzufügenTextWriterTraceListener.
Wenn Sie ein Listenerobjekt für dasselbe Ziel in und Trace den Debug Klassen hinzufügen, wird jede Ausgabezeile dupliziert, unabhängig davon, ob Debug oder Trace die Ausgabe generiert wird.
```
Dim tr1 As New TextWriterTraceListener(System.Console.Out)
Debug.Listeners.Add(tr1)
Dim tr2 As New TextWriterTraceListener(System.Console.Out)
Trace.Listeners.Add(tr2)
```