IContractBehavior Интерфейс

  • Ссылка

Определение

Пространство имен:
System.ServiceModel.Description
Сборка:
System.ServiceModel.Primitives.dll
Сборка:
System.ServiceModel.dll

Реализует методы, которые могут использоваться для расширения поведения времени выполнения для контракта приложения службы или клиентского приложения.

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

Примеры

В следующем примере кода предполагается наличие пользовательской реализации IInstanceProvider с именем ObjectProviderBehavior, которая обеспечивает «одноэлементное» поведение; метод всегда возвращает один и тот же экземпляр службы и не использует его повторно.

Чтобы вставить настройку поставщика экземпляров, в этом примере показано, как реализовать пользовательский атрибут (SingletonBehaviorAttribute), который реализует IContractBehavior для вставки пользовательского поставщика экземпляров службы. В нем также реализуется интерфейс IContractBehaviorAttribute, который связывает его использование с контрактом ISampleService.

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 для изменения, проверки или расширения некоторых аспектов выполнения для всего контракта на уровне приложения. В отличие от объектов IServiceBehavior и IEndpointBehavior, объекты IContractBehavior не могут добавляться в среду выполнения с помощью файла конфигурации приложения; они могут добавляться только программным способом или с использованием атрибута.

Дополнительные сведения о выборе между поведением службы, конечной точки и контракта см. в разделе "Настройка и расширение среды выполнения с помощью поведения".

  • Метод AddBindingParameters используется для предоставления элементов привязки с пользовательскими данными для поддержки поведения.

  • Метод ApplyClientBehavior используется для изменения, проверки или вставки расширений в контракт в клиентском приложении.

  • Метод ApplyDispatchBehavior используется для изменения, проверки или вставки расширений в контракт в приложении службы.

  • Метод Validate используется для обеспечения поддержки определенных возможностей контрактом.

Объекты IContractBehavior могут использовать любые из этих методов, но часто важен только один; в таких случаях неиспользуемые методы могут не возвращать какого-либо значения.

Примечание

Все методы IContractBehavior в качестве параметров передают System.ServiceModel.Description.ContractDescription и System.ServiceModel.Description.ServiceEndpoint. Эти параметры нужны для проверки; если производится изменение объектов, поведение выполнения является неопределенным.

IContractBehavior типы можно использовать либо в службе, либо в клиенте, либо в обоих типах. Чтобы выполнить задачу настройки для службы, объект IContractBehavior должен быть добавлен к свойству Behaviors до построения среды выполнения службы, которое происходит, когда вызывается метод ICommunicationObject.Open в объекте System.ServiceModel.ServiceHost. Это можно сделать двумя способами.

Первым способом является программное добавление пользовательского поведения контракта в свойство Behaviors перед вызовом метода ICommunicationObject.Open в объекте System.ServiceModel.ServiceHost. В этом случае поведение применяется для всех сообщений, проходящих по этому контракту в любой конечной точке.

Примечание

Поведение применяется ко всем контрактам одинакового типа. Например, если программно добавить один тип контракта к нескольким конечным точкам, поведение изменит все конечные точки, относящиеся к одному объекту контракта.

Вторым методом является создание пользовательского атрибута, который реализует IContractBehavior, и применение его к следующим объектам:

  • Интерфейс контракта. В этом случае поведение применяется ко всем контрактам этого типа в любой конечной точке.

  • Класс службы. В этом случае поведение применяется ко всем конечным точкам, независимо от контракта.

  • Класс обратного вызова. В этом случае поведение применяется к конечной точке дуплексного клиента.

Поведение во втором подходе немного отличается, если пользовательский атрибут также реализует System.ServiceModel.Description.IContractBehaviorAttribute. В этом случае поведение выглядит следующим образом.

  • Интерфейс контракта. В этом случае поведение применяется ко всем контрактам этого типа в любой конечной точке и Windows Communication Foundation (WCF) игнорирует значение IContractBehaviorAttribute.TargetContract свойства.

  • Класс службы. В этом случае поведение применяется только к конечным точкам, контракт которых имеет значение, равное значению свойства IContractBehaviorAttribute.TargetContract.

  • Класс обратного вызова. В этом случае поведение применяется к конечной точке дуплексного клиента, и WCF игнорирует значение IContractBehaviorAttribute.TargetContract свойства.

Чтобы выполнить задачу настройки на клиенте, для которого она предназначена, объект IContractBehavior должен быть добавлен к свойству Behaviors до построения клиентской среды выполнения, которое происходит при вызове ChannelFactory<TChannel>.CreateChannel. Это можно сделать двумя способами.

  • Программным способом добавить пользовательское поведение контракта в свойство Behaviors до вызова ChannelFactory<TChannel>.CreateChannel.

  • Создать пользовательский атрибут, который также реализует IContractBehavior.

Дополнительные сведения о программном добавлении IContractBehavior типов в клиентское или служебное приложение см. в разделе "Настройка и расширение среды выполнения с помощью поведения".

Методы

AddBindingParameters(ContractDescription, ServiceEndpoint, BindingParameterCollection)

Настраивает элементы привязки для поддержки поведения контракта.
ApplyClientBehavior(ContractDescription, ServiceEndpoint, ClientRuntime)

Реализует изменение или расширение клиента для всего контракта.
ApplyDispatchBehavior(ContractDescription, ServiceEndpoint, DispatchRuntime)

Реализует изменение или расширение клиента для всего контракта.
Validate(ContractDescription, ServiceEndpoint)

Реализуется для подтверждения того, что контракт и конечная точка могут поддерживать поведение контракта.

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