ServiceBehaviorAttribute Klas

Definitie

public ref class ServiceBehaviorAttribute sealed : Attribute, System::ServiceModel::Description::IServiceBehavior

[System.AttributeUsage(System.AttributeTargets.Class)]
public sealed class ServiceBehaviorAttribute : Attribute, System.ServiceModel.Description.IServiceBehavior

[<System.AttributeUsage(System.AttributeTargets.Class)>]
type ServiceBehaviorAttribute = class
    inherit Attribute
    interface IServiceBehavior

Public NotInheritable Class ServiceBehaviorAttribute
Inherits Attribute
Implements IServiceBehavior

Overname

Object

Attribute

ServiceBehaviorAttribute

Kenmerken

AttributeUsageAttribute

Implementeringen

IServiceBehavior

Voorbeelden

In het volgende codevoorbeeld ziet u de ServiceBehaviorAttribute eigenschappen. De BehaviorService klasse gebruikt het ServiceBehaviorAttribute kenmerk om aan te geven dat:

• Het serviceobject wordt gerecycled wanneer de transactie is voltooid.

• Er is één serviceobject voor elke sessie.

• De service is één threaded en biedt geen ondersteuning voor nieuwe aanroepen.

Bovendien geven de OperationBehaviorAttribute waarden op bewerkingsniveau aan dat de TxWork methode automatisch wordt opgenomen in gestroomde transacties of dat er een nieuwe transactie wordt gemaakt om het werk uit te voeren en dat de transactie automatisch wordt doorgevoerd als er geen onverwerkte uitzondering optreedt.

using System;
using System.ServiceModel;
using System.Transactions;

namespace Microsoft.WCF.Documentation
{
  [ServiceContract(
    Namespace="http://microsoft.wcf.documentation",
    SessionMode=SessionMode.Required
  )]
  public interface IBehaviorService
  {
    [OperationContract]
    string TxWork(string message);
  }

  // Note: To use the TransactionIsolationLevel property, you
  // must add a reference to the System.Transactions.dll assembly.
  /* The following service implementation:
   *   -- Processes messages on one thread at a time
   *   -- Creates one service object per session
   *   -- Releases the service object when the transaction commits
   */
  [ServiceBehavior(
    ConcurrencyMode=ConcurrencyMode.Single,
    InstanceContextMode=InstanceContextMode.PerSession,
    ReleaseServiceInstanceOnTransactionComplete=true
  )]
  public class BehaviorService : IBehaviorService, IDisposable
  {
    Guid myID;

    public BehaviorService()
    {
      myID = Guid.NewGuid();
      Console.WriteLine(
        "Object "
        + myID.ToString()
        + " created.");
    }

    /*
     * The following operation-level behaviors are specified:
     *   -- The executing transaction is committed when
     *        the operation completes without an
     *        unhandled exception
     *   -- Always executes under a flowed transaction.
     */
    [OperationBehavior(
      TransactionAutoComplete = true,
      TransactionScopeRequired = true
    )]
    [TransactionFlow(TransactionFlowOption.Mandatory)]
    public string TxWork(string message)
    {
      // Do some transactable work.
      Console.WriteLine("TxWork called with: " + message);
      // Display transaction information.

      TransactionInformation info = Transaction.Current.TransactionInformation;
      Console.WriteLine("The distributed tx ID: {0}.", info.DistributedIdentifier);
      Console.WriteLine("The tx status: {0}.", info.Status);
      return String.Format("Hello. This was object {0}.",myID.ToString()) ;
    }

    public void Dispose()
    {
      Console.WriteLine(
        "Service "
        + myID.ToString()
        + " is being recycled."
      );
    }
  }
}

Imports System.ServiceModel
Imports System.Transactions

Namespace Microsoft.WCF.Documentation
  <ServiceContract(Namespace:="http://microsoft.wcf.documentation", SessionMode:=SessionMode.Required)> _
  Public Interface IBehaviorService
    <OperationContract> _
    Function TxWork(ByVal message As String) As String
  End Interface

  ' Note: To use the TransactionIsolationLevel property, you 
  ' must add a reference to the System.Transactions.dll assembly.
'   The following service implementation:
'   *   -- Processes messages on one thread at a time
'   *   -- Creates one service object per session
'   *   -- Releases the service object when the transaction commits
'   
    <ServiceBehavior(ConcurrencyMode:=ConcurrencyMode.Single, InstanceContextMode:=InstanceContextMode.PerSession, _
                     ReleaseServiceInstanceOnTransactionComplete:=True)> _
    Public Class BehaviorService
        Implements IBehaviorService, IDisposable
        Private myID As Guid

        Public Sub New()
            myID = Guid.NewGuid()
            Console.WriteLine("Object " & myID.ToString() & " created.")
        End Sub

        '    
        '     * The following operation-level behaviors are specified:
        '     *   -- The executing transaction is committed when
        '     *        the operation completes without an 
        '     *        unhandled exception
        '     *   -- Always executes under a flowed transaction.
        '     
        <OperationBehavior(TransactionAutoComplete:=True, TransactionScopeRequired:=True), TransactionFlow(TransactionFlowOption.Mandatory)> _
        Public Function TxWork(ByVal message As String) As String Implements IBehaviorService.TxWork
            ' Do some transactable work.
            Console.WriteLine("TxWork called with: " & message)
            ' Display transaction information.

            Dim info As TransactionInformation = Transaction.Current.TransactionInformation
            Console.WriteLine("The distributed tx ID: {0}.", info.DistributedIdentifier)
            Console.WriteLine("The tx status: {0}.", info.Status)
            Return String.Format("Hello. This was object {0}.", myID.ToString())
        End Function

        Public Sub Dispose() Implements IDisposable.Dispose
            Console.WriteLine("Service " & myID.ToString() & " is being recycled.")
        End Sub
    End Class
End Namespace

De onderliggende binding moet stroomtransacties ondersteunen voor het volgende codevoorbeeld om correct te kunnen worden uitgevoerd. Als u stroomtransacties wilt ondersteunen met behulp van bijvoorbeeld de WSHttpBindingTransactionFlow eigenschap true in code of in een toepassingsconfiguratiebestand. In het volgende codevoorbeeld ziet u het configuratiebestand voor het voorgaande voorbeeld.

<configuration>
  <system.serviceModel>
    <services>
      <service  
        name="Microsoft.WCF.Documentation.BehaviorService" 
        behaviorConfiguration="metadataAndDebugEnabled"
      >
        <host>
          <baseAddresses>
            <add baseAddress="http://localhost:8080/SampleService"/>
          </baseAddresses>
        </host>
        <!--
          Note:
            This example code uses the WSHttpBinding to support transactions using the 
            WS-AtomicTransactions (WS-AT) protocol. WSHttpBinding is configured to use the  
            protocol, but the protocol is not enabled on some computers. Use the xws_reg -wsat+ 
            command to enable the WS-AtomicTransactions protocol in the MSDTC service.          
          -->
        <endpoint 
           contract="Microsoft.WCF.Documentation.IBehaviorService"
           binding="wsHttpBinding"
           bindingConfiguration="wsHttpBindingWithTXFlow"
           address="http://localhost:8080/BehaviorService"
          />
        <endpoint 
           contract="Microsoft.WCF.Documentation.IBehaviorService"
           binding="netTcpBinding"
           bindingConfiguration="netTcpBindingWithTXFlow"
           address="net.tcp://localhost:8081/BehaviorService"
          />
        <endpoint
          address="mex"
          binding="mexHttpBinding"
          contract="IMetadataExchange"
        />
      </service>
    </services>
    <behaviors>
      <serviceBehaviors>
        <behavior name="metadataAndDebugEnabled">
          <serviceDebug
            includeExceptionDetailInFaults="true"
          />
          <serviceMetadata
            httpGetEnabled="true"
            httpGetUrl=""
          />
        </behavior>
      </serviceBehaviors>
    </behaviors>
    <!-- binding configuration - configures a WSHttpBinding to require transaction flow -->
    <bindings>
      <wsHttpBinding>
        <binding name="wsHttpBindingWithTXFlow" transactionFlow="true" />
      </wsHttpBinding>
      <netTcpBinding>
        <binding name="netTcpBindingWithTXFlow" transactionFlow="true" />
      </netTcpBinding>
    </bindings>
  </system.serviceModel>
</configuration>

Opmerkingen

Pas het ServiceBehaviorAttribute kenmerk toe op een service-implementatie om het uitvoeringsgedrag voor de hele service op te geven. (Als u uitvoeringsgedrag op methodeniveau wilt opgeven, gebruikt u het OperationBehaviorAttribute kenmerk.) Dit kenmerk kan alleen worden toegepast op service-implementaties. Zie de service: gedragsvoorbeelden voor werkvoorbeelden.

ServiceBehaviorAttribute eigenschappen zijn een functie voor het programmeermodel van Windows Communication Foundation (WCF) die algemene functies mogelijk maakt die ontwikkelaars anders moeten implementeren. Zie Specifying Service Run-Time Behavior (Service opgeven Run-Time Gedrag) voor meer informatie over deze en andere gedragingen. Zie Uitbreiden van ServiceHost en de servicemodellaag voor meer informatie over de onderliggende runtime-eigenschappen die sommige van de volgende eigenschappen zijn ingesteld.

• De AddressFilterMode eigenschap geeft het type filter op dat het dispatchersysteem gebruikt om het eindpunt te vinden dat aanvragen verwerkt.

• De AutomaticSessionShutdown eigenschap sluit de sessie automatisch wanneer het kanaal wordt gesloten en de service klaar is met het verwerken van alle resterende berichten.

• De ConcurrencyMode eigenschap bepaalt het interne threadingmodel, waardoor ondersteuning wordt ingeschakeld voor reentrant- of multithreaded services.

• De ConfigurationName eigenschap wordt gebruikt om een naam te declareren voor gebruik in het name kenmerk van het <service> element in een configuratiebestand.

• Met IgnoreExtensionDataObject de eigenschap kan de uitvoeringstijd extra serialisatie-informatie negeren die niet vereist is om het bericht te verwerken.

• De IncludeExceptionDetailInFaults eigenschap geeft aan of niet-verwerkte uitzonderingen in een service worden geretourneerd als SOAP-fouten. Dit is alleen voor foutopsporingsdoeleinden.

• De InstanceContextMode eigenschap geeft aan of en wanneer services en hun serviceobjecten moeten worden gerecycled tijdens een uitwisseling met een klant.

• De MaxItemsInObjectGraph eigenschap die moet worden beperkt voor het aantal items in een objectgrafiek dat wordt geserialiseerd.

• De Name en Namespace eigenschappen bepalen de naam en naamruimte voor de WSDL-expressie van het service-element.

• De ReleaseServiceInstanceOnTransactionComplete eigenschap geeft aan of het serviceobject wordt gerecycled wanneer een transactie is voltooid.

• De TransactionAutoCompleteOnSessionClose eigenschap geeft aan of openstaande transacties worden voltooid wanneer de sessie wordt gesloten.

• De TransactionIsolationLevel eigenschap geeft het isolatieniveau voor transacties op dat door het contract wordt ondersteund.

• De TransactionTimeout eigenschap geeft de periode aan waarin een transactie moet worden voltooid of wordt afgebroken.

• De UseSynchronizationContext eigenschap geeft aan of binnenkomende methodeaanroepen automatisch moeten worden gesynchroniseerd met de thread van de gebruikersinterface.

• De ValidateMustUnderstand eigenschap informeert het systeem of het moet bevestigen dat SOAP-headers die zijn gemarkeerd als MustUnderstand die in feite zijn begrepen.

De IncludeExceptionDetailInFaults eigenschap kan ook worden ingesteld met behulp van een toepassingsconfiguratiebestand. Zie IncludeExceptionDetailInFaultsvoor meer informatie.

Zie ook

• OperationBehaviorAttribute
• Service: Voorbeeld van gedrag