IErrorHandler 인터페이스

참조

정의

네임스페이스:: System.ServiceModel.Dispatcher

어셈블리:: System.ServiceModel.dll

중요

일부 정보는 릴리스되기 전에 상당 부분 수정될 수 있는 시험판 제품과 관련이 있습니다. Microsoft는 여기에 제공된 정보에 대해 어떠한 명시적이거나 묵시적인 보증도 하지 않습니다.

구현자가 호출자에게 반환되는 오류 메시지를 제어하고, 로깅 등의 사용자 지정 오류 처리를 선택적으로 수행할 수 있도록 합니다.

public interface class IErrorHandler

public interface IErrorHandler

type IErrorHandler = interface

Public Interface IErrorHandler

예제

다음 코드 예제에서는 서비스 메서드가 관리되는 예외를 IErrorHandler throw할 때만 형식 GreetingFault 을 반환 FaultException<TDetail> 하는 서비스를 구현하는 서비스를 보여 줍니다.

#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

다음 코드 예제에서는 서비스 동작을 사용 하 여 속성에 구현을 IErrorHandler 추가 하는 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

다음 코드 예제에서는 애플리케이션 구성 파일을 사용하여 서비스 동작을 로드하도록 서비스를 구성하는 방법을 보여 줍니다. 구성 파일에서 서비스 동작을 노출하는 방법에 대한 자세한 내용은 다음을 참조하세요 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>

설명

예외가 throw 되 면 애플리케이션의 동작을 명시적으로 제어를 구현 합니다 IErrorHandler 인터페이스에 추가 하는 ChannelDispatcher의 ErrorHandlers 속성입니다. IErrorHandler 를 사용하면 생성된 SOAP 오류를 명시적으로 제어하고, 클라이언트로 다시 보낼지 여부를 결정하고, 로깅과 같은 관련 작업을 수행할 수 있습니다. 오류 처리기는 속성에 추가 ErrorHandlers 된 순서대로 호출됩니다.

클라이언트에 ProvideFault 반환되는 오류 메시지를 제어하는 메서드를 구현합니다.

오류 로깅, fail-fast 보장, 애플리케이션 종료 등과 같은 오류 관련 동작을 확인하려면 HandleError 메서드를 구현합니다.

참고

메서드를 HandleError 여러 위치에서 호출할 수 있으므로 메서드가 호출되는 스레드에 대한 보장은 없습니다. 작업 스레드에서 HandleError 호출되는 메서드에 의존하지 마세요.

응답 메시지를 보내기 전에 모든 ProvideFault 구현이 먼저 호출됩니다. 모든 ProvideFault 구현이 호출되어 반환되고, 그렇지null 않은 경우 fault 작업 계약에 따라 클라이언트로 다시 전송됩니다. null 모든 구현이 호출된 후인 경우 fault 응답 메시지는 속성 값에 ServiceBehaviorAttribute.IncludeExceptionDetailInFaults 의해 제어됩니다.

참고

모든 ProvideFault 구현이 호출되고 응답 메시지가 채널에 전달된 후에 예외가 발생할 수 있습니다. 채널 예외가 발생하는 경우(예: 메시지 직렬화 어려움) IErrorHandler 개체에 알림이 표시됩니다. 이 경우 개발 환경에서 이러한 예외를 catch하고 표시하거나 추적을 사용하여 문제를 검색해야 합니다. 추적에 대 한 자세한 내용은 참조 하세요. 애플리케이션 문제 해결을 사용 하 여 추적합니다.

응답 메시지를 보낸 후 모든 HandleError 구현이 동일한 순서로 호출됩니다.

일반적으로 IErrorHandler 구현은 서비스의 속성(및 이중 통신의 경우 클라이언트)에 추가 ErrorHandlers 됩니다.

동작(System.ServiceModel.Description.IServiceBehavior, , System.ServiceModel.Description.IEndpointBehavior System.ServiceModel.Description.IContractBehavior또는 개체)을 구현하여 런타임에 추가하고 IErrorHandler 구성 파일 또는 System.ServiceModel.Description.IOperationBehavior 사용자 지정 특성으로 프로그래밍 방식으로 동작을 사용하여 연결할 수 있습니다IErrorHandler.

동작을 사용하여 런타임을 수정하는 방법에 대한 자세한 내용은 동작을 사용하여 런타임 구성 및 확장을 참조하세요.

메서드

HandleError(Exception)	오류 관련 처리를 사용하고 디스패처가 특정 상황에서 세션 및 인스턴스 컨텍스트를 중단하는지 여부를 나타내는 값을 반환합니다.
ProvideFault(Exception, MessageVersion, Message)	서비스 메서드 중에 발생한 예외로부터 반환되는 사용자 지정 FaultException<TDetail>을 만들 수 있습니다.

적용 대상

다음을 통해 공유

IErrorHandler 인터페이스

정의

예제

설명

메서드

적용 대상

추가 리소스