IServiceBehavior Интерфейс

Определение

Предоставляет механизм для изменения или вставки настраиваемых расширений в целые службы, включая ServiceHostBase.Provides a mechanism to modify or insert custom extensions across an entire service, including the ServiceHostBase.

public interface class IServiceBehavior
public interface IServiceBehavior
type IServiceBehavior = interface
Public Interface IServiceBehavior
Производный

Примеры

В следующем образце кода показано использование расширений функциональности службы, заданных в файле конфигурации, для вставки настраиваемого обработчика ошибок в приложение службы.The following code example shows the use of a service behavior specified in a configuration file to insert a custom error handler in a service application. В данном примере обработчик ошибок выполняет перехват всех исключений и преобразование их в настраиваемые ошибки SOAP GreetingFault, которые затем возвращаются клиенту.In this example, the error handler catches all exceptions and converts them into a custom GreetingFault SOAP fault that is then returned to the client.

Следующая реализация IServiceBehavior не добавляет объекты параметра привязки, но добавляет настраиваемый объект System.ServiceModel.Dispatcher.IErrorHandler в каждое свойство ChannelDispatcher.ErrorHandlers и проверяет наличие для каждой операции службы, к которой применяются расширения функциональности службы, System.ServiceModel.FaultContractAttribute типа GreetingFault.The following IServiceBehavior implementation adds no binding parameter objects, adds the custom System.ServiceModel.Dispatcher.IErrorHandler object to each ChannelDispatcher.ErrorHandlers property, and validates that each operation of the service to which the service behavior is applied and has a System.ServiceModel.FaultContractAttribute of type 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 == 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

В данном примере класс расширений функциональности также реализует System.ServiceModel.Configuration.BehaviorExtensionElement, который включает расширения функциональности службы для вставки путем их использования в файле конфигурации приложения, как показано в следующем примере кода.In this example, the behavior class also implements System.ServiceModel.Configuration.BehaviorExtensionElement, which enables the service behavior to be inserted by using it in an application configuration file, as the following code example demonstrates.

<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 для изменения, проверки или расширения определенного аспекта выполнения для всей службы на уровне приложения.Implement IServiceBehavior to modify, examine, or extend some aspect of service-wide execution at the application level:

  • Можно использовать метод ApplyDispatchBehavior для изменения значений свойства времени выполнения или для вставки объектов настраиваемых расширений, например, обработчиков ошибок, перехватчиков параметров или сообщений, а также других объектов настраиваемых расширений.Use the ApplyDispatchBehavior method to change run-time property values or insert custom extension objects such as error handlers, message or parameter interceptors, security extensions, and other custom extension objects.

  • Validate Используйте метод для проверки описания, прежде чем Windows Communication Foundation (WCF) конструирует выполняющуюся службу, чтобы убедиться, что она может быть выполнена правильно.Use the Validate method to examine the description before Windows Communication Foundation (WCF) constructs the executing service to confirm that it can execute properly.

  • Метод AddBindingParameters используется для передачи в элемент привязки настраиваемых сведений для службы, чтобы обеспечить ее работу.Use the AddBindingParameters method to pass to a binding element the custom information for the service so that it can support the service correctly.

Объекты IServiceBehavior могут использовать любые из этих методов, но часто важен только один; в таких случаях неиспользуемые методы могут не возвращать никакого значения.IServiceBehavior objects can make use of any of these methods, but often only one is important; in such cases the unused methods can return without a value.

Примечание

Все методы IServiceBehavior передают в качестве параметра объекты System.ServiceModel.Description.ServiceDescription и System.ServiceModel.ServiceHostBase.All of the IServiceBehavior methods pass System.ServiceModel.Description.ServiceDescription and System.ServiceModel.ServiceHostBase objects as a parameters. Этот параметр используется только для проверки; при изменении объекта ServiceDescription, расширение функциональности выполнения не определено.The ServiceDescription parameter is for examination only; if you modify these objects the execution behavior is undefined.

Чтобы выполнить настройку задачи, для которой предназначен этот параметр, необходимо добавить объект IServiceBehavior в свойство Behaviors перед построением среды выполнения службы.To perform the customization task for which it is intended, the IServiceBehavior object must be added to the Behaviors property prior to the construction of the service runtime. Это можно сделать тремя способами:There are three ways to do this:

  • Программно добавить пользовательское расширение функциональности настраиваемой службы в свойство Behaviors перед тем, как метод ICommunicationObject.Open вызывается на объекте System.ServiceModel.ServiceHost.Programmatically add the custom service behavior to the Behaviors property prior to the point where the ICommunicationObject.Open method is called on the System.ServiceModel.ServiceHost object.

  • Создать настраиваемый атрибут, который реализует IServiceBehavior и использует его для маркировки классов службы, которые следует изменить.Create a custom attribute that implements IServiceBehavior and use it to mark service classes that are to be modified. При создании ServiceHost объекта WCF использует отражение для обнаружения атрибутов типа службы.When a ServiceHost object is constructed, WCF uses reflection to discover the attributes on the service type. Любые атрибуты, реализующие IServiceBehavior, добавляются в коллекцию расширений функциональности в ServiceDescription.If any attributes implement IServiceBehavior, they are added to the behaviors collection on ServiceDescription.

  • Примените расширение для класса System.ServiceModel.Configuration.BehaviorExtensionElement, чтобы включить поддержку спецификаций расширений функциональности в приложении или файле конфигурации.Extend the System.ServiceModel.Configuration.BehaviorExtensionElement class to support the specification of the behavior in an application or machine configuration file. Дополнительные сведения см. в разделе «Пример».See the Example section for more information.

Примерами поведения службы в WCF ServiceBehaviorAttribute являются атрибут System.ServiceModel.Description.ServiceThrottlingBehavior,, System.ServiceModel.Description.ServiceDebugBehavior и System.ServiceModel.Description.ServiceMetadataBehavior поведение.Examples of service behaviors in WCF include the ServiceBehaviorAttribute attribute, the System.ServiceModel.Description.ServiceThrottlingBehavior, the System.ServiceModel.Description.ServiceDebugBehavior and the System.ServiceModel.Description.ServiceMetadataBehavior behavior.

Методы

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

Предоставляет возможности передачи настраиваемых данных в элементы привязки для предоставления поддержки реализации контракта.Provides the ability to pass custom data to binding elements to support the contract implementation.

ApplyDispatchBehavior(ServiceDescription, ServiceHostBase)

Предоставляет возможности для изменения значений свойства времени выполнения или для вставки объектов настраиваемых расширений, например, обработчиков ошибок, перехватчиков параметров или сообщений, а также других объектов настраиваемых расширений.Provides the ability to change run-time property values or insert custom extension objects such as error handlers, message or parameter interceptors, security extensions, and other custom extension objects.

Validate(ServiceDescription, ServiceHostBase)

Предоставляет возможности проверки ведущего приложения и описания службы, чтобы подтвердить готовность службы.Provides the ability to inspect the service host and the service description to confirm that the service can run successfully.

Применяется к