<serviceDebug>

Artikel
06/08/2023

Anger funktioner för felsökning och hjälpinformation för en WCF-tjänst (Windows Communication Foundation).

<Konfiguration>
  <system.serviceModel>
    <Beteenden>
      <serviceBehaviors>
        <Beteende>
          <serviceDebug>

Syntax

<serviceDebug httpHelpPageBinding="String"
              httpHelpPageBindingConfiguration="String"
              httpHelpPageEnabled="Boolean"
              httpHelpPageUrl="Uri"
              httpsHelpPageBinding="String"
              httpsHelpPageBindingConfiguration="String"
              httpsHelpPageEnabled="Boolean"
              httpsHelpPageUrl="Uri"
              includeExceptionDetailInFaults="Boolean" />

Attribut och element

I följande avsnitt beskrivs attribut, underordnade element och överordnade element.

Attribut

Attribut	Beskrivning
httpHelpPageBinding	Ett strängvärde som anger vilken typ av bindning som ska användas när HTTP används för att komma åt tjänstens hjälpsida. Endast bindningar med inre bindningselement som stöder System.ServiceModel.Channels.IReplyChannel stöds. System.ServiceModel.Channels.MessageVersion Dessutom måste bindningens egenskap vara MessageVersion.None.
httpHelpPageBindingConfiguration	En sträng som anger namnet på bindningen som anges i `httpHelpPageBinding` attributet, som refererar till ytterligare konfigurationsinformation för den här bindningen. Samma namn måste definieras i avsnittet `<bindings>` .
httpHelpPageEnabled	Ett booleskt värde som styr om WCF publicerar en HTML-hjälpsida på den adress som anges av `httpHelpPageUrl` attributet. Standardvärdet är `true`. Du kan ange den här egenskapen för `false` att inaktivera publiceringen av en HTML-hjälpsida som är synlig för HTML-webbläsare. Om du vill se till att HTML-hjälpsidan publiceras på den plats som styrs av `httpHelpPageUrl` attributet måste du ange det här attributet till `true`. Dessutom måste ett av följande villkor uppfyllas: - Attributet `httpHelpPageUrl` är en absolut adress som stöder HTTP-protokollschemat. – Det finns en basadress för tjänsten som stöder HTTP-protokollschemat. Även om ett undantag utlöses om en absolut adress som inte stöder HTTP-protokollschemat tilldelas attributet `httpHelpPageUrl` , resulterar alla andra scenarion där inget av föregående kriterier uppfylls i något undantag och ingen HTML-hjälpsida.
httpHelpPageUrl	En URI som anger den relativa eller absoluta HTTP-baserade URL:en för den anpassade HTML-hjälpfilen som användaren ser när slutpunkten visas med hjälp av en HTML-webbläsare. Du kan använda det här attributet för att aktivera användningen av en anpassad HTML-hjälpfil som returneras från en HTTP/Hämta-begäran, till exempel från en HTML-webbläsare. Platsen för HTML-hjälpfilen matchas på följande sätt. 1. Om värdet för det här attributet är en relativ adress är platsen för HTML-hjälpfilen värdet för den tjänstbasadress som stöder HTTP-begäranden plus det här egenskapsvärdet. 2. Om värdet för det här attributet är en absolut adress och stöder HTTP-begäranden är platsen för HTML-hjälpfilen värdet för den här egenskapen. 3. Om värdet för det här attributet är absolut men inte stöder HTTP-begäranden utlöses ett undantag. Det här attributet är endast giltigt när `httpHelpPageEnabled` attributet är `true`.
httpsHelpPageBinding	Ett strängvärde som anger vilken typ av bindning som ska användas när HTTPS används för att komma åt tjänsthjälpsidan. Endast bindningar med inre bindningselement som stöder IReplyChannel stöds. System.ServiceModel.Channels.MessageVersion Dessutom måste bindningens egenskap vara MessageVersion.None.
httpsHelpPageBindingConfiguration	En sträng som anger namnet på bindningen som anges i `httpsHelpPageBinding` attributet, som refererar till ytterligare konfigurationsinformation för den här bindningen. Samma namn måste definieras i avsnittet `<bindings>` .
httpsHelpPageEnabled	Ett booleskt värde som styr om WCF publicerar en HTML-hjälpsida på den adress som anges av `httpsHelpPageUrl` attributet. Standardvärdet är `true`. Du kan ange den här egenskapen för `false` att inaktivera publiceringen av en HTML-hjälpsida som är synlig för HTML-webbläsare. Om du vill se till att HTML-hjälpsidan publiceras på den plats som styrs av `httpsHelpPageUrl` attributet måste du ange det här attributet till `true`. Dessutom måste ett av följande villkor uppfyllas: - Attributet `httpsHelpPageUrl` är en absolut adress som stöder HTTPS-protokollschemat. – Det finns en basadress för tjänsten som stöder HTTPS-protokollschemat. Även om ett undantag utlöses om en absolut adress som inte stöder HTTPS-protokollschemat tilldelas attributet `httpsHelpPageUrl` , resulterar alla andra scenarion där inget av föregående kriterier uppfylls i något undantag och ingen HTML-hjälpsida.
httpsHelpPageUrl	En URI som anger den relativa eller absoluta HTTPS-baserade URL:en för den anpassade HTML-hjälpfilen som användaren ser när slutpunkten visas med hjälp av en HTML-webbläsare. Du kan använda det här attributet för att aktivera användningen av en anpassad HTML-hjälpfil som returneras från en HTTPS/Get-begäran, till exempel från en HTML-webbläsare. Platsen för HTML-hjälpfilen matchas på följande sätt: – Om värdet för den här egenskapen är en relativ adress är platsen för HTML-hjälpfilen värdet för den tjänstbasadress som stöder HTTPS-begäranden plus det här egenskapsvärdet. – Om värdet för den här egenskapen är en absolut adress och stöder HTTPS-begäranden är platsen för HTML-hjälpfilen värdet för den här egenskapen. – Om värdet för den här egenskapen är absolut men inte stöder HTTPS-begäranden utlöses ett undantag. Det här attributet är endast giltigt när `httpHelpPageEnabled` attributet är `true`.
includeExceptionDetailInFaults	Ett värde som anger om hanterad undantagsinformation ska inkluderas i informationen om SOAP-fel som returneras till klienten i felsökningssyfte. Standardvärdet är `false`. Om du anger det här attributet till `true`kan du 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. Försiktighet: Att returnera hanterad undantagsinformation till klienter kan vara en säkerhetsrisk. Det beror på att undantagsinformationen visar information om den interna tjänstimplementeringen som kan användas av obehöriga klienter.

Underordnade element

Inga.

Överordnade element

Element	Beskrivning
<Beteende>	Anger ett beteendeelement.

Kommentarer

Inställningen includeExceptionDetailInFaults gör att true tjänsten kan returnera alla undantag som genereras av programkoden även om undantaget inte deklareras med hjälp av FaultContractAttribute. Den här inställningen är användbar när du felsöker fall där servern utlöser ett oväntat undantag. Med det här attributet returneras en serialiserad form av det okända undantaget och du kan granska mer information om undantaget.

Varning

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. På grund av säkerhetsproblemen rekommenderar vi starkt att du bara gör det i kontrollerade felsökningsscenarier. Du bör ange includeExceptionDetailInFaults till false när du distribuerar ditt program.

Mer information om säkerhetsproblem som rör hanterade undantag finns i Ange och hantera fel i kontrakt och tjänster. Ett kodexempel finns i Beteende för servicefelsökning.

Du kan också ange httpsHelpPageEnabled och httpsHelpPageUrl aktivera eller inaktivera hjälpsidan. Varje tjänst kan också visa en hjälpsida som innehåller information om tjänsten, inklusive slutpunkten för att hämta WSDL för tjänsten. Detta kan aktiveras genom att ange httpHelpPageEnabled till true. På så sätt kan hjälpsidan returneras till en GET-begäran till tjänstens basadress. Du kan ändra den här adressen genom att ange attributet httpHelpPageUrl . Dessutom kan du skydda detta genom att använda HTTPS i stället för HTTP.

Med de valfria httpHelpPageBinding attributen och httpHelpPageBinding kan du konfigurera bindningar som används för att komma åt tjänstwebbsidan. Om de inte anges används standardbindningarna (HttpTransportBindingElementnär det gäller HTTP och HttpsTransportBindingElement, när det gäller HTTPS) för åtkomst till tjänsthjälpsidan efter behov. Observera att du inte kan använda dessa attribut med de inbyggda WCF-bindningarna. Endast bindningar med inre bindningselement som stöder xref:System.ServiceModel.Channels.IReplyChannel> stöds. System.ServiceModel.Channels.MessageVersion Dessutom måste bindningens egenskap vara MessageVersion.None.

Dela via