IErrorHandler Rozhraní

Definice

Obor názvů:

System.ServiceModel.Dispatcher

Sestavení:

System.ServiceModel.dll

Umožňuje implementátoru řídit chybovou zprávu vrácenou volajícímu a volitelně provádět vlastní zpracování chyb, jako je protokolování.

public interface class IErrorHandler

public interface IErrorHandler

type IErrorHandler = interface

Public Interface IErrorHandler

Příklady

Následující příklad kódu ukazuje službu, která implementuje IErrorHandler , která vrací pouze FaultException<TDetail> typ GreetingFault , když metoda služby vyvolá spravovanou výjimku.

#region IErrorHandler Members
public bool HandleError(Exception error)
{
  Console.WriteLine("HandleError called.");
  // Returning true indicates you performed your behavior.
  return true;
}

// This is a trivial implementation that converts Exception to FaultException<GreetingFault>.
public void ProvideFault(
  Exception error,
  MessageVersion ver,
  ref Message msg
)
{
  Console.WriteLine("ProvideFault called. Converting Exception to GreetingFault....");
  FaultException<GreetingFault> fe
    = new FaultException<GreetingFault>(new GreetingFault(error.Message));
  MessageFault fault = fe.CreateMessageFault();
  msg = Message.CreateMessage(
    ver,
    fault,
    "http://microsoft.wcf.documentation/ISampleService/SampleMethodGreetingFaultFault"
  );
}
#endregion

#Region "IErrorHandler Members"
Public Function HandleError(ByVal [error] As Exception) As Boolean Implements IErrorHandler.HandleError
  Console.WriteLine("HandleError called.")
  ' Returning true indicates you performed your behavior.
  Return True
End Function

' This is a trivial implementation that converts Exception to FaultException<GreetingFault>.
Public Sub ProvideFault(ByVal [error] As Exception, ByVal ver As MessageVersion, ByRef msg As Message) Implements IErrorHandler.ProvideFault
  Console.WriteLine("ProvideFault called. Converting Exception to GreetingFault....")
  Dim fe As New FaultException(Of GreetingFault)(New GreetingFault([error].Message))
  Dim fault As MessageFault = fe.CreateMessageFault()
  msg = Message.CreateMessage(ver, fault, "http://microsoft.wcf.documentation/ISampleService/SampleMethodGreetingFaultFault")
End Sub
#End Region

Následující příklad kódu ukazuje, jak použít chování služby k přidání IErrorHandler implementace do ErrorHandlers vlastnosti.

// This behavior modifies no binding parameters.
#region IServiceBehavior Members
public void AddBindingParameters(
  ServiceDescription description,
  ServiceHostBase serviceHostBase,
  System.Collections.ObjectModel.Collection<ServiceEndpoint> endpoints,
  System.ServiceModel.Channels.BindingParameterCollection parameters
)
{
  return;
}

// This behavior is an IErrorHandler implementation and
// must be applied to each ChannelDispatcher.
public void ApplyDispatchBehavior(ServiceDescription description, ServiceHostBase serviceHostBase)
{
  Console.WriteLine("The EnforceGreetingFaultBehavior has been applied.");
  foreach(ChannelDispatcher chanDisp in serviceHostBase.ChannelDispatchers)
  {
    chanDisp.ErrorHandlers.Add(this);
  }
}

// This behavior requires that the contract have a SOAP fault with a detail type of GreetingFault.
public void Validate(ServiceDescription description, ServiceHostBase serviceHostBase)
{
  Console.WriteLine("Validate is called.");
  foreach (ServiceEndpoint se in description.Endpoints)
  {
    // Must not examine any metadata endpoint.
    if (se.Contract.Name.Equals("IMetadataExchange")
      && se.Contract.Namespace.Equals("http://schemas.microsoft.com/2006/04/mex"))
      continue;
    foreach (OperationDescription opDesc in se.Contract.Operations)
    {
      if (opDesc.Faults.Count == 0)
        throw new InvalidOperationException(String.Format(
          "EnforceGreetingFaultBehavior requires a "
          + "FaultContractAttribute(typeof(GreetingFault)) in each operation contract.  "
          + "The \"{0}\" operation contains no FaultContractAttribute.",
          opDesc.Name)
        );
      bool gfExists = false;
      foreach (FaultDescription fault in opDesc.Faults)
      {
        if (fault.DetailType.Equals(typeof(GreetingFault)))
        {
          gfExists = true;
          continue;
        }
      }
      if (!gfExists)
      {
        throw new InvalidOperationException(
"EnforceGreetingFaultBehavior requires a FaultContractAttribute(typeof(GreetingFault)) in an operation contract."
        );
      }
    }
  }
}
#endregion

' This behavior modifies no binding parameters.
#Region "IServiceBehavior Members"
Public Sub AddBindingParameters(ByVal description As ServiceDescription, ByVal serviceHostBase As ServiceHostBase, ByVal endpoints As System.Collections.ObjectModel.Collection(Of ServiceEndpoint), ByVal parameters As System.ServiceModel.Channels.BindingParameterCollection) Implements IServiceBehavior.AddBindingParameters
  Return
End Sub

' This behavior is an IErrorHandler implementation and 
' must be applied to each ChannelDispatcher.
Public Sub ApplyDispatchBehavior(ByVal description As ServiceDescription, ByVal serviceHostBase As ServiceHostBase) Implements IServiceBehavior.ApplyDispatchBehavior
  Console.WriteLine("The EnforceGreetingFaultBehavior has been applied.")
  For Each chanDisp As ChannelDispatcher In serviceHostBase.ChannelDispatchers
    chanDisp.ErrorHandlers.Add(Me)
  Next chanDisp
End Sub

' This behavior requires that the contract have a SOAP fault with a detail type of GreetingFault.
Public Sub Validate(ByVal description As ServiceDescription, ByVal serviceHostBase As ServiceHostBase) Implements IServiceBehavior.Validate
  Console.WriteLine("Validate is called.")
  For Each se As ServiceEndpoint In description.Endpoints
    ' Must not examine any metadata endpoint.
    If se.Contract.Name.Equals("IMetadataExchange") AndAlso se.Contract.Namespace.Equals("http://schemas.microsoft.com/2006/04/mex") Then
      Continue For
    End If
    For Each opDesc As OperationDescription In se.Contract.Operations
      If opDesc.Faults.Count = 0 Then
        Throw New InvalidOperationException(String.Format("EnforceGreetingFaultBehavior requires a " & "FaultContractAttribute(typeof(GreetingFault)) in each operation contract.  " & "The ""{0}"" operation contains no FaultContractAttribute.", opDesc.Name))
      End If
      Dim gfExists As Boolean = False
      For Each fault As FaultDescription In opDesc.Faults
        If fault.DetailType.Equals(GetType(GreetingFault)) Then
          gfExists = True
          Continue For
        End If
      Next fault
      If gfExists = False Then
        Throw New InvalidOperationException("EnforceGreetingFaultBehavior requires a FaultContractAttribute(typeof(GreetingFault)) in an operation contract.")
      End If
    Next opDesc
  Next se
End Sub
#End Region

Následující příklad kódu ukazuje, jak nakonfigurovat službu tak, aby načítá chování služby pomocí konfiguračního souboru aplikace. Další podrobnosti o tom, jak vystavit chování služby v konfiguračním souboru, najdete v tématu IServiceBehavior.

<configuration>
  <system.serviceModel>
    <services>
      <service 
        name="Microsoft.WCF.Documentation.SampleService"
        behaviorConfiguration="metaAndErrors">
        <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>
        <behavior name="metaAndErrors">
          <serviceDebug includeExceptionDetailInFaults="true"/>
          <serviceMetadata httpGetEnabled="true"/>
          <enforceGreetingFaults />
        </behavior>
      </serviceBehaviors>
    </behaviors>
    <extensions>
      <behaviorExtensions>
        <add 
          name="enforceGreetingFaults" 
          type="Microsoft.WCF.Documentation.EnforceGreetingFaultBehavior, HostApplication, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null"
        />
      </behaviorExtensions>
    </extensions>
  </system.serviceModel>
</configuration>

Poznámky

Pokud chcete explicitně řídit chování aplikace při vyvolání výjimky, implementujte IErrorHandler rozhraní a přidejte ho do ChannelDispatchervlastnosti .ErrorHandlers IErrorHandler umožňuje explicitně řídit vygenerovanou chybu SOAP, rozhodnout, jestli se má odeslat zpět klientovi, a provádět související úlohy, jako je protokolování. Obslužné rutiny chyb jsou volány v pořadí, ve kterém byly přidány do ErrorHandlers vlastnosti .

Implementujte metodu ProvideFault pro řízení chybové zprávy, která se vrátí klientovi.

Implementujte metodu HandleError , abyste zajistili chování související s chybami, včetně protokolování chyb, zajištění rychlého selhání, vypnutí aplikace atd.

Poznámka

Vzhledem k tomu, že metodu HandleError lze volat z mnoha různých míst, neexistují žádné záruky o tom, na které vlákno je metoda volána. Nespoléhejte na HandleError metodu, která je volána ve vlákně operace.

Všechny ProvideFault implementace se volají nejprve před odesláním zprávy s odpovědí. Když byly volány a vráceny všechny ProvideFault implementace, a pokud fault je non-null, je odeslán zpět klientovi podle kontraktu operace. Pokud fault je null po zavolání všech implementací, zpráva odpovědi je řízena ServiceBehaviorAttribute.IncludeExceptionDetailInFaults hodnotou vlastnosti.

Poznámka

K výjimkám může dojít po zavolání všech ProvideFault implementací a předání zprávy odpovědi do kanálu. Pokud dojde k výjimce kanálu (například potíže serializace zprávy) IErrorHandler objekty jsou upozorněny. V takovém případě byste se měli ujistit, že vaše vývojové prostředí zachytává a zobrazuje takové výjimky nebo využívá trasování ke zjištění problému. Další informace o trasování najdete v tématu Řešení potíží s aplikací pomocí trasování.

Po odeslání zprávy s odpovědí jsou všechny HandleError implementace volány ve stejném pořadí.

Implementace IErrorHandler je obvykle přidána do ErrorHandlers vlastnosti ve službě (a klienta v případě duplexní komunikace).

Do modulu runtime můžete přidat IErrorHandler implementací chování (objekt System.ServiceModel.Description.IServiceBehavior, System.ServiceModel.Description.IEndpointBehavior, System.ServiceModel.Description.IContractBehaviornebo System.ServiceModel.Description.IOperationBehavior ) a použít chování programově, z konfiguračního souboru nebo s vlastním atributem pro připojení IErrorHandler.

Další informace o použití chování k úpravě modulu runtime najdete v tématu Konfigurace a rozšíření modulu runtime pomocí chování.

Metody

HandleError(Exception)	Povolí zpracování související s chybami a vrátí hodnotu, která určuje, zda dispečer přeruší relaci a kontext instance v určitých případech.
ProvideFault(Exception, MessageVersion, Message)	Umožňuje vytvoření vlastního FaultException<TDetail> , který se vrátí z výjimky v průběhu metody služby.