IServiceBehavior Interfejs

Odwołanie

Definicja

Przestrzeń nazw:: System.ServiceModel.Description

Zestaw:: System.ServiceModel.dll

Ważne

Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.

Udostępnia mechanizm modyfikowania lub wstawiania rozszerzeń niestandardowych w całej usłudze, w tym .ServiceHostBase

public interface class IServiceBehavior

public interface IServiceBehavior

type IServiceBehavior = interface

Public Interface IServiceBehavior

Pochodne: System.ServiceModel.Activation.AspNetCompatibilityRequirementsAttribute

System.ServiceModel.Activities.Description.BufferedReceiveServiceBehavior

System.ServiceModel.Activities.Description.EtwTrackingBehavior

System.ServiceModel.Activities.Description.SqlWorkflowInstanceStoreBehavior

System.ServiceModel.Activities.Description.WorkflowIdleBehavior

Więcej…

Przykłady

Poniższy przykład kodu przedstawia użycie zachowania usługi określonego w pliku konfiguracji w celu wstawienia niestandardowej procedury obsługi błędów w aplikacji usługi. W tym przykładzie program obsługi błędów przechwytuje wszystkie wyjątki i konwertuje je na niestandardowy GreetingFault błąd protokołu SOAP, który następnie jest zwracany do klienta.

Poniższa IServiceBehavior implementacja nie dodaje żadnych obiektów parametrów powiązania, dodaje obiekt niestandardowy System.ServiceModel.Dispatcher.IErrorHandler do każdej ChannelDispatcher.ErrorHandlers właściwości i sprawdza, czy każda operacja usługi, do której zastosowano zachowanie usługi, i ma System.ServiceModel.FaultContractAttribute typ 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

W tym przykładzie klasa zachowania implementuje System.ServiceModel.Configuration.BehaviorExtensionElementrównież element , który umożliwia wstawianie zachowania usługi przy użyciu go w pliku konfiguracji aplikacji, jak pokazano w poniższym przykładzie kodu.

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

Uwagi

Zaimplementuj IServiceBehavior , aby zmodyfikować, zbadać lub rozszerzyć pewien aspekt wykonywania w całej usłudze na poziomie aplikacji:

ApplyDispatchBehavior Użyj metody , aby zmienić wartości właściwości czasu wykonywania lub wstawić niestandardowe obiekty rozszerzenia, takie jak programy obsługi błędów, przechwytywanie komunikatów lub parametrów, rozszerzenia zabezpieczeń i inne niestandardowe obiekty rozszerzenia.
Validate Użyj metody , aby sprawdzić opis przed Windows Communication Foundation (WCF) tworzy usługę wykonującą, aby potwierdzić, że może ona działać prawidłowo.
AddBindingParameters Użyj metody , aby przekazać do elementu powiązania informacje niestandardowe dla usługi, aby mogła poprawnie obsługiwać usługę.

IServiceBehavior obiekty mogą korzystać z dowolnej z tych metod, ale często tylko jedna z nich jest ważna; w takich przypadkach nieużywane metody mogą zwracać bez wartości.

Uwaga

IServiceBehavior Wszystkie metody przekazują System.ServiceModel.Description.ServiceDescription obiekty i System.ServiceModel.ServiceHostBase jako parametry. Parametr jest przeznaczony tylko do badania. Jeśli ServiceDescription zmodyfikujesz te obiekty, zachowanie wykonywania jest niezdefiniowane.

Aby wykonać zadanie dostosowywania, dla którego jest on przeznaczony, IServiceBehavior należy dodać obiekt do Behaviors właściwości przed utworzeniem środowiska uruchomieniowego usługi. Istnieją trzy sposoby, aby to zrobić:

Programowo dodaj zachowanie usługi niestandardowej Behaviors do właściwości przed punktem, w którym ICommunicationObject.Open metoda jest wywoływana w System.ServiceModel.ServiceHost obiekcie.
Utwórz atrybut niestandardowy, który implementuje IServiceBehavior i używa go do oznaczania klas usług, które mają zostać zmodyfikowane. Podczas ServiceHost konstruowania obiektu program WCF używa odbicia w celu odnalezienia atrybutów typu usługi. Jeśli jakiekolwiek atrybuty implementują IServiceBehaviorelement , są one dodawane do kolekcji zachowań w systemie ServiceDescription.
Rozszerz klasę tak System.ServiceModel.Configuration.BehaviorExtensionElement , aby obsługiwała specyfikację zachowania w pliku konfiguracji aplikacji lub maszyny. Aby uzyskać więcej informacji, zobacz sekcję Przykład.

Przykłady zachowań usługi w programie WCF obejmują ServiceBehaviorAttribute atrybut , System.ServiceModel.Description.ServiceThrottlingBehaviori System.ServiceModel.Description.ServiceDebugBehavior System.ServiceModel.Description.ServiceMetadataBehavior zachowanie.

Metody

AddBindingParameters(ServiceDescription, ServiceHostBase, Collection<ServiceEndpoint>, BindingParameterCollection)	Zapewnia możliwość przekazywania danych niestandardowych do elementów powiązania w celu obsługi implementacji kontraktu.
ApplyDispatchBehavior(ServiceDescription, ServiceHostBase)	Umożliwia zmianę wartości właściwości czasu wykonywania lub wstawianie niestandardowych obiektów rozszerzenia, takich jak programy obsługi błędów, przechwytywanie komunikatów lub parametrów, rozszerzenia zabezpieczeń i inne niestandardowe obiekty rozszerzenia.
Validate(ServiceDescription, ServiceHostBase)	Zapewnia możliwość inspekcji hosta usługi i opisu usługi w celu potwierdzenia, że usługa może działać pomyślnie.

Dotyczy

Share via