IServiceBehavior Schnittstelle

  • Referenz

Definition

Namespace:
System.ServiceModel.Description
Assembly:
System.ServiceModel.dll

Stellt einen Mechanismus bereit, um benutzerdefinierte Erweiterungen für einen gesamten Dienst zu ändern oder einzufügen, einschließlich ServiceHostBase.

public interface class IServiceBehavior
public interface IServiceBehavior
type IServiceBehavior = interface
Public Interface IServiceBehavior
Abgeleitet

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie ein in einer Anwendungskonfigurationsdatei angegebenes Dienstverhalten verwendet wird, um einen benutzerdefinierten Fehlerhandler in eine Dienstanwendung einzufügen. In diesem Beispiel fängt der Fehlerhandler alle Ausnahmen ab und wandelt sie in einen benutzerdefinierten GreetingFault-SOAP-Fehler um, der dann an den Client zurückgegeben wird.

Mit der folgenden IServiceBehavior-Implementierung werden keine Bindungsparameterobjekte hinzugefügt, wird das benutzerdefinierte System.ServiceModel.Dispatcher.IErrorHandler-Objekte jeder ChannelDispatcher.ErrorHandlers-Eigenschaft hinzugefügt und überprüft, dass jeder Vorgang des Diensts, auf den das Dienstverhalten angewendet wird, über ein System.ServiceModel.FaultContractAttribute des Typs GreetingFault verfügt.

// 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 diesem Beispiel implementiert die Verhaltensklasse auch System.ServiceModel.Configuration.BehaviorExtensionElement, wodurch das Dienstverhalten mithilfe einer Anwendungskonfigurationsdatei eingefügt werden kann, wie folgendes Codebeispiel zeigt.

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

Hinweise

Implementiert IServiceBehavior, um Aspekte der dienstweiten Ausführung auf Anwendungsebene zu ändern, zu überprüfen oder zu erweitern:

  • Verwenden Sie die ApplyDispatchBehavior-Methode zum Ändern von Eigenschaftenwerten zur Laufzeit oder zum Einfügen von benutzerdefinierten Erweiterungsobjekten, wie Fehlerhandler, Nachrichten- oder Parameterinterceptoren, Sicherheitserweiterungen und anderen benutzerdefinierten Erweiterungsobjekten.

  • Verwenden Sie die Validate Methode, um die Beschreibung zu untersuchen, bevor Windows Communication Foundation (WCF) den ausgeführten Dienst erstellt, um zu bestätigen, dass er ordnungsgemäß ausgeführt werden kann.

  • Verwenden Sie die AddBindingParameters-Methode, um benutzerdefinierte Informationen zum Dienst an ein Bindungselement zu übergeben, damit der Dienst korrekt unterstützt werden kann.

IServiceBehavior-Objekte können jede dieser Methoden nutzen, jedoch ist häufig nur eine Methode von Bedeutung; in einem solchen Fall geben die nicht verwendeten Methoden keinen Wert zurück.

Hinweis

Alle IServiceBehavior-Methoden übergeben System.ServiceModel.Description.ServiceDescription-Objekte und System.ServiceModel.ServiceHostBase-Objekte als Parameter. Der ServiceDescription-Parameter dient nur zur Prüfung; wenn Sie diese Objekte ändern, ist das Ausführungsverhalten nicht definiert.

Um eine Anpassungsaufgabe auszuführen, muss das entsprechende IServiceBehavior-Objekt der Behaviors-Eigenschaft vor der Erstellung der Dienstlaufzeit hinzugefügt werden. Hierzu stehen drei Möglichkeiten zur Verfügung:

Beispiele für Dienstverhalten in WCF umfassen das ServiceBehaviorAttribute Attribut, das Attribut, das System.ServiceModel.Description.ServiceThrottlingBehaviorund System.ServiceModel.Description.ServiceDebugBehavior das System.ServiceModel.Description.ServiceMetadataBehavior Verhalten.

Methoden

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

Bietet die Möglichkeit, benutzerdefinierte Daten an Bindungselemente zu übergeben, um die Vertragsimplementierung zu unterstützen.
ApplyDispatchBehavior(ServiceDescription, ServiceHostBase)

Stellt die Funktion zum Ausführen von Eigenschaftswerten zur Laufzeit oder zum Einfügen von benutzerdefinierten Erweiterungsobjekten, wie Fehlerhandler, Nachrichten- oder Parameterinterceptoren, Sicherheitserweiterungen und anderen benutzerdefinierten Erweiterungsobjekten, bereit.
Validate(ServiceDescription, ServiceHostBase)

Stellt die Funktion zur Verfügung, mit der der Diensthost und die Dienstbeschreibung geprüft werden können, um sicherzustellen, dass der Dienst erfolgreich ausgeführt wird.

Gilt für