IServiceBehavior Arabirim

Tanım

dahil olmak üzere ServiceHostBasebir hizmetin tamamında özel uzantıları değiştirmek veya eklemek için bir mekanizma sağlar.

public interface class IServiceBehavior
public interface IServiceBehavior
type IServiceBehavior = interface
Public Interface IServiceBehavior
Türetilmiş

Örnekler

Aşağıdaki kod örneği, bir hizmet uygulamasına özel hata işleyicisi eklemek için yapılandırma dosyasında belirtilen bir hizmet davranışının kullanımını gösterir. Bu örnekte hata işleyicisi tüm özel durumları yakalar ve bunları istemciye döndürülen özel GreetingFault bir SOAP hatasına dönüştürür.

Aşağıdaki IServiceBehavior uygulama hiçbir bağlama parametresi nesnesi eklemez, özel nesneyi her ChannelDispatcher.ErrorHandlers özelliğe ekler System.ServiceModel.Dispatcher.IErrorHandler ve hizmet davranışının uygulandığı ve türünde GreetingFaultbir hizmet işleminin olduğunu System.ServiceModel.FaultContractAttribute doğrular.

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

Bu örnekte davranış sınıfı, aşağıdaki kod örneğinde gösterildiği gibi hizmet davranışının bir uygulama yapılandırma dosyasında kullanılarak eklenmesini sağlayan uygulamasını da uygular System.ServiceModel.Configuration.BehaviorExtensionElement.

<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

Uygulama düzeyinde hizmet genelinde yürütmenin bazı yönlerini değiştirmek, incelemek veya genişletmek için uygulayın IServiceBehavior :

  • ApplyDispatchBehavior Çalışma zamanı özellik değerlerini değiştirmek veya hata işleyicileri, ileti veya parametre kesme makineleri, güvenlik uzantıları ve diğer özel uzantı nesneleri gibi özel uzantı nesneleri eklemek için yöntemini kullanın.

  • Validate Windows Communication Foundation (WCF) düzgün bir şekilde yürütülebildiğini onaylamak üzere yürütme hizmetini oluşturmadan önce açıklamasını incelemek için yöntemini kullanın.

  • AddBindingParameters Hizmeti doğru şekilde destekleyebilmesi için bir bağlama öğesine hizmet için özel bilgileri geçirmek için yöntemini kullanın.

IServiceBehavior nesneleri bu yöntemlerden herhangi birini kullanabilir, ancak genellikle yalnızca biri önemlidir; bu gibi durumlarda kullanılmayan yöntemler değer olmadan döndürülebilir.

Not

IServiceBehavior Tüm yöntemler ve System.ServiceModel.ServiceHostBase nesnelerini parametre olarak geçirirSystem.ServiceModel.Description.ServiceDescription. ServiceDescription parametresi yalnızca inceleme içindir; bu nesneleri değiştirirseniz yürütme davranışı tanımsızdır.

Hedeflendiği özelleştirme görevini gerçekleştirmek için, nesnenin IServiceBehavior hizmet çalışma zamanının Behaviors oluşturulmasından önce özelliğine eklenmesi gerekir. Bunu yapmanın üç yolu vardır:

WCF'deki hizmet davranışlarına ServiceBehaviorAttribute örnek olarak özniteliği, System.ServiceModel.Description.ServiceThrottlingBehavior, System.ServiceModel.Description.ServiceDebugBehavior ve System.ServiceModel.Description.ServiceMetadataBehavior davranışı verilebilir.

Yöntemler

AddBindingParameters(ServiceDescription, ServiceHostBase, Collection<ServiceEndpoint>, BindingParameterCollection)

Sözleşme uygulamasını desteklemek için bağlama öğelerine özel veri geçirme olanağı sağlar.

ApplyDispatchBehavior(ServiceDescription, ServiceHostBase)

Çalışma zamanı özellik değerlerini değiştirme veya hata işleyicileri, ileti veya parametre kesme makineleri, güvenlik uzantıları ve diğer özel uzantı nesneleri gibi özel uzantı nesneleri ekleme olanağı sağlar.

Validate(ServiceDescription, ServiceHostBase)

Hizmetin başarıyla çalışabildiğini onaylamak için hizmet ana bilgisayarını ve hizmet açıklamasını inceleme olanağı sağlar.

Şunlara uygulanır