IErrorHandler Arabirim

Tanım

Ad Alanı:

System.ServiceModel.Dispatcher

Bütünleştirilmiş Kodlar:

System.ServiceModel.dll, System.ServiceModel.Primitives.dll

Paket:

System.ServiceModel.Primitives v10.0.652802

Kaynak:

IErrorHandler.cs

Bir uygulayıcının çağırana döndürülen hata iletisini denetlemesine ve isteğe bağlı olarak günlüğe kaydetme gibi özel hata işleme gerçekleştirmesine izin verir.

public interface class IErrorHandler

public interface IErrorHandler

type IErrorHandler = interface

Public Interface IErrorHandler

Örnekler

Aşağıdaki kod örneğinde, yalnızca FaultException<TDetail> bir hizmet yöntemi yönetilen özel durum oluştururken türünde GreetingFault döndüren bir hizmet gösterilmektedirIErrorHandler.

#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

Aşağıdaki kod örneği, uygulamayı ErrorHandlers özelliğine eklemek için hizmet davranışının IErrorHandler nasıl kullanılacağını gösterir.

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

Aşağıdaki kod örneğinde, bir uygulama yapılandırma dosyası kullanarak hizmetin hizmet davranışını yüklenecek şekilde nasıl yapılandırılır gösterilmektedir. Yapılandırma dosyasında hizmet davranışını kullanıma sunma hakkında daha fazla bilgi için bkz 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>

Açıklamalar

Özel durum oluştuğunda uygulamanın davranışını açıkça denetlemek için arabirimini IErrorHandler uygulayın ve 'nin ErrorHandlers özelliğine ChannelDispatcherekleyin. IErrorHandler , oluşturulan SOAP hatasını açıkça denetlemenize, istemciye geri gönderilip gönderilmeyeceğine karar vermenize ve günlüğe kaydetme gibi ilişkili görevleri gerçekleştirmenize olanak tanır. Hata işleyicileri, özelliğine eklendikleri sırayla çağrılır ErrorHandlers .

İstemciye ProvideFault döndürülen hata iletisini denetlemek için yöntemini uygulayın.

HandleError Hata günlüğü, hızlı bir başarısızlığa neden olmak, uygulamayı kapatmak vb. dahil olmak üzere hatayla ilgili davranışları sağlamak için yöntemini uygulayın.

Uyarı

HandleError Yöntemin birçok farklı yerden çağrılabildiği için, yöntemin hangi iş parçacığında çağrıldığı konusunda hiçbir garanti yoktur. İşlem iş parçacığında HandleError çağrılan yönteme bağımlı değildir.

Yanıt iletisi gönderilmeden önce tüm ProvideFault uygulamalar çağrılır. Tüm ProvideFault uygulamalar çağrıldığında ve döndürildiğinde ve faultnulldeğilse, işlem sözleşmesine göre istemciye geri gönderilir. Tüm uygulamalar çağrıldıktan sonra ise faultnull , yanıt iletisi özellik değeri tarafından ServiceBehaviorAttribute.IncludeExceptionDetailInFaults denetlenirse.

Uyarı

Tüm ProvideFault uygulamalar çağrıldıktan ve kanala bir yanıt iletisi iletildikten sonra özel durumlar oluşabilir. Kanal özel durumu oluşursa (örneğin, iletiyi seri hale getirme zorluğu) IErrorHandler nesnelere bildirim gönderilir. Bu durumda, geliştirme ortamınızın bu tür özel durumları yakaladığından ve görüntülediğinden veya sorunu keşfetmek için izlemeyi kullandığından emin olmanız gerekir. İzleme hakkında daha fazla bilgi için bkz. Uygulamanızın Sorunlarını Gidermek için İzlemeyi Kullanma.

Yanıt iletisi gönderildikten sonra tüm HandleError uygulamalar aynı sırada çağrılır.

Genellikle, hizmetteki özelliğine ErrorHandlers (ve çift yönlü iletişim durumunda istemciye) bir IErrorHandler uygulama eklenir.

çalışma zamanına IErrorHandler bir davranış ( System.ServiceModel.Description.IServiceBehavior, System.ServiceModel.Description.IEndpointBehavior, System.ServiceModel.Description.IContractBehaviorveya System.ServiceModel.Description.IOperationBehavior nesnesi) uygulayarak ve bir yapılandırma dosyasından veya özel IErrorHandlerbir öznitelikle kullanarak davranışını program aracılığıyla kullanarak öğesini ekleyebilirsiniz.

Çalışma zamanını değiştirmek için davranışları kullanma hakkında daha fazla bilgi için bkz. Çalışma Zamanını Davranışlarla Yapılandırma ve Genişletme.

Yöntemler

Name	Description
HandleError(Exception)	Hatayla ilgili işlemeyi etkinleştirir ve dağıtıcının oturumu ve belirli durumlarda örnek bağlamını durdurup durdurmadığını belirten bir değer döndürür.
ProvideFault(Exception, MessageVersion, Message)	Hizmet yöntemi boyunca bir özel durumdan döndürülen bir özel FaultException<TDetail> durumun oluşturulmasını sağlar.