IErrorHandler Interfaz

Definición

Espacio de nombres:

System.ServiceModel.Dispatcher

Ensamblado:

System.ServiceModel.dll

Permite a un implementador controlar el mensaje del error devuelto al autor de la llamada y, opcionalmente, realizar un procesamiento de errores personalizado, por ejemplo registrándolos.

public interface class IErrorHandler

public interface IErrorHandler

type IErrorHandler = interface

Public Interface IErrorHandler

Ejemplos

En el ejemplo de código siguiente se muestra un servicio que implementa IErrorHandler que sólo devuelve FaultException<TDetail> de tipo GreetingFault cuando un método de servicio genera una excepción administrada.

#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

En el ejemplo de código siguiente se muestra cómo utilizar un comportamiento de servicio para agregar la implementación de IErrorHandler a la propiedad ErrorHandlers.

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

En el ejemplo de código siguiente se muestra cómo configurar el servicio para cargar el comportamiento de servicio mediante un archivo de configuración de aplicación. Para obtener más detalles sobre cómo exponer un comportamiento de servicio en un archivo de configuración, vea 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>

Comentarios

Para controlar explícitamente el comportamiento de la aplicación cuando se produce una excepción, implemente la IErrorHandler interfaz y agréguela a la ChannelDispatcherpropiedad de .ErrorHandlers IErrorHandler le permite controlar explícitamente el error de SOAP generado, decidir si devolverlo al cliente y realizar tareas asociadas, como la creación de registros. Se llama a los controladores de errores en el orden en que se agregaron a la propiedad ErrorHandlers.

Implemente el método ProvideFault para controlar el mensaje del error que se devuelve al cliente.

Implemente el método HandleError para garantizar que se realizan los comportamientos relacionados con errores, como el registro de errores, , asegurar que se producen errores rápidos, el cierre de la aplicación, etc.

Nota:

Dado que se puede llamar al método HandleError desde muchos lugares diferentes no hay ninguna garantía acerca de en qué subproceso se llama al método. No dependa del método HandleError que se llama en el subproceso de la operación.

Primero se llama a todas las implementaciones de ProvideFault, antes de enviar un mensaje de respuesta. Cuando se ha llamado a todas las implementaciones de ProvideFault y vuelven, y si fault es no null, se devuelve al cliente según el contrato de la operación. Si fault es null una vez que se ha llamado a todas las implementaciones, el valor de la propiedad ServiceBehaviorAttribute.IncludeExceptionDetailInFaults controla el mensaje de respuesta.

Nota:

Se pueden producir excepciones una vez que se ha llamado a todas las implementaciones de ProvideFault y se entrega al canal un mensaje de respuesta. Si se produce una excepción de canal (por ejemplo, dificultad para serializar el mensaje) IErrorHandler se notifican los objetos . En este caso, debe asegurarse de que el entorno de desarrollo detecta y muestra estas excepciones o usa el seguimiento para detectar el problema. Para obtener más información sobre el seguimiento, consulte Uso del seguimiento para solucionar problemas de la aplicación.

Una vez enviado el mensaje de respuesta, se llama a todas las implementaciones de HandleError en el mismo orden.

Normalmente, se agrega una implementación de IErrorHandler a la propiedad ErrorHandlers del servicio (y del cliente si la comunicación es dúplex).

Puede agregar la propiedad IErrorHandler al tiempo de ejecución implementando un comportamiento (un objeto System.ServiceModel.Description.IServiceBehavior, System.ServiceModel.Description.IEndpointBehavior, System.ServiceModel.Description.IContractBehavior o System.ServiceModel.Description.IOperationBehavior ) y utilizar el comportamiento mediante programación, de un archivo de configuración o con un atributo personalizado, para asociar IErrorHandler.

Para obtener más información sobre el uso de comportamientos para modificar el tiempo de ejecución, consulte Configuración y extensión del runtime con comportamientos.

Métodos

HandleError(Exception)	Habilita el procesamiento relacionado con errores y devuelve un valor que indica si el distribuidor anula la sesión y el contexto de la instancia en ciertos casos.
ProvideFault(Exception, MessageVersion, Message)	Permite la creación de un FaultException<TDetail> personalizado que se devuelve de una excepción en el curso de un método de servicio.