IContractBehavior 接口
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
实现可用于在服务或客户端应用程序中扩展协定的运行时行为的方法。
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
}
注解
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) |
实现以确认协定和终结点可以支持协定行为。 |