IServiceBehavior Interfaccia

Definizione

public interface class IServiceBehavior

public interface IServiceBehavior

type IServiceBehavior = interface

Public Interface IServiceBehavior

Derivato

System.ServiceModel.Activation.AspNetCompatibilityRequirementsAttribute

System.ServiceModel.Activities.Description.BufferedReceiveServiceBehavior

System.ServiceModel.Activities.Description.EtwTrackingBehavior

System.ServiceModel.Activities.Description.SqlWorkflowInstanceStoreBehavior

System.ServiceModel.Activities.Description.WorkflowIdleBehavior

Altro…

Esempio

Nell'esempio di codice seguente viene illustrato l'uso di un comportamento del servizio specificato in un file di configurazione per inserire un gestore di errori personalizzato in un'applicazione di servizio. In questo esempio, il gestore degli errori intercetta tutte le eccezioni e le converte in un errore SOAP personalizzato GreetingFault che viene quindi restituito al client.

L'implementazione seguente IServiceBehavior non aggiunge oggetti parametro di associazione, aggiunge l'oggetto personalizzato System.ServiceModel.Dispatcher.IErrorHandler a ogni ChannelDispatcher.ErrorHandlers proprietà e verifica che ogni operazione del servizio a cui viene applicato il comportamento del servizio e abbia un System.ServiceModel.FaultContractAttribute di 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

In questo esempio, la classe di comportamento implementa System.ServiceModel.Configuration.BehaviorExtensionElementanche , che consente di inserire il comportamento del servizio usandolo in un file di configurazione dell'applicazione, come illustrato nell'esempio di codice seguente.

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

Commenti

Implementare IServiceBehavior per modificare, esaminare o estendere alcuni aspetti dell'esecuzione a livello di servizio a livello di applicazione:

• Utilizzare il ApplyDispatchBehavior metodo per modificare i valori delle proprietà di runtime o inserire oggetti di estensione personalizzati, ad esempio gestori degli errori, intercettori di messaggi o parametri, estensioni di sicurezza e altri oggetti di estensione personalizzati.

• Utilizzare il Validate metodo per esaminare la descrizione prima che Windows Communication Foundation (WCF) costruisca il servizio in esecuzione per verificare che possa essere eseguito correttamente.

• Utilizzare il AddBindingParameters metodo per passare a un elemento di associazione le informazioni personalizzate per il servizio in modo che possano supportare correttamente il servizio.

IServiceBehavior gli oggetti possono utilizzare uno di questi metodi, ma spesso solo uno è importante; in questi casi i metodi inutilizzati possono restituire senza un valore.

Per eseguire l'attività di personalizzazione per cui è prevista, è necessario aggiungere l'oggetto IServiceBehavior alla Behaviors proprietà prima della costruzione del runtime del servizio. Esistono tre modi per eseguire questa operazione:

• Aggiungere a livello di codice il comportamento del servizio personalizzato alla Behaviors proprietà prima del punto in cui viene chiamato il ICommunicationObject.Open metodo sull'oggetto System.ServiceModel.ServiceHost .

• Creare un attributo personalizzato che implementa IServiceBehavior e usarlo per contrassegnare le classi di servizio da modificare. Quando viene costruito un ServiceHost oggetto, WCF usa la reflection per individuare gli attributi nel tipo di servizio. Se gli attributi implementano IServiceBehavior, vengono aggiunti alla raccolta di comportamenti in ServiceDescription.

• Estendere la System.ServiceModel.Configuration.BehaviorExtensionElement classe per supportare la specifica del comportamento in un file di configurazione dell'applicazione o del computer. Per altre informazioni, vedere la sezione Esempio.

Esempi di comportamenti del servizio in WCF includono l'attributo ServiceBehaviorAttribute , System.ServiceModel.Description.ServiceThrottlingBehavior, System.ServiceModel.Description.ServiceDebugBehavior e il System.ServiceModel.Description.ServiceMetadataBehavior comportamento.