IServiceBehavior Rozhraní

Reference

Definice

Obor názvů:: System.ServiceModel.Description

Sestavení:: System.ServiceModel.dll

Důležité

Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.

Poskytuje mechanismus pro úpravy nebo vkládání vlastních rozšíření napříč celou službou, včetně ServiceHostBase.

public interface class IServiceBehavior

public interface IServiceBehavior

type IServiceBehavior = interface

Public Interface IServiceBehavior

Odvozené: System.ServiceModel.Activation.AspNetCompatibilityRequirementsAttribute

System.ServiceModel.Activities.Description.BufferedReceiveServiceBehavior

System.ServiceModel.Activities.Description.EtwTrackingBehavior

System.ServiceModel.Activities.Description.SqlWorkflowInstanceStoreBehavior

System.ServiceModel.Activities.Description.WorkflowIdleBehavior

Více…

Příklady

Následující příklad kódu ukazuje použití chování služby zadané v konfiguračním souboru k vložení vlastní obslužné rutiny chyby do aplikace služby. V tomto příkladu obslužná rutina chyby zachytí všechny výjimky a převede je na vlastní GreetingFault chybu SOAP, která se pak vrátí klientovi.

Následující IServiceBehavior implementace nepřidá žádné objekty parametrů vazby, přidá vlastní System.ServiceModel.Dispatcher.IErrorHandler objekt do každé ChannelDispatcher.ErrorHandlers vlastnosti a ověří, že každá operace služby, na kterou se používá chování služby a má 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

V tomto příkladu třída chování také implementuje System.ServiceModel.Configuration.BehaviorExtensionElement, což umožňuje, aby chování služby bylo vloženo pomocí něj do konfiguračního souboru aplikace, jak ukazuje následující příklad kódu.

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

Poznámky

Implementujte IServiceBehavior úpravu, prozkoumání nebo rozšíření určitého aspektu provádění na úrovni aplikace:

ApplyDispatchBehavior Pomocí této metody můžete změnit hodnoty vlastností za běhu nebo vložit vlastní objekty rozšíření, jako jsou obslužné rutiny chyb, zachytávání zpráv nebo zachytávání parametrů, rozšíření zabezpečení a další vlastní objekty rozšíření.
Validate Pomocí metody zkontrolujte popis před Windows Communication Foundation (WCF) vytvoří spuštěnou službu, abyste ověřili, že může správně spustit.
AddBindingParameters Pomocí metody předejte element vazby vlastní informace pro službu, aby mohl službu správně podporovat.

IServiceBehavior objekty mohou využívat některou z těchto metod, ale často je důležitá pouze jedna; v takových případech se nepoužívané metody můžou vrátit bez hodnoty.

Poznámka

IServiceBehavior Všechny metody předávají System.ServiceModel.Description.ServiceDescription a System.ServiceModel.ServiceHostBase objekty jako parametry. Parametr ServiceDescription je určen pouze pro zkoumání. Pokud tyto objekty upravíte, chování provádění není definováno.

Chcete-li provést úlohu přizpůsobení, pro kterou je určena, IServiceBehavior musí být objekt přidán do Behaviors vlastnosti před vytvořením modulu runtime služby. Můžete to udělat třemi způsoby:

Prostřednictvím kódu programu přidejte vlastní chování služby do Behaviors vlastnosti před bodem, kde ICommunicationObject.Open je metoda volána na System.ServiceModel.ServiceHost objekt.
Vytvořte vlastní atribut, který implementuje IServiceBehavior a používá ho k označení tříd služby, které se mají upravit. ServiceHost Když je objekt vytvořen, WCF používá reflexi ke zjištění atributů typu služby. Pokud některé atributy implementují IServiceBehavior, přidají se do kolekce chování na ServiceDescription.
System.ServiceModel.Configuration.BehaviorExtensionElement Rozšiřte třídu tak, aby podporovala specifikaci chování v konfiguračním souboru aplikace nebo počítače. Další informace najdete v části Příklad.

Mezi příklady chování služeb ve WCF patří ServiceBehaviorAttribute atribut, System.ServiceModel.Description.ServiceThrottlingBehaviorthe , the System.ServiceModel.Description.ServiceDebugBehavior and the System.ServiceModel.Description.ServiceMetadataBehavior behavior.

Metody

AddBindingParameters(ServiceDescription, ServiceHostBase, Collection<ServiceEndpoint>, BindingParameterCollection)	Poskytuje možnost předat vlastní data do vazeb prvků pro podporu implementace kontraktu.
ApplyDispatchBehavior(ServiceDescription, ServiceHostBase)	Poskytuje možnost měnit hodnoty vlastností za běhu nebo vkládat vlastní objekty rozšíření, jako jsou obslužné rutiny chyb, zachytávání zpráv nebo zachytávání parametrů, rozšíření zabezpečení a další vlastní objekty rozšíření.
Validate(ServiceDescription, ServiceHostBase)	Poskytuje možnost zkontrolovat hostitele služby a popis služby a ověřit, že se služba může úspěšně spustit.

Platí pro

Share via