ServiceDebugBehavior.IncludeExceptionDetailInFaults Свойство

Определение

Пространство имен:

System.ServiceModel.Description

Сборка:

System.ServiceModel.dll

Получает или задает значение, которое определяет, включать ли информацию по управляемым исключениям в подробную информацию об ошибках SOAP, которая возвращается клиенту для отладки.

public:
 property bool IncludeExceptionDetailInFaults { bool get(); void set(bool value); };

public bool IncludeExceptionDetailInFaults { get; set; }

member this.IncludeExceptionDetailInFaults : bool with get, set

Public Property IncludeExceptionDetailInFaults As Boolean

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

Boolean

trueЗначение , если Windows Communication Foundation (WCF) возвращает сведения об управляемых исключениях в ошибках SOAP для целей отладки клиента; в противном случае false. Значение по умолчанию — false.

Примеры

В следующем примере кода показано использование файла конфигурации для включения возможностей страницы справки HTML и возврата информации об исключении в ошибке SOAP клиенту в целях отладки. В файле конфигурации показаны следующие основные шаги по добавлению поддержки функциональных возможностей ServiceDebugBehavior:

• ServiceDebugBehavior Поскольку тип является реализациейSystem.ServiceModel.Description.IServiceBehavior, элемент службы>, представляющий тип службы,< имеет идентификатор behaviorConfiguration="metadataAndDebug"конфигурации поведения.

• Опять же, так как ServiceDebugBehavior тип является реализацией System.ServiceModel.Description.IServiceBehavior <элемента поведения> , добавляется в <раздел serviceBehaviors> . name Задайте атрибут <элемента поведения>, значение которого является идентификатором behaviorConfiguration атрибута <элемента службы>. В этом случае используется значение metadataAndDebug.

• <Добавьте элемент serviceDebug> с различными атрибутами, заданными для требуемой конфигурации. В этом случае значения атрибута httpHelpPageEnabled и includeExceptionDetailInFaults заданы как true.

<configuration>
  <system.serviceModel>
    <services>
      <!-- 
        Step 1. Add a behaviorConfiguration attribute
        in the <service> element.
      -->
      <service 
        name="Microsoft.WCF.Documentation.SampleService"
        behaviorConfiguration="metadataAndDebug">
        <host>
          <baseAddresses>
            <add baseAddress="http://localhost:8080/SampleService" />
          </baseAddresses>
        </host>
        <endpoint
          address=""
          binding="wsHttpBinding"
          contract="Microsoft.WCF.Documentation.ISampleService"
        />
        <endpoint
           address="mex"
           binding="mexHttpBinding"
           contract="IMetadataExchange"
        />
      </service>
    </services>
    <behaviors>
      <serviceBehaviors>
        <!-- 
          Step 2. Inside a <serviceBehaviors> section, add 
          a name attribute in the <behaviors> element that 
          matches the behaviorConfiguration attribute in the
          <service> element above.
        -->
        <behavior name="metadataAndDebug">
          <serviceMetadata 
            httpGetEnabled="true" 
            httpGetUrl=""
          />
          <!-- 
            Step 3. Add a <serviceDebug> element and 
            modify the various attributes that suit your 
            scenario.
          -->
          <serviceDebug 
            httpHelpPageEnabled="true" 
            includeExceptionDetailInFaults="true"
          />
        </behavior>
      </serviceBehaviors>
    </behaviors>
  </system.serviceModel>
</configuration>

Комментарии

IncludeExceptionDetailInFaults Задайте для свойства true указание WCF возвращать клиенту сведения об управляемых исключениях в сбоях SOAP, чтобы упростить отладку.

Внимание!

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

Вследствие указанных проблем с безопасностью настоятельно рекомендуется делать следующее.

• Файл конфигурации приложения может использоваться для присвоения свойству IncludeExceptionDetailInFaults значения true.

• Это следует делать только в контролируемых сценариях отладки.

Дополнительные сведения см. в разделе "Указание и обработка ошибок в контрактах и службах".