IServiceBehavior Interface

Definição

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 seguinte mostra a utilização de um comportamento de serviço especificado num ficheiro de configuração para inserir um manipulador de erros personalizado numa aplicação de serviço. Neste exemplo, o handler de erros apanha todas as exceções e converte-as numa falha SOAP personalizada GreetingFault que é depois devolvida ao cliente.

A implementação seguinte IServiceBehavior não adiciona objetos de parâmetro de ligaçã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 de 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)
      {
        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, que permite inserir o comportamento do serviço ao usá-lo num ficheiro de configuração de aplicação, como demonstra o exemplo de código seguinte.

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

Observações

Implementar IServiceBehavior para modificar, examinar ou estender algum aspeto da execução em toda a aplicação ao nível da aplicação:

• Use o ApplyDispatchBehavior método para alterar valores de propriedades em tempo de execução ou inserir objetos de extensão personalizados, como manipuladores de erros, interceptores de mensagens ou parâmetros, extensões de segurança e outros objetos de extensão personalizados.

• Utilize o método Validate para examinar a descrição antes de Windows Communication Foundation (WCF) construir o serviço em execução para confirmar que pode ser executado corretamente.

• Use o AddBindingParameters método para passar a um elemento de ligação a informação personalizada do serviço, de modo a que este possa suportá-lo corretamente.

IServiceBehavior Os objetos podem utilizar qualquer um destes métodos, mas muitas vezes apenas um é importante; nesses casos, os métodos não utilizados podem devolver sem valor.

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

• Adicione programaticamente o comportamento do 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, a WCF usa reflexão para descobrir os atributos no tipo de serviço. Se algum atributo implementar IServiceBehavior, eles são adicionados à coleção de comportamentos em ServiceDescription.

• Estenda a System.ServiceModel.Configuration.BehaviorExtensionElement classe para suportar a especificação do comportamento numa aplicação ou ficheiro de configuração de máquina. Consulte a secção Exemplo para mais informações.

Exemplos de comportamentos de serviço na WCF incluem o ServiceBehaviorAttribute atributo, o System.ServiceModel.Description.ServiceThrottlingBehavior, o System.ServiceModel.Description.ServiceDebugBehavior e o System.ServiceModel.Description.ServiceMetadataBehavior comportamento.