IServiceBehavior Interfaccia

Riferimento

Definizione

Spazio dei nomi:: System.ServiceModel.Description

Assembly:: System.ServiceModel.dll

Importante

Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.

Fornisce un meccanismo per modificare o inserire estensioni personalizzate all'interno di un servizio, inclusa la classe ServiceHostBase.

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 come utilizzare un comportamento del servizio specificato in un file di configurazione per inserire un gestore di errori personalizzato in un'applicazione del servizio. In questo esempio, il gestore di errori intercetta tutte le eccezioni e le converte in un errore SOAP GreetingFault personalizzato che verrà quindi restituito al client.

La seguente implementazione di IServiceBehavior non aggiunge alcun oggetto parametro di associazione, aggiunge invece l'oggetto personalizzato System.ServiceModel.Dispatcher.IErrorHandler a ogni proprietà ChannelDispatcher.ErrorHandlers, convalida ogni operazione del servizio al quale viene applicato il comportamento del servizio e dispone di 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 == 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

In questo esempio, la classe di comportamento implementa anche System.ServiceModel.Configuration.BehaviorExtensionElement che consente al comportamento del servizio di essere inserito utilizzandolo in un file di configurazione dell'applicazione, come dimostra l'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 l'interfaccia IServiceBehavior per modificare, esaminare o estendere aspetti dell'esecuzione del servizio a livello di applicazione:

Utilizzare il metodo ApplyDispatchBehavior per modificare i valori delle proprietà della fase di esecuzione o inserire oggetti di estensione personalizzati, ad esempio gestori di errori, intercettatori di messaggi o parametri, estensioni di sicurezza e altri oggetti di estensione personalizzati.
Usare 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 metodo AddBindingParameters per passare le informazioni personalizzate per il servizio a un elemento dell'associazione, in modo che possa supportare il servizio correttamente.

Gli oggetti IServiceBehavior possono utilizzare uno o più di questi metodi, ma spesso soltanto uno di essi è importante. In questi casi, è possibile che i metodi non utilizzati non restituiscano un valore.

Nota

Tutti i metodi IServiceBehavior passano gli oggetti System.ServiceModel.Description.ServiceDescription e System.ServiceModel.ServiceHostBase come parametri. Il parametro ServiceDescription è utilizzabile solo per attività di esame. Se gli oggetti vengono modificati, il comportamento di esecuzione sarà indefinito.

Per eseguire un'attività di personalizzazione specificata, è necessario aggiungere l'oggetto IServiceBehavior alla proprietà Behaviors prima della costruzione della fase di esecuzione del servizio. Questa operazione può essere eseguita in tre modi:

Aggiungere il comportamento del servizio personalizzato a livello di programmazione alla proprietà Behaviors prima che il metodo ICommunicationObject.Open venga chiamato sull'oggetto System.ServiceModel.ServiceHost.
Creare un attributo personalizzato che implementi IServiceBehavior e utilizzarlo per contrassegnare le classi del 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 su ServiceDescription.
Estendere la classe System.ServiceModel.Configuration.BehaviorExtensionElement per supportare la specifica del comportamento in un'applicazione o in un file di configurazione del computer. Per ulteriori informazioni, vedere la sezione relativa agli esempi.

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

Metodi

AddBindingParameters(ServiceDescription, ServiceHostBase, Collection<ServiceEndpoint>, BindingParameterCollection)	Consente di passare i dati personalizzati agli elementi di associazione per supportare l'implementazione del contratto.
ApplyDispatchBehavior(ServiceDescription, ServiceHostBase)	Consente di modificare i valori delle proprietà della fase di esecuzione o inserire oggetti di estensione personalizzati, ad esempio gestori di errori, intercettatori di messaggi o parametri, estensioni di sicurezza e altri oggetti di estensione personalizzati.
Validate(ServiceDescription, ServiceHostBase)	Consente di controllare l'host del servizio e la descrizione del servizio per verificare che il servizio può essere eseguito correttamente.

Si applica a

Condividi tramite