IServiceBehavior Интерфейс

Определение

public interface class IServiceBehavior

public interface IServiceBehavior

type IServiceBehavior = interface

Public Interface IServiceBehavior

Производный

System.ServiceModel.Activation.AspNetCompatibilityRequirementsAttribute

System.ServiceModel.Activities.Description.BufferedReceiveServiceBehavior

System.ServiceModel.Activities.Description.EtwTrackingBehavior

System.ServiceModel.Activities.Description.SqlWorkflowInstanceStoreBehavior

System.ServiceModel.Activities.Description.WorkflowIdleBehavior

Подробнее…

Примеры

В следующем примере кода показано использование поведения службы, указанного в файле конфигурации для вставки пользовательского обработчика ошибок в приложение службы. В этом примере обработчик ошибок перехватывает все исключения и преобразует их в пользовательскую GreetingFault ошибку SOAP, которая затем возвращается клиенту.

Следующая IServiceBehavior реализация не добавляет объекты параметров привязки, добавляет пользовательский System.ServiceModel.Dispatcher.IErrorHandler объект к каждому ChannelDispatcher.ErrorHandlers свойству и проверяет, что каждая операция службы, к которой применяется поведение службы, и имеет System.ServiceModel.FaultContractAttribute тип GreetingFault.

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

В этом примере класс поведения также реализует 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>

Комментарии

Реализуйте для IServiceBehavior изменения, проверки или расширения некоторых аспектов выполнения на уровне приложения:

• ApplyDispatchBehavior Используйте метод для изменения значений свойств во время выполнения или вставки пользовательских объектов расширения, таких как обработчики ошибок, перехватчики сообщений или параметров, расширения безопасности и другие пользовательские объекты расширения.

• Validate Используйте метод для проверки описания, прежде чем Windows Communication Foundation (WCF) создает службу выполнения, чтобы убедиться, что она может выполняться правильно.

• AddBindingParameters Используйте метод для передачи в элемент привязки пользовательских сведений для службы, чтобы обеспечить правильную поддержку службы.

IServiceBehavior объекты могут использовать любой из этих методов, но часто это важно. В таких случаях неиспользуемые методы могут возвращать без значения.

Чтобы выполнить задачу настройки, для которой она предназначена, IServiceBehavior объект необходимо добавить в Behaviors свойство до создания среды выполнения службы. Это можно сделать тремя способами.

• Программным способом добавьте поведение пользовательской службы в Behaviors свойство до точки, в которой ICommunicationObject.Open метод вызывается в объекте System.ServiceModel.ServiceHost .

• Создайте настраиваемый атрибут, реализующий IServiceBehavior и использующее его для маркировки классов служб, которые необходимо изменить. ServiceHost При создании объекта WCF использует отражение для обнаружения атрибутов типа службы. Если какие-либо атрибуты реализуют IServiceBehavior, они добавляются в коллекцию ServiceDescriptionповедения.

• System.ServiceModel.Configuration.BehaviorExtensionElement Расширьте класс для поддержки спецификации поведения в файле конфигурации приложения или компьютера. Дополнительные сведения см. в разделе "Пример".

Примеры поведения служб в WCF включают ServiceBehaviorAttribute атрибут, System.ServiceModel.Description.ServiceThrottlingBehaviorSystem.ServiceModel.Description.ServiceDebugBehavior поведение и System.ServiceModel.Description.ServiceMetadataBehavior поведение.