ServiceDebugBehavior Klass

Definition

Aktiverar felsökning och hjälpinformationsfunktioner för en Windows Communication Foundation(WCF) tjänst.

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
Arv
ServiceDebugBehavior
Implementeringar

Exempel

Följande kodexempel visar hur du använder en konfigurationsfil för att aktivera html-hjälpsidans funktion och returnera undantagsinformation i ett SOAP-fel tillbaka till klienten i felsökningssyfte, förutom att aktivera metadatastöd. Den här konfigurationsfilen visar följande grundläggande steg för att lägga till stöd för ServiceDebugBehavior funktionerna:

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

Kommentarer

ServiceDebugBehavior Använd egenskaperna från en konfigurationsfil eller programmatiskt för att aktivera flödet av hanterad undantagsinformation till klienten i felsökningssyfte samt publicering av HTML-informationsfiler för användare som surfar på tjänsten i webbläsare.

Ange egenskapen IncludeExceptionDetailInFaults till true för att instruera WCF att returnera hanterad undantagsinformation i SOAP-fel till klienter i felsökningssyfte.

Caution

Att returnera hanterad undantagsinformation till klienter kan vara en säkerhetsrisk eftersom undantagsinformation visar information om den interna tjänstimplementeringen som kan användas av obehöriga klienter. Även om ServiceDebugBehavior egenskaperna också kan ställas in programmatiskt kan det vara lätt att glömma att inaktivera IncludeExceptionDetailInFaults när du distribuerar.

På grund av de säkerhetsproblem som är inblandade rekommenderar vi starkt att:

  • Du använder en programkonfigurationsfil för att ange värdet för IncludeExceptionDetailInFaults egenskapen till true.

  • Det gör du bara i kontrollerade felsökningsscenarier.

Mer information om säkerhetsproblem som rör hanterad undantagsinformation finns i Ange och hantera fel i Kontrakt och tjänster.

Egenskaperna HttpHelpPageEnabled och HttpsHelpPageEnabled instruerar tjänsten att publicera HTML-hjälpfiler när tjänsten visas med hjälp av en HTML-webbläsare.

Egenskaperna HttpHelpPageUrl och HttpsHelpPageUrl styr platsen för HTML-hjälpsidan som visas.

Så här aktiverar eller inaktiverar du en av funktionerna med hjälp av ServiceDebugBehavior en konfigurationsfil:

  1. Lägg till ett behaviorConfiguration attribut till <tjänstelementet> för WCF-tjänsten. Slutpunktsbeteenden konfigureras för <slutpunktselement> , tjänstbeteenden på <tjänstelement> .

  2. Lägg till i eller skapa ett <serviceBehaviors-avsnitt> och lägg till ett <beteendeelement> till det med namnet som matchar behaviorConfiguration attributvärdet från steg 1. Slutpunktsbeteenden konfigureras med hjälp av ett <endpointBehaviors-element> . Tjänstbeteenden konfigureras med hjälp av ett <serviceBehaviors-element> .

  3. Lägg till ett <serviceDebug-element> i <beteendeelementet> från steg 2 och aktivera eller inaktivera de olika egenskaper som är lämpliga för ditt scenario.

Ett specifikt exempel finns i avsnittet Exempel.

Konstruktorer

Name Description
ServiceDebugBehavior()

Initierar en ny instans av ServiceDebugBehavior klassen.

Egenskaper

Name Description
HttpHelpPageBinding

Hämtar eller anger åtkomst på hög nivå till definitionen av en bindning.

HttpHelpPageEnabled

Hämtar eller anger ett värde som styr om Windows Communication Foundation (WCF) publicerar en HTML-hjälpsida på adressen som styrs av egenskapen HttpHelpPageUrl.

HttpHelpPageUrl

Hämtar eller anger den plats där HTML-hjälpfilen publiceras.

HttpsHelpPageBinding

Hämtar eller anger åtkomst på hög nivå till definitionen av en bindning.

HttpsHelpPageEnabled

Hämtar eller anger ett värde som anger om Windows Communication Foundation (WCF) returnerar en HTML-hjälpfil via HTTPS på adressen som styrs av egenskapen HttpsHelpPageUrl.

HttpsHelpPageUrl

Hämtar eller anger den plats där en HTML-fil publiceras för hämtning med HTTPS.

IncludeExceptionDetailInFaults

Hämtar eller anger ett värde som anger om hanterad undantagsinformation ska inkluderas i detalj för SOAP-fel som returneras till klienten i felsökningssyfte.

Metoder

Name Description
Equals(Object)

Avgör om det angivna objektet är lika med det aktuella objektet.

(Ärvd från Object)
GetHashCode()

Fungerar som standard-hash-funktion.

(Ärvd från Object)
GetType()

Hämtar den aktuella instansen Type .

(Ärvd från Object)
MemberwiseClone()

Skapar en ytlig kopia av den aktuella Object.

(Ärvd från Object)
ToString()

Returnerar en sträng som representerar det aktuella objektet.

(Ärvd från Object)

Explicita gränssnittsimplementeringar

Name Description
IServiceBehavior.AddBindingParameters(ServiceDescription, ServiceHostBase, Collection<ServiceEndpoint>, BindingParameterCollection)

Implementerar AddBindingParameters(ServiceDescription, ServiceHostBase, Collection<ServiceEndpoint>, BindingParameterCollection) metoden för att stödja beteendet.

IServiceBehavior.ApplyDispatchBehavior(ServiceDescription, ServiceHostBase)

Implementerar ApplyDispatchBehavior(ServiceDescription, ServiceHostBase) metoden för att stödja beteendet.

IServiceBehavior.Validate(ServiceDescription, ServiceHostBase)

Implementerar Validate(ServiceDescription, ServiceHostBase) metoden för att stödja beteendet.

Gäller för