Exception.Data Свойство
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Возвращает коллекцию пар "ключ-значение", которые предоставляют дополнительные пользовательские сведения об исключении.
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 IDictionaryЗначение свойства
Объект, реализующий IDictionary интерфейс и содержащий коллекцию определяемых пользователем пар "ключ-значение". По умолчанию используется пустая коллекция.
Примеры
В следующем примере показано, как добавлять и извлекать сведения с помощью Data свойства.
// 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.
Комментарии
Используйте объект, System.Collections.IDictionary возвращаемый свойством Data , для хранения и получения дополнительных сведений, относящихся к исключению. Информация находится в виде произвольного числа определяемых пользователем пар ключей и значений. Основной компонент каждой пары "ключ-значение" обычно является идентифицирующей строкой, тогда как компонент значения пары может быть любым типом объекта.
Безопасность сочетания "ключ-значение"
Пары "ключ-значение", хранящиеся в коллекции, возвращаемой Data свойством, не защищены. Если приложение вызывает вложенный ряд подпрограмм, и каждая подпрограмма содержит обработчики исключений, результирующий стек вызовов содержит иерархию этих обработчиков исключений. Если подпрограмма нижнего уровня создает исключение, любой обработчик исключений верхнего уровня в иерархии стека вызовов может считывать и/или изменять пары "ключ-значение", хранящиеся в коллекции любым другим обработчиком исключений. Это означает, что информация в парах "ключ-значение" не должна быть конфиденциальной, и ваше приложение должно работать правильно, даже если информация в этих парах будет повреждена.
Ключевые конфликты
Конфликт ключей возникает, когда разные обработчики исключений указывают один и тот же ключ для доступа к паре "ключ-значение". Используйте осторожность при разработке приложения, поскольку следствием конфликта ключей является то, что обработчики исключений нижнего уровня могут непреднамеренно взаимодействовать с обработчиками исключений более высокого уровня, и это взаимодействие может привести к тонким ошибкам программы. Однако если вы осторожны, вы можете использовать ключевые конфликты для улучшения приложения.
Избегайте ключевых конфликтов
Избегайте ключевых конфликтов, применяя соглашение об именовании, чтобы создать уникальные ключи для пар "ключ-значение". Например, соглашение об именовании может дать ключ, состоящий из имени вашего приложения, разделённого точками, метода, предоставляющего дополнительные сведения для пары, и уникального идентификатора.
Предположим, что два приложения с именем "Продукты и поставщики" имеют метод с именем Sales. Метод Sales приложения Products предоставляет идентификационный номер (SKU) продукта. Метод продаж в приложении "Поставщики" предоставляет идентификационный номер (SID) поставщика. Следовательно, соглашение об именовании для этого примера дает ключи, "Products.Sales.SKU" и "Suppliers.Sales.SID".
Используйте ключевые конфликты
Используйте ключевые конфликты, применяя наличие одного или нескольких специальных, заранее подготовленных ключей для управления обработкой. Предположим, в одном сценарии обработчик исключений верхнего уровня в иерархии стека вызовов перехватывает все исключения, создаваемые обработчиками исключений нижнего уровня. Если существует пара "ключ-значение" со специальным ключом, обработчик исключений высокого уровня форматирует оставшиеся пары "ключ-значение" в IDictionary объекте в некотором нестандартном порядке; в противном случае остальные пары "ключ-значение" форматируются в обычном режиме.
Предположим, что в другом сценарии обработчик исключений на каждом уровне иерархии стека вызовов перехватывает исключение, вызываемое следующим обработчиком исключений нижнего уровня. Кроме того, каждый обработчик исключений знает коллекцию, возвращаемую Data свойством, содержит набор пар "ключ-значение", к которым можно получить доступ с предварительно настроенным набором ключей.
Каждый обработчик исключений использует предварительно подготовленный набор ключей для обновления компонента значения соответствующей пары "ключ-значение" с информацией, уникальной для этого обработчика исключений. После завершения процесса обновления обработчик исключений создает исключение для следующего обработчика исключений более высокого уровня. Наконец, обработчик исключений верхнего уровня обращается к парам "ключ-значение" и отображает консолидированные сведения об обновлении всех обработчиков исключений нижнего уровня.
