ServiceDebugBehavior.IncludeExceptionDetailInFaults Właściwość

Definicja

Przestrzeń nazw:

System.ServiceModel.Description

Zestaw:

System.ServiceModel.dll

Pobiera lub ustawia wartość określającą, czy należy uwzględnić informacje o wyjątkach zarządzanych w szczegółach błędów protokołu SOAP zwracanych do klienta na potrzeby debugowania.

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

Wartość właściwości

Boolean

truejeśli Windows Communication Foundation (WCF) zwraca informacje o wyjątkach zarządzanych w błędach protokołu SOAP na potrzeby debugowania klienta; w przeciwnym razie false. Wartość domyślna to false.

Przykłady

Poniższy przykład kodu pokazuje, jak użyć pliku konfiguracji, aby włączyć funkcję strony pomocy HTML i zwrócić informacje o wyjątku wewnątrz błędu protokołu SOAP z powrotem do klienta na potrzeby debugowania. Ten plik konfiguracji przedstawia następujące podstawowe kroki dodawania ServiceDebugBehavior obsługi funkcji:

• ServiceDebugBehavior Ponieważ typ jest implementacjąSystem.ServiceModel.Description.IServiceBehavior, <element usługi> reprezentujący typ usługi ma identyfikator behaviorConfiguration="metadataAndDebug"konfiguracji zachowania .

• Ponownie, ponieważ ServiceDebugBehavior typ jest implementacją System.ServiceModel.Description.IServiceBehavior , <element zachowania> jest dodawany do <sekcji serviceBehaviors> . name Ustaw atrybut <elementu behavior>, którego wartość jest identyfikatorem behaviorConfiguration atrybutu <elementu usługi>. W tym przypadku wartość to metadataAndDebug.

• <Dodaj element serviceDebug> z różnymi atrybutami ustawionymi na żądaną konfigurację. W tym przypadku wartości atrybutów httpHelpPageEnabled i includeExceptionDetailInFaults są ustawione na truewartość .

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

Uwagi

IncludeExceptionDetailInFaults Ustaw właściwość na , aby true instruować program WCF, aby zwracał informacje o wyjątkach zarządzanych do klienta w błędach protokołu SOAP, aby ułatwić debugowanie.

Przestroga

Zwracanie informacji o wyjątkach zarządzanych klientom może stanowić zagrożenie bezpieczeństwa, ponieważ szczegóły wyjątku ujawniają informacje o implementacji usługi wewnętrznej, które mogą być używane przez nieautoryzowanych klientów. Ponadto, mimo że ServiceDebugBehavior właściwości można również ustawić programowo, można łatwo zapomnieć o wyłączeniu IncludeExceptionDetailInFaults podczas wdrażania.

Ze względu na problemy z zabezpieczeniami zdecydowanie zaleca się:

• Użyj pliku konfiguracji aplikacji, aby ustawić wartość IncludeExceptionDetailInFaults właściwości na true.

• Można to zrobić tylko w kontrolowanych scenariuszach debugowania.

Aby uzyskać więcej informacji, zobacz Określanie i obsługa błędów w kontraktach i usługach.