IContractBehavior Интерфейс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Реализует методы, которые можно использовать для расширения поведения во время выполнения для контракта в службе или клиентском приложении.
public interface class IContractBehavior
public interface IContractBehavior
type IContractBehavior = interface
Public Interface IContractBehavior
- Производный
Примеры
В следующем примере кода предполагается пользовательская IInstanceProvider реализация ObjectProviderBehavior , которая обеспечивает поведение singleton; оно всегда возвращает один экземпляр службы и не перезапускает его.
Чтобы вставить настройку поставщика экземпляров, в примере показано, как реализовать настраиваемый атрибут (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) |
Реализуйте, чтобы убедиться, что контракт и конечная точка могут поддерживать поведение контракта. |