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。

• 仅在受控调试方案中才这样做。

有关详细信息，请参阅在协定和服务中指定和处理错误。