ServiceBehaviorAttribute Classe

Définition

Spécifie le comportement d'exécution interne d'une implémentation de contrat de service.Specifies the internal execution behavior of a service contract implementation.

public ref class ServiceBehaviorAttribute sealed : Attribute, System::ServiceModel::Description::IServiceBehavior
[System.AttributeUsage(System.AttributeTargets.Class)]
public sealed class ServiceBehaviorAttribute : Attribute, System.ServiceModel.Description.IServiceBehavior
type ServiceBehaviorAttribute = class
    inherit Attribute
    interface IServiceBehavior
Public NotInheritable Class ServiceBehaviorAttribute
Inherits Attribute
Implements IServiceBehavior
Héritage
ServiceBehaviorAttribute
Attributs
Implémente

Exemples

L'exemple de code suivant illustre les propriétés ServiceBehaviorAttribute.The following code example demonstrates the ServiceBehaviorAttribute properties. La classe BehaviorService utilise l'attribut ServiceBehaviorAttribute pour indiquer que :The BehaviorService class uses the ServiceBehaviorAttribute attribute to indicate that:

  • L'objet du service est recyclé au terme de la transaction.The service object is recycled when the transaction completes.

  • Il existe un objet du service pour chaque session.There is one service object for each session.

  • Le service est monothread et ne prend pas en charge les appels réentrants.The service is single-threaded and does not support reentrant calls.

En outre, au niveau de l’opération, les valeurs OperationBehaviorAttribute indiquent que la méthode TxWork s’inscrit automatiquement dans les transactions passées ou crée une transaction pour faire le travail, et que la transaction est validée automatiquement si aucune exception non gérée ne se produit.Furthermore, at the operation level, the OperationBehaviorAttribute values indicate that the TxWork method automatically enlists in flowed transactions or creates a new transaction to do the work, and that the transaction is committed automatically if an unhandled exception does not occur.

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

La liaison sous-jacente doit prendre en charge les transactions passées pour l’exemple de code suivant pour s’exécuter correctement.The underlying binding must support flowed transactions for the following code example to execute properly. Pour prendre en charge les transactions passées à l’aide de WSHttpBinding, par exemple, affectez la valeur TransactionFlow à la propriété true dans le code ou dans un fichier de configuration de l’application.To support flowed transactions using the WSHttpBinding, for example, set the TransactionFlow property to true in code or in an application configuration file. L'exemple de code suivant montre le fichier de configuration pour l'exemple précédent :The following code example shows the configuration file for the preceding sample.

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

Remarques

Appliquez l'attribut ServiceBehaviorAttribute à une implémentation de service afin de spécifier le comportement d'exécution à l'échelle du service.Apply the ServiceBehaviorAttribute attribute to a service implementation to specify service-wide execution behavior. (Pour spécifier le comportement d'exécution au niveau de la méthode, utilisez l'attribut OperationBehaviorAttribute.) Cet attribut peut uniquement être appliqué à des implémentations de service.(To specify execution behavior at the method level, use the OperationBehaviorAttribute attribute.) This attribute can be applied only to service implementations. Pour obtenir des exemples fonctionnels , consultez le service: Exemplesde comportements.For working examples, see the Service: Behaviors Samples.

ServiceBehaviorAttributeles propriétés sont une fonctionnalité du modèle de programmation Windows Communication Foundation (WCF) qui active les fonctionnalités courantes que les développeurs doivent sinon implémenter.ServiceBehaviorAttribute properties are a Windows Communication Foundation (WCF) programming model feature that enables common features that developers otherwise have to implement. Pour plus d’informations sur ces comportements et d’autres, consultez spécification du comportement du service au moment de l’exécution.For more information about these and other behaviors, see Specifying Service Run-Time Behavior. Pour plus d’informations sur les propriétés d’exécution sous-jacentes définies par certaines des propriétés suivantes, consultez extension de ServiceHost et de la couche de modèle de service.For more information about the underlying runtime properties that some of the following properties set, see Extending ServiceHost and the Service Model Layer.

  • La propriété AddressFilterMode spécifie le type de filtre utilisé par le système de répartiteur pour localiser le point de terminaison qui gère des demandes.The AddressFilterMode property specifies the type of filter that the dispatcher system uses to locate the endpoint that handles requests.

  • La propriété AutomaticSessionShutdown ferme automatiquement la session lorsque le canal est fermé et que le service a fini de traiter les messages restants.The AutomaticSessionShutdown property automatically closes the session when the channel is closed and the service has finished processing any remaining messages.

  • La propriété ConcurrencyMode contrôle le modèle de thread interne et permet ainsi la prise en charge des services réentrants ou multithread.The ConcurrencyMode property controls the internal threading model, enabling support for reentrant or multithreaded services.

  • La propriété ConfigurationName est utilisée pour déclarer un nom en vue de son utilisation dans l'attribut name de l'élément <service> dans un fichier de configuration.The ConfigurationName property is used to declare a name for use in the name attribute of the <service> element in a configuration file.

  • La propriété IgnoreExtensionDataObject permet au temps d'exécution d'ignorer les informations de sérialisation supplémentaires qui ne sont pas requises pour le traitement du message.The IgnoreExtensionDataObject property enables the run time to ignore extra serialization information that is not required to process the message.

  • La propriété IncludeExceptionDetailInFaults détermine si les exceptions non gérées dans un service sont retournées en tant qu'erreurs SOAP.The IncludeExceptionDetailInFaults property specifies whether unhandled exceptions in a service are returned as SOAP faults. Elle est utilisée à des fins de débogage uniquement.This is for debugging purposes only.

  • La propriété InstanceContextMode spécifie si et quand les services et leurs objets du service sont recyclés pendant un échange avec un client.The InstanceContextMode property specifies whether and when services and their service objects are to be recycled during an exchange with a client.

  • La propriété MaxItemsInObjectGraph limite le nombre d'éléments sérialisés dans un graphique d'objets.The MaxItemsInObjectGraph property to limit on the number of items in an object graph that are serialized.

  • Les propriétés Name et Namespace contrôlent le nom et l'espace de noms de l'expression WSDL de l'élément de service.The Name and Namespace properties control the name and namespace for the WSDL expression of the service element.

  • La propriété ReleaseServiceInstanceOnTransactionComplete spécifie si l’objet de service est recyclé au terme de l’exécution d’une transaction.The ReleaseServiceInstanceOnTransactionComplete property specifies whether the service object is recycled when a transaction completes.

  • La propriété TransactionAutoCompleteOnSessionClose spécifie si les transactions en attente sont exécutées lorsque la session se ferme.The TransactionAutoCompleteOnSessionClose property specifies whether outstanding transactions are completed when the session closes.

  • La propriété TransactionIsolationLevel spécifie le niveau d'isolation de la transaction que le contrat prend en charge.The TransactionIsolationLevel property specifies the transaction isolation level that the contract supports.

  • La propriété TransactionTimeout spécifie le délai au cours duquel une transaction doit être exécutée, faute de quoi elle sera abandonnée.The TransactionTimeout property specifies the time period within which a transaction must complete or it aborts.

  • La propriété UseSynchronizationContext spécifie si les appels de méthode entrants doivent être automatiquement synchronisés avec le thread d'interface utilisateur.The UseSynchronizationContext property indicates whether to synchronize inbound method calls with the user interface thread automatically.

  • La propriété ValidateMustUnderstand informe le système s'il doit confirmer que les en-têtes SOAP marqués comme MustUnderstand ont effectivement été compris.The ValidateMustUnderstand property informs the system whether it should confirm that SOAP headers marked as MustUnderstand have, in fact, been understood.

La propriété IncludeExceptionDetailInFaults peut également être définie à l'aide d'un fichier de configuration de l'application.The IncludeExceptionDetailInFaults property can also be set using an application configuration file. Pour plus d'informations, consultez IncludeExceptionDetailInFaults.For details, see IncludeExceptionDetailInFaults.

Constructeurs

ServiceBehaviorAttribute()

Initialise une nouvelle instance de la classe ServiceBehaviorAttribute.Initializes a new instance of the ServiceBehaviorAttribute class.

Propriétés

AddressFilterMode

Obtient ou définit la propriété AddressFilterMode utilisée par le répartiteur afin de router les messages entrants vers le point de terminaison correct.Gets or sets the AddressFilterMode that is used by the dispatcher to route incoming messages to the correct endpoint.

AutomaticSessionShutdown

Spécifie si une session doit être fermée automatiquement lorsqu'un client ferme une session de sortie.Specifies whether to automatically close a session when a client closes an output session.

ConcurrencyMode

Obtient ou définit si un service prend en charge un thread, plusieurs threads ou des appels réentrants.Gets or sets whether a service supports one thread, multiple threads, or reentrant calls.

ConfigurationName

Obtient ou définit la valeur utilisée pour localiser l'élément de service dans un fichier de configuration de l'application.Gets or sets the value used to locate the service element in an application configuration file.

EnsureOrderedDispatch

Obtient ou définit une valeur qui indique si la distribution classée par service est garantie.Gets or sets a value that indicates whether the service ordered dispatch is ensured.

IgnoreExtensionDataObject

Obtient ou définit une valeur indiquant si des données de sérialisation inconnues doivent être envoyées sur le réseau.Gets or sets a value that specifies whether to send unknown serialization data onto the wire.

IncludeExceptionDetailInFaults

Obtient ou définit une valeur qui indique que les exceptions d'exécution générales non prises en charge doivent être converties en FaultException<TDetail> de type ExceptionDetail et envoyées en tant que message d'erreur.Gets or sets a value that specifies that general unhandled execution exceptions are to be converted into a FaultException<TDetail> of type ExceptionDetail and sent as a fault message. Affectez la valeur true uniquement lors du développement afin de dépanner un service.Set this to true only during development to troubleshoot a service.

InstanceContextMode

Obtient ou définit la valeur qui indique à quel moment de nouveaux objets de service sont créés.Gets or sets the value that indicates when new service objects are created.

MaxItemsInObjectGraph

Obtient ou définit le nombre maximal d'éléments autorisés dans un objet sérialisé.Gets or sets the maximum number of items allowed in a serialized object.

Name

Obtient ou définit la valeur de l'attribut du nom correspondant à l'élément de service dans l'outil relatif au langage descriptif de services Web (WSDL, Web Services Description Language).Gets or sets the value of the name attribute in the service element in Web Services Description Language (WSDL).

Namespace

Obtient ou définit la valeur de l'espace de noms cible correspondant au service dans WSDL (Web Services Description Language).Gets or sets the value of the target namespace for the service in Web Services Description Language (WSDL).

ReleaseServiceInstanceOnTransactionComplete

Obtient ou définit une valeur qui spécifie si l’objet du service est libéré au terme de la transaction actuelle.Gets or sets a value that specifies whether the service object is released when the current transaction completes.

TransactionAutoCompleteOnSessionClose

Obtient ou définit une valeur qui spécifie si les transactions en attente sont exécutées lorsque la session active se ferme sans erreur.Gets or sets a value that specifies whether pending transactions are completed when the current session closes without error.

TransactionIsolationLevel

Spécifie le niveau d’isolation des nouvelles transactions créées à l’intérieur du service et des transactions entrantes transmises à partir d’un client.Specifies the transaction isolation level for new transactions created inside the service, and incoming transactions flowed from a client.

TransactionTimeout

Obtient ou définit la période au cours de laquelle une transaction doit se terminer.Gets or sets the period within which a transaction must complete.

TypeId

Lors de l'implémentation dans une classe dérivée, obtient un identificateur unique pour l'objet Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Hérité de Attribute)
UseSynchronizationContext

Obtient ou définit une valeur qui spécifie si le contexte de synchronisation actuel doit être utilisé pour sélectionner le thread d’exécution.Gets or sets a value that specifies whether to use the current synchronization context to choose the thread of execution.

ValidateMustUnderstand

Obtient ou définit une valeur qui spécifie si le système ou l'application applique le traitement d'en-tête MustUnderstand SOAP.Gets or sets a value that specifies whether the system or the application enforces SOAP MustUnderstand header processing.

Méthodes

Equals(Object)

Retourne une valeur qui indique si cette instance est égale à un objet spécifié.Returns a value that indicates whether this instance is equal to a specified object.

(Hérité de Attribute)
GetHashCode()

Retourne le code de hachage de cette instance.Returns the hash code for this instance.

(Hérité de Attribute)
GetType()

Obtient le Type de l'instance actuelle.Gets the Type of the current instance.

(Hérité de Object)
GetWellKnownSingleton()

Récupère un objet qui implémente le service et qui est utilisé comme instance singleton du service, ou null s'il n'existe aucune instance de singleton.Retrieves an object that implements the service and that is used as the singleton instance of the service, or null if there is no singleton instance.

IsDefaultAttribute()

En cas de substitution dans une classe dérivée, indique si la valeur de cette instance est la valeur par défaut pour la classe dérivée.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Hérité de Attribute)
Match(Object)

En cas de substitution dans une classe dérivée, retourne une valeur indiquant si cette instance équivaut à un objet spécifié.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Hérité de Attribute)
MemberwiseClone()

Crée une copie superficielle du Object actuel.Creates a shallow copy of the current Object.

(Hérité de Object)
SetWellKnownSingleton(Object)

Spécifie un objet qui implémente le service et qui est utilisé comme instance singleton du service.Specifies an object that implements the service and that is used as the singleton instance of the service.

ShouldSerializeConfigurationName()

Retourne une valeur qui indique si la propriété ConfigurationName utilise une autre valeur que sa valeur par défaut et doit être sérialisée.Returns a value that indicates whether the ConfigurationName property has changed from its default value and should be serialized.

ShouldSerializeReleaseServiceInstanceOnTransactionComplete()

Retourne une valeur qui indique si la propriété ReleaseServiceInstanceOnTransactionComplete utilise une autre valeur que sa valeur par défaut et doit être sérialisée.Returns a value that indicates whether the ReleaseServiceInstanceOnTransactionComplete property has changed from its default value and should be serialized.

ShouldSerializeTransactionAutoCompleteOnSessionClose()

Retourne une valeur qui indique si la propriété TransactionAutoCompleteOnSessionClose utilise une autre valeur que sa valeur par défaut et doit être sérialisée.Returns a value that indicates whether the TransactionAutoCompleteOnSessionClose property has changed from its default value and should be serialized.

ShouldSerializeTransactionIsolationLevel()

Retourne une valeur qui indique si la propriété TransactionIsolationLevel utilise une autre valeur que sa valeur par défaut et doit être sérialisée.Returns a value that indicates whether the TransactionIsolationLevel property has changed from its default value and should be serialized.

ShouldSerializeTransactionTimeout()

Retourne une valeur qui indique si la propriété TransactionTimeout utilise une autre valeur que sa valeur par défaut et doit être sérialisée.Returns a value that indicates whether the TransactionTimeout property has changed from its default value and should be serialized.

ToString()

Retourne une chaîne qui représente l'objet en cours.Returns a string that represents the current object.

(Hérité de Object)

Implémentations d’interfaces explicites

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Mappe un jeu de noms avec un jeu correspondant d'identificateurs de dispatch.Maps a set of names to a corresponding set of dispatch identifiers.

(Hérité de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Récupère les informations de type pour un objet, qui peuvent être utilisées pour obtenir les informations de type d'une interface.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Hérité de Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Récupère le nombre d'interfaces d'informations de type fourni par un objet (0 ou 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Hérité de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Fournit l'accès aux propriétés et aux méthodes exposées par un objet.Provides access to properties and methods exposed by an object.

(Hérité de Attribute)
IServiceBehavior.AddBindingParameters(ServiceDescription, ServiceHostBase, Collection<ServiceEndpoint>, BindingParameterCollection)

Passe des objets de données personnalisés aux liaisons qui prennent en charge les propriétés de comportement.Passes custom data objects to the bindings that support the behavior properties.

IServiceBehavior.ApplyDispatchBehavior(ServiceDescription, ServiceHostBase)

Personnalise le moment d'exécution du service afin de prendre en charge les propriétés de comportement.Customizes the service run time to support the behavior properties.

IServiceBehavior.Validate(ServiceDescription, ServiceHostBase)

Vérifie que la description du service et l'hôte du service sont capables de prendre en charge le comportement.Confirms that the service description and service host are capable of supporting the behavior.

S’applique à

Voir aussi