ServiceBehaviorAttribute.IncludeExceptionDetailInFaults Vlastnost
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Získá nebo nastaví hodnotu, která určuje, že obecné neošetřené výjimky spuštění jsou převedeny na FaultException<TDetail> typ ExceptionDetail a odeslán jako chybová zpráva. Tuto možnost nastavte true pouze během vývoje pro řešení potíží se službou.
public:
property bool IncludeExceptionDetailInFaults { bool get(); void set(bool value); };public bool IncludeExceptionDetailInFaults { get; set; }member this.IncludeExceptionDetailInFaults : bool with get, setPublic Property IncludeExceptionDetailInFaults As BooleanHodnota vlastnosti
truepokud se neošetřené výjimky vrátí jako chyby PROTOKOLU SOAP; v opačném případě . false Výchozí hodnota je false.
Příklady
Následující příklad kódu ukazuje ServiceBehaviorAttribute vlastnosti. Třída BehaviorService používá ServiceBehaviorAttribute atribut k označení, že:
Metody implementace jsou vyvolány ve vlákně uživatelského rozhraní.
Pro každou relaci je jeden objekt služby.
Služba je jednovláknová a nepodporuje opakované volání.
Na úrovni operace navíc hodnoty označují, OperationBehaviorAttribute že TxWork metoda automaticky zapisuje do toků transakcí nebo vytvoří novou transakci pro provedení práce a že transakce je potvrzena automaticky, pokud nedojde k neošetřené výjimce.
using System;
using System.ServiceModel;
using System.Transactions;
namespace Microsoft.WCF.Documentation
{
[ServiceContract(
Namespace="http://microsoft.wcf.documentation",
SessionMode=SessionMode.Required
)]
public interface IBehaviorService
{
[OperationContract]
string TxWork(string message);
}
// Note: To use the TransactionIsolationLevel property, you
// must add a reference to the System.Transactions.dll assembly.
/* The following service implementation:
* -- Processes messages on one thread at a time
* -- Creates one service object per session
* -- Releases the service object when the transaction commits
*/
[ServiceBehavior(
ConcurrencyMode=ConcurrencyMode.Single,
InstanceContextMode=InstanceContextMode.PerSession,
ReleaseServiceInstanceOnTransactionComplete=true
)]
public class BehaviorService : IBehaviorService, IDisposable
{
Guid myID;
public BehaviorService()
{
myID = Guid.NewGuid();
Console.WriteLine(
"Object "
+ myID.ToString()
+ " created.");
}
/*
* The following operation-level behaviors are specified:
* -- The executing transaction is committed when
* the operation completes without an
* unhandled exception
* -- Always executes under a flowed transaction.
*/
[OperationBehavior(
TransactionAutoComplete = true,
TransactionScopeRequired = true
)]
[TransactionFlow(TransactionFlowOption.Mandatory)]
public string TxWork(string message)
{
// Do some transactable work.
Console.WriteLine("TxWork called with: " + message);
// Display transaction information.
TransactionInformation info = Transaction.Current.TransactionInformation;
Console.WriteLine("The distributed tx ID: {0}.", info.DistributedIdentifier);
Console.WriteLine("The tx status: {0}.", info.Status);
return String.Format("Hello. This was object {0}.",myID.ToString()) ;
}
public void Dispose()
{
Console.WriteLine(
"Service "
+ myID.ToString()
+ " is being recycled."
);
}
}
}
Imports System.ServiceModel
Imports System.Transactions
Namespace Microsoft.WCF.Documentation
<ServiceContract(Namespace:="http://microsoft.wcf.documentation", SessionMode:=SessionMode.Required)> _
Public Interface IBehaviorService
<OperationContract> _
Function TxWork(ByVal message As String) As String
End Interface
' Note: To use the TransactionIsolationLevel property, you
' must add a reference to the System.Transactions.dll assembly.
' The following service implementation:
' * -- Processes messages on one thread at a time
' * -- Creates one service object per session
' * -- Releases the service object when the transaction commits
'
<ServiceBehavior(ConcurrencyMode:=ConcurrencyMode.Single, InstanceContextMode:=InstanceContextMode.PerSession, _
ReleaseServiceInstanceOnTransactionComplete:=True)> _
Public Class BehaviorService
Implements IBehaviorService, IDisposable
Private myID As Guid
Public Sub New()
myID = Guid.NewGuid()
Console.WriteLine("Object " & myID.ToString() & " created.")
End Sub
'
' * The following operation-level behaviors are specified:
' * -- The executing transaction is committed when
' * the operation completes without an
' * unhandled exception
' * -- Always executes under a flowed transaction.
'
<OperationBehavior(TransactionAutoComplete:=True, TransactionScopeRequired:=True), TransactionFlow(TransactionFlowOption.Mandatory)> _
Public Function TxWork(ByVal message As String) As String Implements IBehaviorService.TxWork
' Do some transactable work.
Console.WriteLine("TxWork called with: " & message)
' Display transaction information.
Dim info As TransactionInformation = Transaction.Current.TransactionInformation
Console.WriteLine("The distributed tx ID: {0}.", info.DistributedIdentifier)
Console.WriteLine("The tx status: {0}.", info.Status)
Return String.Format("Hello. This was object {0}.", myID.ToString())
End Function
Public Sub Dispose() Implements IDisposable.Dispose
Console.WriteLine("Service " & myID.ToString() & " is being recycled.")
End Sub
End Class
End Namespace
Základní vazba musí podporovat tokované transakce, aby se následující příklad kódu spustil správně. Chcete-li podporovat tokované transakce pomocí WSHttpBinding, například nastavit TransactionFlow vlastnost v true kódu nebo v konfiguračním souboru aplikace. Následující příklad kódu ukazuje konfigurační soubor pro předchozí ukázku.
<configuration>
<system.serviceModel>
<services>
<service
name="Microsoft.WCF.Documentation.BehaviorService"
behaviorConfiguration="metadataAndDebugEnabled"
>
<host>
<baseAddresses>
<add baseAddress="http://localhost:8080/SampleService"/>
</baseAddresses>
</host>
<!--
Note:
This example code uses the WSHttpBinding to support transactions using the
WS-AtomicTransactions (WS-AT) protocol. WSHttpBinding is configured to use the
protocol, but the protocol is not enabled on some computers. Use the xws_reg -wsat+
command to enable the WS-AtomicTransactions protocol in the MSDTC service.
-->
<endpoint
contract="Microsoft.WCF.Documentation.IBehaviorService"
binding="wsHttpBinding"
bindingConfiguration="wsHttpBindingWithTXFlow"
address="http://localhost:8080/BehaviorService"
/>
<endpoint
contract="Microsoft.WCF.Documentation.IBehaviorService"
binding="netTcpBinding"
bindingConfiguration="netTcpBindingWithTXFlow"
address="net.tcp://localhost:8081/BehaviorService"
/>
<endpoint
address="mex"
binding="mexHttpBinding"
contract="IMetadataExchange"
/>
</service>
</services>
<behaviors>
<serviceBehaviors>
<behavior name="metadataAndDebugEnabled">
<serviceDebug
includeExceptionDetailInFaults="true"
/>
<serviceMetadata
httpGetEnabled="true"
httpGetUrl=""
/>
</behavior>
</serviceBehaviors>
</behaviors>
<!-- binding configuration - configures a WSHttpBinding to require transaction flow -->
<bindings>
<wsHttpBinding>
<binding name="wsHttpBindingWithTXFlow" transactionFlow="true" />
</wsHttpBinding>
<netTcpBinding>
<binding name="netTcpBindingWithTXFlow" transactionFlow="true" />
</netTcpBinding>
</bindings>
</system.serviceModel>
</configuration>
Poznámky
Nastavte IncludeExceptionDetailInFaults na povolení true informací o výjimce pro tok do klientů pro účely ladění. Tato vlastnost vyžaduje vazbu, která podporuje odezvu požadavku nebo duplexní zasílání zpráv.
Ve všech spravovaných aplikacích jsou chyby zpracování reprezentovány Exception objekty. V aplikacích založených na protokolu SOAP, jako jsou aplikace WCF, metody, které implementují operace služby, komunikují informace o chybách pomocí chybových zpráv PROTOKOLU SOAP. Vzhledem k tomu, že aplikace WCF se spouštějí v obou typech chybových systémů, musí být všechny informace o spravovaných výjimkách, které je potřeba odeslat klientovi, převedeny z výjimek na chyby PROTOKOLU SOAP. Další informace naleznete v tématu Určení a zpracování chyb v kontraktech a službách.
Během vývoje můžete chtít, aby vaše služba také odeslala další výjimky zpět klientovi, aby vám pomohla s laděním. Jedná se o funkci určenou jen pro vývoj a neměla by se používat v nasazených službách.
Pro usnadnění vývoje ladění nastavte IncludeExceptionDetailInFaults buď true v kódu, nebo pomocí konfiguračního souboru aplikace.
Pokud je tato služba povolená, volajícímu automaticky vrátí bezpečnější informace o výjimce. Tyto chyby se klientovi zobrazují jako FaultException<TDetail> objekty typu ExceptionDetail.
Důležité
Nastavení IncludeExceptionDetailInFaults umožňující true klientům získat informace o výjimkách interní metody služby. Doporučuje se pouze jako způsob dočasného ladění aplikace služby. Kromě toho WSDL pro metodu, která vrací neošetřené výjimky tímto způsobem, neobsahuje kontrakt pro FaultException<TDetail> typu ExceptionDetail. Klienti musí očekávat, že je možné správně získat informace o ladění neznámou chybou SOAP.
Nastavení této vlastnosti true lze provést také pomocí konfiguračního souboru aplikace a <serviceDebug> elementu, jak ukazuje následující příklad kódu.
<serviceBehaviors>
<behavior name="metadataAndDebugEnabled">
<serviceDebug
includeExceptionDetailInFaults="true"
/>
<serviceMetadata
httpGetEnabled="true"
httpGetUrl=""
/>
</behavior>
</serviceBehaviors>
