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.IDictionary
Public Overridable ReadOnly Property Data As IDictionary

Значение свойства

IDictionary

Объект, который реализует интерфейс IDictionary и содержит коллекцию заданных пользователем пар «ключ — значение». По умолчанию является пустой коллекцией.

Примеры

В следующем примере показано, как добавлять и получать сведения с помощью Data Свойства.

using namespace System;
using namespace System::Collections;

void NestedRunTest( bool displayDetails ); // forward declarations
void NestedRoutine1( bool displayDetails );
void NestedRoutine2( bool displayDetails );
void RunTest( bool displayDetails );

int main()
{
   Console::WriteLine("\nException with some extra information..." );
   RunTest(false);
   Console::WriteLine("\nException with all extra information..." );
   RunTest(true);
}

void RunTest( bool displayDetails )
{
   try
   {
      NestedRoutine1( displayDetails );
   }
   catch ( Exception^ e ) 
   {
      Console::WriteLine( "An exception was thrown." );
      Console::WriteLine( e->Message );
      if ( e->Data != nullptr )
      {
         Console::WriteLine( "  Extra details:" );

         for each (DictionaryEntry de in e->Data)
            Console::WriteLine("    Key: {0,-20}      Value: {1}", 
                               "'" + de.Key->ToString() + "'", de.Value);
      }
   }
}

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;
   }
}

void NestedRoutine2( bool displayDetails )
{
   Exception^ e = gcnew 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;
}

/*
This example produces the following results:

Exception with some extra information...
An exception was thrown.
This statement is the original exception message.
  Extra details:
    The key is 'ExtraInfo' and the value is: Information from NestedRoutine1.
    The key is 'MoreExtraInfo' and the value is: More information from NestedRoutine1.

Exception with all extra information...
An exception was thrown.
This statement is the original exception message.
  Extra details:
    The key is 'stringInfo' and the value is: Information from NestedRoutine2.
    The key is 'IntInfo' and the value is: -903
    The key is 'DateTimeInfo' and the value is: 11/26/2002 2:12:58 PM
    The key is 'ExtraInfo' and the value is: Information from NestedRoutine1.
    The key is 'MoreExtraInfo' and the value is: More information from NestedRoutine1.
*/
// 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.
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 свойством, для хранения и получения дополнительных сведений, относящихся к исключению. Сведения представляются в виде произвольного числа пар "ключ-значение", определяемых пользователем. Ключевым компонентом каждой пары «ключ-значение» обычно является идентифицирующая строка, тогда как компонент value пары может быть любым типом объекта.

Безопасность пар "ключ — значение"

Пары "ключ-значение", хранящиеся в коллекции, возвращаемой Data свойством, не являются безопасными. Если приложение вызывает вложенную последовательность подпрограмм и каждая подпрограммы содержит обработчики исключений, результирующий стек вызовов содержит иерархию этих обработчиков исключений. Если подпрограммы более низкого уровня выдают исключение, любой обработчик исключений верхнего уровня в иерархии стека вызовов может считывать и (или) изменять пары "ключ-значение", хранящиеся в коллекции любым другим обработчиком исключений. Это означает, что вы должны гарантировать, что информация в парах "ключ-значение" не является конфиденциальной и что приложение будет работать правильно, если информация в парах "ключ-значение" повреждена.

Конфликты ключей

Конфликт ключей возникает, когда разные обработчики исключений задают один и тот же ключ для доступа к паре «ключ-значение». Будьте внимательны при разработке приложения, поскольку следствием конфликта ключей является то, что обработчики исключений низкого уровня могут случайно взаимодействовать с обработчиками исключений более высокого уровня, и это взаимодействие может привести к незаметному возникновению ошибок программы. Тем не менее, если вы соблюдаем осторожность, можно использовать конфликты ключей для улучшения приложения.

Предотвращение конфликтов ключей

Избегайте конфликтов ключей, принимая соглашение об именовании для создания уникальных ключей для пар "ключ-значение". Например, соглашение об именовании может дать ключ, состоящий из имени приложения, разделенного точками, метода, который предоставляет дополнительные сведения о паре, и уникальный идентификатор.

Предположим, что два приложения, именуемые Products и поставщики, имеют метод с именем Sales. Метод Sales в приложении Products предоставляет идентификационный номер (единицу складского учета или номер SKU) продукта. Метод Sales в приложении поставщики предоставляет идентификационный номер или идентификатор безопасности поставщика. Следовательно, в соглашении об именовании в этом примере выдаются ключи «Products. Sales. SKU» и «поставщики. Sales. SID».

Использование конфликтов ключей

Конфликты ключей эксплойтов с помощью наличия одного или нескольких специальных, предопределенных ключей для управления обработкой. Предположим, что в одном сценарии обработчик исключений высшего уровня в иерархии стека вызовов перехватывает все исключения, порождаемые обработчиками исключений низкого уровня. Если пара ключ/значение с особым ключом существует, обработчик исключений высокого уровня форматирует оставшиеся пары "ключ-значение" в IDictionary объекте нестандартным образом. в противном случае остальные пары "ключ-значение" форматируются обычным способом.

Теперь предположим, что в другом сценарии обработчик исключений на каждом уровне иерархии стека вызовов перехватывает исключение, выдаваемое следующим обработчиком исключений более низкого уровня. Кроме того, каждый обработчик исключений знает, что коллекция, возвращаемая Data свойством, содержит набор пар "ключ-значение", доступ к которым можно получить с помощью предустановленного набора ключей.

Каждый обработчик исключений использует предустановленный набор ключей, чтобы обновить компонент значения соответствующей пары «ключ-значение» данными, уникальными для этого обработчика исключений. После завершения процесса обновления обработчик исключений создает исключение для следующего обработчика исключений более высокого уровня. Наконец, обработчик исключений самого высокого уровня обращается к парам "ключ-значение" и отображает объединенные сведения об обновлении из всех обработчиков исключений нижнего уровня.

Применяется к

См. также раздел