Exception.Data Eigenschaft
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Ruft eine Auflistung von Schlüssel-Wert-Paaren ab, die zusätzliche benutzerdefinierte Informationen zur Ausnahme bereitstellen.
public:
virtual property System::Collections::IDictionary ^ Data { System::Collections::IDictionary ^ get(); };public virtual System.Collections.IDictionary Data { get; }member this.Data : System.Collections.IDictionaryPublic Overridable ReadOnly Property Data As IDictionaryEigenschaftswert
Ein Objekt, das die IDictionary Schnittstelle implementiert und eine Auflistung von benutzerdefinierten Schlüssel-Wert-Paaren enthält. Der Standardwert ist eine leere Auflistung.
Beispiele
Im folgenden Beispiel wird das Hinzufügen und Abrufen von Informationen mithilfe der Data Eigenschaft veranschaulicht.
// This example demonstrates the Exception.Data property.
using System;
using System.Collections;
class Sample
{
public static void Main()
{
Console.WriteLine("\nException with some extra information...");
RunTest(false);
Console.WriteLine("\nException with all extra information...");
RunTest(true);
}
public static void RunTest(bool displayDetails)
{
try {
NestedRoutine1(displayDetails);
}
catch (Exception e) {
Console.WriteLine("An exception was thrown.");
Console.WriteLine(e.Message);
if (e.Data.Count > 0) {
Console.WriteLine(" Extra details:");
foreach (DictionaryEntry de in e.Data)
Console.WriteLine(" Key: {0,-20} Value: {1}",
"'" + de.Key.ToString() + "'", de.Value);
}
}
}
public static void NestedRoutine1(bool displayDetails)
{
try {
NestedRoutine2(displayDetails);
}
catch (Exception e) {
e.Data["ExtraInfo"] = "Information from NestedRoutine1.";
e.Data.Add("MoreExtraInfo", "More information from NestedRoutine1.");
throw;
}
}
public static void NestedRoutine2(bool displayDetails)
{
Exception e = new Exception("This statement is the original exception message.");
if (displayDetails) {
string s = "Information from NestedRoutine2.";
int i = -903;
DateTime dt = DateTime.Now;
e.Data.Add("stringInfo", s);
e.Data["IntInfo"] = i;
e.Data["DateTimeInfo"] = dt;
}
throw e;
}
}
// The example displays the following output:
// Exception with some extra information...
// An exception was thrown.
// This statement is the original exception message.
// Extra details:
// Key: 'ExtraInfo' Value: Information from NestedRoutine1.
// Key: 'MoreExtraInfo' Value: More information from NestedRoutine1.
//
// Exception with all extra information...
// An exception was thrown.
// This statement is the original exception message.
// Extra details:
// Key: 'stringInfo' Value: Information from NestedRoutine2.
// Key: 'IntInfo' Value: -903
// Key: 'DateTimeInfo' Value: 7/29/2013 10:50:13 AM
// Key: 'ExtraInfo' Value: Information from NestedRoutine1.
// Key: 'MoreExtraInfo' Value: More information from NestedRoutine1.
// This example demonstrates the Exception.Data property.
open System
open System.Collections
let nestedRoutine2 displayDetails =
let e = Exception "This statement is the original exception message."
if displayDetails then
let s = "Information from nestedRoutine2."
let i = -903
let dt = DateTime.Now
e.Data.Add("stringInfo", s)
e.Data["IntInfo"] <- i
e.Data["DateTimeInfo"] <- dt
raise e
let nestedRoutine1 displayDetails =
try
nestedRoutine2 displayDetails
with e ->
e.Data["ExtraInfo"] <- "Information from nestedRoutine1."
e.Data.Add("MoreExtraInfo", "More information from nestedRoutine1.")
reraise ()
let runTest displayDetails =
try
nestedRoutine1 displayDetails
with e ->
printfn "An exception was thrown."
printfn $"{e.Message}"
if e.Data.Count > 0 then
printfn " Extra details:"
for de in e.Data do
let de = de :?> DictionaryEntry
printfn $""" Key: {"'" + de.Key.ToString() + "'",-20} Value: {de.Value}"""
printfn "\nException with some extra information..."
runTest false
printfn "\nException with all extra information..."
runTest true
// The example displays the following output:
// Exception with some extra information...
// An exception was thrown.
// This statement is the original exception message.
// Extra details:
// Key: 'ExtraInfo' Value: Information from NestedRoutine1.
// Key: 'MoreExtraInfo' Value: More information from NestedRoutine1.
//
// Exception with all extra information...
// An exception was thrown.
// This statement is the original exception message.
// Extra details:
// Key: 'stringInfo' Value: Information from NestedRoutine2.
// Key: 'IntInfo' Value: -903
// Key: 'DateTimeInfo' Value: 7/29/2013 10:50:13 AM
// Key: 'ExtraInfo' Value: Information from NestedRoutine1.
// Key: 'MoreExtraInfo' Value: More information from NestedRoutine1.
Imports System.Collections
Module Example
Public Sub Main()
Console.WriteLine()
Console.WriteLine("Exception with some extra information...")
RunTest(False)
Console.WriteLine()
Console.WriteLine("Exception with all extra information...")
RunTest(True)
End Sub
Public Sub RunTest(displayDetails As Boolean)
Try
NestedRoutine1(displayDetails)
Catch e As Exception
Console.WriteLine("An exception was thrown.")
Console.WriteLine(e.Message)
If e.Data.Count > 0 Then
Console.WriteLine(" Extra details:")
For Each de As DictionaryEntry In e.Data
Console.WriteLine(" Key: {0,-20} Value: {1}",
"'" + de.Key.ToString() + "'", de.Value)
Next
End If
End Try
End Sub
Public Sub NestedRoutine1(displayDetails As Boolean)
Try
NestedRoutine2(displayDetails)
Catch e As Exception
e.Data("ExtraInfo") = "Information from NestedRoutine1."
e.Data.Add("MoreExtraInfo", "More information from NestedRoutine1.")
Throw e
End Try
End Sub
Public Sub NestedRoutine2(displayDetails As Boolean)
Dim e As New Exception("This statement is the original exception message.")
If displayDetails Then
Dim s As String = "Information from NestedRoutine2."
Dim i As Integer = -903
Dim dt As DateTime = DateTime.Now
e.Data.Add("stringInfo", s)
e.Data("IntInfo") = i
e.Data("DateTimeInfo") = dt
End If
Throw e
End Sub
End Module
' This example displays the following output:
' Exception with some extra information...
' An exception was thrown.
' This statement is the original exception message.
' Extra details:
' Key: 'ExtraInfo' Value: Information from NestedRoutine1.
' Key: 'MoreExtraInfo' Value: More information from NestedRoutine1.
'
' Exception with all extra information...
' An exception was thrown.
' This statement is the original exception message.
' Extra details:
' Key: 'stringInfo' Value: Information from NestedRoutine2.
' Key: 'IntInfo' Value: -903
' Key: 'DateTimeInfo' Value: 7/29/2013 10:50:13 AM
' Key: 'ExtraInfo' Value: Information from NestedRoutine1.
' Key: 'MoreExtraInfo' Value: More information from NestedRoutine1.
Hinweise
Verwenden Sie das System.Collections.IDictionary von der Data Eigenschaft zurückgegebene Objekt, um zusätzliche Informationen zu speichern und abzurufen, die für die Ausnahme relevant sind. Die Informationen sind in Form einer beliebigen Anzahl von benutzerdefinierten Schlüssel-Wert-Paaren vorhanden. Die Schlüsselkomponente jedes Schlüssel-Wert-Paars ist in der Regel eine identifizierende Zeichenfolge, während die Wertkomponente des Paares ein beliebiger Objekttyp sein kann.
Sicherheit von Schlüssel-Wert-Paaren
Die Schlüssel-Wert-Paare, die in der von der Data Eigenschaft zurückgegebenen Auflistung gespeichert sind, sind nicht sicher. Wenn Ihre Anwendung eine geschachtelte Reihe von Routinen aufruft und jede Routine Ausnahmehandler enthält, enthält der resultierende Aufrufstapel eine Hierarchie dieser Ausnahmehandler. Wenn eine Routine auf niedrigerer Ebene eine Ausnahme auslöst, kann jeder Ausnahmehandler der oberen Ebene in der Aufrufstapelhierarchie die in der Auflistung gespeicherten Schlüssel-Wert-Paare durch einen anderen Ausnahmehandler lesen und/oder ändern. Dies bedeutet, dass Sie sicherstellen müssen, dass die Informationen in den Schlüssel-Wert-Paaren nicht vertraulich sind und dass Ihre Anwendung ordnungsgemäß ausgeführt wird, wenn die Informationen in den Schlüssel-Wert-Paaren beschädigt sind.
Schlüsselkonflikte
Ein Schlüsselkonflikt tritt auf, wenn unterschiedliche Ausnahmehandler denselben Schlüssel für den Zugriff auf ein Schlüssel-Wert-Paar angeben. Achten Sie beim Entwickeln ihrer Anwendung darauf, dass die Folge eines Schlüsselkonflikts darin besteht, dass Ausnahmehandler auf niedrigerer Ebene versehentlich mit Ausnahmehandlern höherer Ebene kommunizieren können, und diese Kommunikation kann subtile Programmfehler verursachen. Wenn Sie jedoch vorsichtig sind, können Sie schlüsselkonflikte verwenden, um Ihre Anwendung zu verbessern.
Vermeiden von Schlüsselkonflikten
Vermeiden Sie Schlüsselkonflikte, indem Sie eine Benennungskonvention verwenden, um eindeutige Schlüssel für Schlüssel-Wert-Paare zu generieren. Eine Namenskonvention könnte beispielsweise einen Schlüssel ergeben, der aus dem durch Punkte begrenzten Namen Ihrer Anwendung, der Methode, die zusätzliche Informationen für das Paar liefert, und einem eindeutigen Bezeichner besteht.
Angenommen, zwei Anwendungen mit dem Namen "Produkte" und "Lieferanten" haben jeweils eine Methode namens "Sales". Die Vertriebsmethode in der Anwendung "Produkte" stellt die Identifikationsnummer (Lagerhaltungseinheit oder SKU) eines Produkts bereit. Die Vertriebsmethode in der Lieferantenanwendung stellt die Identifikationsnummer oder SID eines Lieferanten bereit. Folglich liefert die Benennungskonvention für dieses Beispiel die Schlüssel "Products.Sales.SKU" und "Suppliers.Sales.SID".
Wichtige Konflikte ausnutzen
Nutze Schlüsselkonflikte, indem du die Anwesenheit eines oder mehrerer spezieller, vorab vereinbarter Schlüssel zur Steuerung der Verarbeitung verwendest. Angenommen, in einem Szenario fängt der Ausnahmehandler der höchsten Ebene in der Aufrufstapelhierarchie alle Ausnahmen ab, die von Ausnahmehandlern auf niedrigerer Ebene ausgelöst werden. Wenn ein Schlüssel-Wert-Paar mit einem speziellen Schlüssel vorhanden ist, formatiert der Ausnahmehandler auf hoher Ebene die verbleibenden Schlüssel-Wert-Paare im IDictionary Objekt auf eine nicht standardmäßige Weise. Andernfalls werden die verbleibenden Schlüssel-Wert-Paare normal formatiert.
Angenommen, in einem anderen Szenario fängt der Ausnahmehandler auf jeder Ebene der Aufrufstapelhierarchie die Ausnahme ab, die vom nächsten Ausnahmehandler auf niedrigerer Ebene ausgelöst wird. Darüber hinaus weiß jeder Ausnahmehandler, dass die von der Data Eigenschaft zurückgegebene Auflistung eine Reihe von Schlüssel-Wert-Paaren enthält, auf die mit einem vordefinierten Satz von Schlüsseln zugegriffen werden kann.
Jeder Ausnahmehandler verwendet den vordefinierten Satz von Schlüsseln, um die Wertkomponente des entsprechenden Schlüssel-Wert-Paars mit Informationen zu aktualisieren, die für diesen Ausnahmehandler eindeutig sind. Nach Abschluss des Updatevorgangs wirft der Ausnahmehandler die Ausnahme weiter zum nächsten Ausnahmehandler auf höherer Ebene. Schließlich greift der Ausnahmehandler der höchsten Ebene auf die Schlüssel-Wert-Paare zu und zeigt die konsolidierten Updateinformationen aus allen Ausnahmehandlern auf niedrigerer Ebene an.
