IServiceBehavior Interface

Referência

Definição

Namespace:: System.ServiceModel.Description

Assembly:: System.ServiceModel.dll

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Fornece um mecanismo para modificar ou inserir extensões personalizadas em um serviço inteiro, incluindo o ServiceHostBase.

public interface class IServiceBehavior

public interface IServiceBehavior

type IServiceBehavior = interface

Public Interface IServiceBehavior

Derivado: System.ServiceModel.Activation.AspNetCompatibilityRequirementsAttribute

System.ServiceModel.Activities.Description.BufferedReceiveServiceBehavior

System.ServiceModel.Activities.Description.EtwTrackingBehavior

System.ServiceModel.Activities.Description.SqlWorkflowInstanceStoreBehavior

System.ServiceModel.Activities.Description.WorkflowIdleBehavior

Mais…

Exemplos

O exemplo de código a seguir mostra o uso de um comportamento de serviço especificado em um arquivo de configuração para inserir um manipulador de erros personalizado em um aplicativo de serviço. Neste exemplo, o manipulador de erros captura todas as exceções e as converte em uma falha SOAP personalizada GreetingFault que é retornada para o cliente.

A implementação a seguir IServiceBehavior não adiciona objetos de parâmetro de associação, adiciona o objeto personalizado System.ServiceModel.Dispatcher.IErrorHandler a cada ChannelDispatcher.ErrorHandlers propriedade e valida que cada operação do serviço ao qual o comportamento do serviço é aplicado e tem um System.ServiceModel.FaultContractAttribute tipo 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

Neste exemplo, a classe de comportamento também implementa System.ServiceModel.Configuration.BehaviorExtensionElement, o que permite que o comportamento do serviço seja inserido usando-o em um arquivo de configuração de aplicativo, como demonstra o exemplo de código a seguir.

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

Comentários

Implemente IServiceBehavior para modificar, examinar ou estender algum aspecto da execução em todo o serviço no nível do aplicativo:

Use o ApplyDispatchBehavior método para alterar valores de propriedade em tempo de execução ou inserir objetos de extensão personalizados, como manipuladores de erros, interceptadores de mensagens ou parâmetros, extensões de segurança e outros objetos de extensão personalizados.
Use o Validate método para examinar a descrição antes que Windows WCF (Communication Foundation) construa o serviço em execução para confirmar se ele pode ser executado corretamente.
Use o AddBindingParameters método para passar para um elemento de associação as informações personalizadas do serviço para que ele possa dar suporte ao serviço corretamente.

IServiceBehavior os objetos podem usar qualquer um desses métodos, mas geralmente apenas um é importante; nesses casos, os métodos não utilizados podem retornar sem um valor.

Observação

Todos os IServiceBehavior métodos passam System.ServiceModel.Description.ServiceDescription e System.ServiceModel.ServiceHostBase objetos como parâmetros. O ServiceDescription parâmetro é somente para exame; se você modificar esses objetos, o comportamento de execução será indefinido.

Para executar a tarefa de personalização para a qual se destina, o IServiceBehavior objeto deve ser adicionado à Behaviors propriedade antes da construção do runtime de serviço. Há três modos de fazer isso:

Adicione programaticamente o comportamento de serviço personalizado à Behaviors propriedade antes do ponto em que o ICommunicationObject.Open método é chamado no System.ServiceModel.ServiceHost objeto.
Crie um atributo personalizado que implemente IServiceBehavior e use-o para marcar classes de serviço que devem ser modificadas. Quando um ServiceHost objeto é construído, o WCF usa reflexão para descobrir os atributos no tipo de serviço. Se algum atributo for implementado IServiceBehavior, eles serão adicionados à coleção de comportamentos em ServiceDescription.
Estenda a System.ServiceModel.Configuration.BehaviorExtensionElement classe para dar suporte à especificação do comportamento em um arquivo de configuração de aplicativo ou computador. Consulte a seção Exemplo para obter mais informações.

Exemplos de comportamentos de serviço no WCF incluem o ServiceBehaviorAttribute atributo, o System.ServiceModel.Description.ServiceThrottlingBehaviorcomportamento e System.ServiceModel.Description.ServiceMetadataBehavior oSystem.ServiceModel.Description.ServiceDebugBehavior.

Métodos

AddBindingParameters(ServiceDescription, ServiceHostBase, Collection<ServiceEndpoint>, BindingParameterCollection)	Fornece a capacidade de passar dados personalizados para elementos de associação para dar suporte à implementação do contrato.
ApplyDispatchBehavior(ServiceDescription, ServiceHostBase)	Fornece a capacidade de alterar valores de propriedade de tempo de execução ou inserir objetos de extensão personalizados, como manipuladores de erro, interceptores de mensagens ou parâmetros, extensões de segurança e outros objetos de extensão personalizados.
Validate(ServiceDescription, ServiceHostBase)	Fornece a capacidade de inspecionar o host de serviço e a descrição do serviço para confirmar se o serviço pode ser executado com êxito.

Aplica-se a

Partilhar via