IErrorHandler Interface

Definição

Namespace:

System.ServiceModel.Dispatcher

Assembly:

System.ServiceModel.dll

Permite a um implementador controlar a mensagem de falha retornada ao chamador e, opcionalmente, executar processamento de erro personalizado como registro em log.

public interface class IErrorHandler

public interface IErrorHandler

type IErrorHandler = interface

Public Interface IErrorHandler

Exemplos

O exemplo de código a seguir demonstra um serviço que implementa IErrorHandler que retorna apenas FaultException<TDetail> do tipo GreetingFault quando um método de serviço gera uma exceção gerenciada.

#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

O exemplo de código a seguir mostra como usar um comportamento de serviço para adicionar a IErrorHandler implementação à ErrorHandlers propriedade .

// 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 == false)
      {
        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

O exemplo de código a seguir mostra como configurar o serviço para carregar o comportamento do serviço usando um arquivo de configuração de aplicativo. Para obter mais detalhes sobre como expor um comportamento de serviço em um arquivo de configuração, consulte 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>

Comentários

Para controlar explicitamente o comportamento do aplicativo quando uma exceção é gerada, implemente a IErrorHandler interface e adicione-a ChannelDispatcherà propriedade do ErrorHandlers . IErrorHandler permite que você controle explicitamente a falha SOAP gerada, decida se deseja enviá-la de volta ao cliente e executar tarefas associadas, como o registro em log. Manipuladores de erros são chamados na ordem em que foram adicionados à ErrorHandlers propriedade .

Implemente o ProvideFault método para controlar a mensagem de falha retornada ao cliente.

Implemente o HandleError método para garantir comportamentos relacionados a erros, incluindo o log de erros, garantindo uma falha rapidamente, desligando o aplicativo e assim por diante.

Observação

Como o HandleError método pode ser chamado de muitos locais diferentes, não há garantias sobre em qual thread o método é chamado. Não dependa do HandleError método que está sendo chamado no thread de operação.

Todas as ProvideFault implementações são chamadas primeiro, antes de enviar uma mensagem de resposta. Quando todas as ProvideFault implementações tiverem sido chamadas e retornadas e se fault nãonull forem, elas serão enviadas de volta ao cliente de acordo com o contrato de operação. Se fault for null depois que todas as implementações tiverem sido chamadas, a mensagem de resposta será controlada pelo valor da ServiceBehaviorAttribute.IncludeExceptionDetailInFaults propriedade.

Observação

Exceções podem ocorrer depois que todas as ProvideFault implementações são chamadas e uma mensagem de resposta é entregue ao canal. Se ocorrer uma exceção de canal (por exemplo, dificuldade para serializar a mensagem), IErrorHandler os objetos serão notificados. Nesse caso, você ainda deve garantir que seu ambiente de desenvolvimento capture e exiba essas exceções para você ou use o rastreamento para descobrir o problema. Para obter mais informações sobre o rastreamento, consulte Usando o rastreamento para solucionar problemas de seu aplicativo.

Depois que a mensagem de resposta for enviada, todas as HandleError implementações serão chamadas na mesma ordem.

Normalmente, uma IErrorHandler implementação é adicionada à ErrorHandlers propriedade no serviço (e ao cliente no caso de comunicação duplex).

Você pode adicionar o IErrorHandler ao runtime implementando um comportamento (um System.ServiceModel.Description.IServiceBehaviorobjeto , System.ServiceModel.Description.IEndpointBehavior, System.ServiceModel.Description.IContractBehaviorou System.ServiceModel.Description.IOperationBehavior ) e usar o comportamento programaticamente, de um arquivo de configuração ou com um atributo personalizado para anexar seu IErrorHandler.

Para obter mais informações sobre como usar comportamentos para modificar o runtime, consulte Configurando e estendendo o runtime com comportamentos.

Métodos

HandleError(Exception)	Habilita o processamento de erro e retorna um valor que indica se o dispatcher anula a sessão e o contexto da instância em determinados casos.
ProvideFault(Exception, MessageVersion, Message)	Permite a criação de um FaultException<TDetail> personalizado que é retornado de uma exceção no curso de um método de serviço.