IContractBehavior IContractBehavior IContractBehavior IContractBehavior Interface

Определение

Реализует методы, которые могут использоваться для расширения поведения времени выполнения для контракта приложения службы или клиентского приложения.Implements methods that can be used to extend run-time behavior for a contract in either a service or client application.

public interface class IContractBehavior
public interface IContractBehavior
type IContractBehavior = interface
Public Interface IContractBehavior
Производный

Примеры

В следующем примере кода предполагается наличие пользовательской реализации IInstanceProvider с именем ObjectProviderBehavior, которая обеспечивает «одноэлементное» поведение; метод всегда возвращает один и тот же экземпляр службы и не использует его повторно.The following code example assumes a custom IInstanceProvider implementation called ObjectProviderBehavior that provides a "singleton" behavior; it always returns the same service instance and does not recycle it.

Чтобы вставить настройку поставщика экземпляров, в этом примере показано, как реализовать пользовательский атрибут (SingletonBehaviorAttribute), который реализует IContractBehavior для вставки пользовательского поставщика экземпляров службы.To insert the instance provider customization, the example shows how to implement a custom attribute (SingletonBehaviorAttribute) that implements IContractBehavior to insert the custom service instance provider. В нем также реализуется интерфейс IContractBehaviorAttribute, который связывает его использование с контрактом ISampleService.It also implements IContractBehaviorAttribute, which binds its use to the ISampleService contract.

public class SingletonBehaviorAttribute : Attribute, IContractBehaviorAttribute, IContractBehavior
{

  #region IContractBehaviorAttribute Members

  public Type TargetContract
  {
    get { return typeof(ISampleService); }
  }

  #endregion

  #region IContractBehavior Members

  public void AddBindingParameters(ContractDescription description, ServiceEndpoint endpoint, System.ServiceModel.Channels.BindingParameterCollection parameters)
  {
    return;
  }

  public void ApplyClientBehavior(ContractDescription description, ServiceEndpoint endpoint, ClientRuntime clientRuntime)
  {
    return;
  }

  public void ApplyDispatchBehavior(ContractDescription description, ServiceEndpoint endpoint, DispatchRuntime dispatch)
  {
    dispatch.InstanceProvider = new ObjectProviderBehavior("Custom ObjectProviderBehavior constructor.");
  }

  public void Validate(ContractDescription description, ServiceEndpoint endpoint)
  {
    return;
  }

  #endregion
}
Public Class SingletonBehaviorAttribute
    Inherits Attribute
    Implements IContractBehaviorAttribute, IContractBehavior

  #Region "IContractBehaviorAttribute Members"

  Public ReadOnly Property TargetContract() As Type Implements IContractBehaviorAttribute.TargetContract
    Get
        Return GetType(ISampleService)
    End Get
  End Property

  #End Region

  #Region "IContractBehavior Members"

  Public Sub AddBindingParameters(ByVal description As ContractDescription, ByVal endpoint As ServiceEndpoint, ByVal parameters As System.ServiceModel.Channels.BindingParameterCollection) Implements IContractBehavior.AddBindingParameters
    Return
  End Sub

  Public Sub ApplyClientBehavior(ByVal description As ContractDescription, ByVal endpoint As ServiceEndpoint, ByVal clientRuntime As ClientRuntime) Implements IContractBehavior.ApplyClientBehavior
    Return
  End Sub

  Public Sub ApplyDispatchBehavior(ByVal description As ContractDescription, ByVal endpoint As ServiceEndpoint, ByVal dispatch As DispatchRuntime) Implements IContractBehavior.ApplyDispatchBehavior
    dispatch.InstanceProvider = New ObjectProviderBehavior("Custom ObjectProviderBehavior constructor.")
  End Sub

  Public Sub Validate(ByVal description As ContractDescription, ByVal endpoint As ServiceEndpoint) Implements IContractBehavior.Validate
    Return
  End Sub

  #End Region
End Class

Комментарии

Реализует интерфейс IContractBehavior для изменения, проверки или расширения некоторых аспектов выполнения для всего контракта на уровне приложения.Implement the IContractBehavior interface to modify, examine, or extend some aspect of contract-wide execution at the application level. В отличие от объектов IServiceBehavior и IEndpointBehavior, объекты IContractBehavior не могут добавляться в среду выполнения с помощью файла конфигурации приложения; они могут добавляться только программным способом или с использованием атрибута.Unlike IServiceBehavior and IEndpointBehavior objects, IContractBehavior objects cannot be added to the runtime using an application configuration file; they can only be added programmatically or using an attribute.

Дополнительные сведения о выборе между службами, конечной точкой и поведением контрактов см. в разделе Настройка и расширение среды выполнения с помощью поведений.For more information about choosing between service, endpoint, and contract behaviors, see Configuring and Extending the Runtime with Behaviors.

  • Метод AddBindingParameters используется для предоставления элементов привязки с пользовательскими данными для поддержки поведения.Use the AddBindingParameters method to provide binding elements with custom data to support the behavior.

  • Метод ApplyClientBehavior используется для изменения, проверки или вставки расширений в контракт в клиентском приложении.Use the ApplyClientBehavior method to modify, examine, or insert extensions to a contract in a client application.

  • Метод ApplyDispatchBehavior используется для изменения, проверки или вставки расширений в контракт в приложении службы.Use the ApplyDispatchBehavior method to modify, examine, or insert extensions to a contract in a service application.

  • Метод Validate используется для обеспечения поддержки определенных возможностей контрактом.Use the Validate method to ensure that a contract can support a particular feature.

Объекты IContractBehavior могут использовать любые из этих методов, но часто важен только один; в таких случаях неиспользуемые методы могут не возвращать какого-либо значения.IContractBehavior objects can make use of any of these methods, but often only one is important; in such cases, the unused methods can return without any value.

Примечание

Все методы IContractBehavior в качестве параметров передают System.ServiceModel.Description.ContractDescription и System.ServiceModel.Description.ServiceEndpoint.All of the IContractBehavior methods pass System.ServiceModel.Description.ContractDescription and System.ServiceModel.Description.ServiceEndpoint as parameters. Эти параметры нужны для проверки; если производится изменение объектов, поведение выполнения является неопределенным.These parameters are for examination; if you modify the objects the execution behavior is undefined.

Типы IContractBehavior могут использоваться в службе или в клиенте, либо в них обоих.IContractBehavior types can be used on either the service or the client, or both. Чтобы выполнить задачу настройки для службы, объект IContractBehavior должен быть добавлен к свойству Behaviors до построения среды выполнения службы, которое происходит, когда вызывается метод ICommunicationObject.Open в объекте System.ServiceModel.ServiceHost.To perform a customization task on the service, the IContractBehavior object must be added to the Behaviors property prior to the construction of the service runtime, which occurs when the ICommunicationObject.Open method is called on the System.ServiceModel.ServiceHost object. Это можно сделать двумя способами.There are two ways to do this.

Первым способом является программное добавление пользовательского поведения контракта в свойство Behaviors перед вызовом метода ICommunicationObject.Open в объекте System.ServiceModel.ServiceHost.The first method is to programmatically add the custom contract behavior to the Behaviors property prior to the point when the ICommunicationObject.Open method is called on the System.ServiceModel.ServiceHost object. В этом случае поведение применяется для всех сообщений, проходящих по этому контракту в любой конечной точке.When applied this way, the behavior is applied for all messages flowing through that contract on any endpoint.

Примечание

Поведение применяется ко всем контрактам одинакового типа.The behavior is applied to all contracts of the same type. Например, если программно добавить один тип контракта к нескольким конечным точкам, поведение изменит все конечные точки, относящиеся к одному объекту контракта.For example, if you programmatically add the same contract type to more than one endpoint, the behavior modifies all endpoints that refer to the same contract object.

Вторым методом является создание пользовательского атрибута, который реализует IContractBehavior, и применение его к следующим объектам:The second method is to create a custom attribute that implements IContractBehavior and apply that to:

  • Интерфейс контракта.A contract interface. В этом случае поведение применяется ко всем контрактам этого типа в любой конечной точке.In this case, the behavior is applied to all contracts of that type in any endpoint.

  • Класс службы.A service class. В этом случае поведение применяется ко всем конечным точкам, независимо от контракта.In this case, the behavior is applied to all endpoints regardless of contract.

  • Класс обратного вызова.A callback class. В этом случае поведение применяется к конечной точке дуплексного клиента.In this case, the behavior is applied to the duplex client's endpoint.

Поведение во втором подходе немного отличается, если пользовательский атрибут также реализует System.ServiceModel.Description.IContractBehaviorAttribute.The behavior of the second approach varies slightly if the custom attribute also implements System.ServiceModel.Description.IContractBehaviorAttribute. В этом случае поведение выглядит следующим образом.In this case, the behavior is as follows:

  • Интерфейс контракта.A contract interface. В этом случае поведение применяется ко всем контрактам этого типа в любой конечной точке, а Windows Communication Foundation (WCF) игнорирует значение свойства IContractBehaviorAttribute.TargetContract.In this case, the behavior is applied to all contracts of that type in any endpoint and Windows Communication Foundation (WCF) ignores the value of the IContractBehaviorAttribute.TargetContract property.

  • Класс службы.A service class. В этом случае поведение применяется только к конечным точкам, контракт которых имеет значение, равное значению свойства IContractBehaviorAttribute.TargetContract.In this case, the behavior is applied only to endpoints the contract of which is the value of the IContractBehaviorAttribute.TargetContract property.

  • Класс обратного вызова.A callback class. В этом случае поведение применяется к конечной точке дуплексного клиента, а WCF игнорирует значение свойства IContractBehaviorAttribute.TargetContract.In this case, the behavior is applied to the duplex client's endpoint and WCF ignores the value of the IContractBehaviorAttribute.TargetContract property.

Чтобы выполнить задачу настройки на клиенте, для которого она предназначена, объект IContractBehavior должен быть добавлен к свойству Behaviors до построения клиентской среды выполнения, которое происходит при вызове ChannelFactory<TChannel>.CreateChannel.To perform the customization task on the client for which it is intended, the IContractBehavior object must be added to the Behaviors property prior to the construction of the client runtime, which occurs when ChannelFactory<TChannel>.CreateChannel is called. Это можно сделать двумя способами.There are two ways to do this:

Дополнительные сведения о программном добавлении типов IContractBehavior в клиент или приложение службы см. в разделе Настройка и расширение среды выполнения с помощью поведений.For more information on programmatically adding IContractBehavior types to either the client or service application, see Configuring and Extending the Runtime with Behaviors.

Методы

AddBindingParameters(ContractDescription, ServiceEndpoint, BindingParameterCollection) AddBindingParameters(ContractDescription, ServiceEndpoint, BindingParameterCollection) AddBindingParameters(ContractDescription, ServiceEndpoint, BindingParameterCollection) AddBindingParameters(ContractDescription, ServiceEndpoint, BindingParameterCollection)

Настраивает элементы привязки для поддержки поведения контракта.Configures any binding elements to support the contract behavior.

ApplyClientBehavior(ContractDescription, ServiceEndpoint, ClientRuntime) ApplyClientBehavior(ContractDescription, ServiceEndpoint, ClientRuntime) ApplyClientBehavior(ContractDescription, ServiceEndpoint, ClientRuntime) ApplyClientBehavior(ContractDescription, ServiceEndpoint, ClientRuntime)

Реализует изменение или расширение клиента для всего контракта.Implements a modification or extension of the client across a contract.

ApplyDispatchBehavior(ContractDescription, ServiceEndpoint, DispatchRuntime) ApplyDispatchBehavior(ContractDescription, ServiceEndpoint, DispatchRuntime) ApplyDispatchBehavior(ContractDescription, ServiceEndpoint, DispatchRuntime) ApplyDispatchBehavior(ContractDescription, ServiceEndpoint, DispatchRuntime)

Реализует изменение или расширение клиента для всего контракта.Implements a modification or extension of the client across a contract.

Validate(ContractDescription, ServiceEndpoint) Validate(ContractDescription, ServiceEndpoint) Validate(ContractDescription, ServiceEndpoint) Validate(ContractDescription, ServiceEndpoint)

Реализуется для подтверждения того, что контракт и конечная точка могут поддерживать поведение контракта.Implement to confirm that the contract and endpoint can support the contract behavior.

Применяется к