IErrorHandler Interfejs

Definicja

Przestrzeń nazw:

System.ServiceModel.Dispatcher

Zestaw:

System.ServiceModel.dll

Umożliwia implementatorowi kontrolowanie komunikatu o błędzie zwróconego do wywołującego i opcjonalnie wykonywanie niestandardowego przetwarzania błędów, takiego jak rejestrowanie.

public interface class IErrorHandler

public interface IErrorHandler

type IErrorHandler = interface

Public Interface IErrorHandler

Przykłady

Poniższy przykład kodu przedstawia usługę, która implementuje IErrorHandler , która zwraca tylko FaultException<TDetail> typ GreetingFault , gdy metoda usługi zgłasza wyjątek zarządzany.

#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

Poniższy przykład kodu pokazuje, jak za pomocą zachowania usługi dodać implementację IErrorHandler do ErrorHandlers właściwości.

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

W poniższym przykładzie kodu pokazano, jak skonfigurować usługę w celu załadowania zachowania usługi przy użyciu pliku konfiguracji aplikacji. Aby uzyskać więcej informacji na temat uwidaczniania zachowania usługi w pliku konfiguracji, zobacz 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>

Uwagi

Aby jawnie kontrolować zachowanie aplikacji po wystąpieniu wyjątku, zaimplementuj IErrorHandler interfejs i dodaj go do ChannelDispatcherwłaściwości .s ErrorHandlers . IErrorHandler umożliwia jawne sterowanie wygenerowanymi błędami protokołu SOAP, podejmowanie decyzji o tym, czy wysyłać je z powrotem do klienta, i wykonywać skojarzone zadania, takie jak rejestrowanie. Procedury obsługi błędów są wywoływane w kolejności, w której zostały dodane do ErrorHandlers właściwości.

Zaimplementuj metodę ProvideFault , aby kontrolować komunikat o błędzie zwrócony do klienta.

Zaimplementuj metodę HandleError , aby zapewnić zachowania związane z błędami, w tym rejestrowanie błędów, zapewnienie szybkiej awarii, zamknięcie aplikacji itd.

Uwaga

HandleError Ponieważ metoda może być wywoływana z wielu różnych miejsc, nie ma gwarancji, na temat którego wątku wywoływana jest metoda. Nie należy polegać na HandleError wywoływaniu metody w wątku operacji.

Wszystkie ProvideFault implementacje są wywoływane najpierw przed wysłaniem komunikatu odpowiedzi. Gdy wszystkie ProvideFault implementacje zostały wywołane i zwrócone, a jeśli fault nie,null jest wysyłane z powrotem do klienta zgodnie z kontraktem operacji. Jeśli fault po null wywołaniu wszystkich implementacji komunikat odpowiedzi jest kontrolowany przez ServiceBehaviorAttribute.IncludeExceptionDetailInFaults wartość właściwości.

Uwaga

Wyjątki mogą wystąpić po wywołaniu wszystkich ProvideFault implementacji i przekazaniu komunikatu odpowiedzi do kanału. Jeśli wystąpi wyjątek kanału (na przykład trudności z serializacją komunikatu) IErrorHandler obiekty zostaną powiadomione. W takim przypadku nadal należy upewnić się, że środowisko deweloperskie przechwytuje i wyświetla takie wyjątki lub używa śledzenia do wykrycia problemu. Aby uzyskać więcej informacji na temat śledzenia, zobacz Używanie śledzenia do rozwiązywania problemów z aplikacją.

Po wysłaniu komunikatu odpowiedzi wszystkie HandleError implementacje są wywoływane w tej samej kolejności.

Zazwyczaj implementacja IErrorHandler jest dodawana do ErrorHandlers właściwości usługi (a klient w przypadku komunikacji dwustronnej).

Można dodać element IErrorHandler do środowiska uruchomieniowego, implementując zachowanie (obiekt System.ServiceModel.Description.IServiceBehavior, , System.ServiceModel.Description.IEndpointBehaviorlubSystem.ServiceModel.Description.IContractBehaviorSystem.ServiceModel.Description.IOperationBehavior) i programowo używać zachowania z pliku konfiguracji lub atrybutu niestandardowego w celu dołączenia IErrorHandlerelementu .

Aby uzyskać więcej informacji na temat używania zachowań do modyfikowania środowiska uruchomieniowego, zobacz Konfigurowanie i rozszerzanie środowiska uruchomieniowego przy użyciu zachowań.

Metody

HandleError(Exception)	Włącza przetwarzanie związane z błędami i zwraca wartość wskazującą, czy dyspozytor przerywa sesję i kontekst wystąpienia w niektórych przypadkach.
ProvideFault(Exception, MessageVersion, Message)	Umożliwia utworzenie niestandardowego FaultException<TDetail> , który jest zwracany z wyjątku w trakcie metody usługi.