ServiceDebugBehavior 类

定义

public ref class ServiceDebugBehavior : System::ServiceModel::Description::IServiceBehavior

public class ServiceDebugBehavior : System.ServiceModel.Description.IServiceBehavior

type ServiceDebugBehavior = class
    interface IServiceBehavior

Public Class ServiceDebugBehavior
Implements IServiceBehavior

继承

Object

ServiceDebugBehavior

实现

IServiceBehavior

示例

下面的代码示例演示如何使用配置文件来启用 HTML 帮助页功能，将 SOAP 错误内部的异常信息返回给客户端以供调试，以及启用元数据支持。 此配置文件演示以下用于添加对 ServiceDebugBehavior 功能的支持的基本步骤：

• 由于 类型 ServiceDebugBehavior 是实现 System.ServiceModel.Description.IServiceBehavior ， <因此表示服务类型的 service> 元素的行为配置标识符为 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>

注解

从配置文件或以编程方式使用 ServiceDebugBehavior 属性，可以使托管异常信息流到客户端以进行调试，还可以向在 Web 浏览器中浏览该服务的用户发布 HTML 信息文件。

将 IncludeExceptionDetailInFaults 属性设置为 以 true 指示 WCF 将 SOAP 错误中的托管异常信息返回给客户端以进行调试。

由于涉及到一些安全问题，因此强烈建议您：

• 使用应用程序配置文件将 IncludeExceptionDetailInFaults 属性的值设置为 true。

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

有关与托管异常信息相关的安全问题的详细信息，请参阅 在协定和服务中指定和处理错误。

当使用 HTML 浏览器查看服务时，HttpHelpPageEnabled 和 HttpsHelpPageEnabled 属性指示服务发布 HTML 帮助文件。

HttpHelpPageUrl 和 HttpsHelpPageUrl 属性控制所查看的 HTML 帮助页的位置。

若要使用配置文件启用或禁用其中一个 ServiceDebugBehavior 功能，请执行以下操作：

1. 将 behaviorConfiguration 特性添加到 <WCF 服务的 service> 元素。 终结点行为在终结点>元素上<配置;服务元素上的<服务>行为。

2. 将 添加到或创建 <serviceBehaviors> 节，并在其中添加一个<行为>元素，其名称与步骤 1 中的behaviorConfiguration属性值匹配。 终结点行为是使用 <endpointBehaviors> 元素配置的;服务行为是使用 <serviceBehaviors> 元素配置的。

3. 将 <serviceDebug> 元素添加到步骤 2 中的 <behavior> 元素，并启用或禁用适合你的方案的各种属性。

有关具体示例的信息，请参见“示例”部分。