IEndpointBehavior 接口

  • 参考

定义

命名空间:
System.ServiceModel.Description
程序集:
System.ServiceModel.Primitives.dll
程序集:
System.ServiceModel.dll
程序集:
System.Private.ServiceModel.dll
包:
System.ServiceModel.Primitives v8.0.0
包:
System.Private.ServiceModel v4.10.3
Source:
IEndpointBehavior.cs
Source:
IEndpointBehavior.cs
Source:
IEndpointBehavior.cs

实现可用于扩展服务或客户端应用程序中的终结点的运行时行为的方法。

public interface class IEndpointBehavior
public interface IEndpointBehavior
type IEndpointBehavior = interface
Public Interface IEndpointBehavior
派生

示例

下面的代码示例演示了在服务应用程序中添加 System.ServiceModel.Dispatcher.IDispatchMessageInspector 对象的终结点行为的实现。 在此情况下，EndpointBehaviorMessageInspector 类将通过使用应用程序配置文件，实现 System.ServiceModel.Dispatcher.IDispatchMessageInspector 以检查入站和出站消息，实现 IEndpointBehavior 接口以将检查器类插入该行为应用到的所有终结点的检查系统，以及实现 System.ServiceModel.Configuration.BehaviorExtensionElement 以启用消息检查器行为。

第一步是实现消息检查器。

// IDispatchMessageInspector Members

public object AfterReceiveRequest(ref System.ServiceModel.Channels.Message request, IClientChannel channel, InstanceContext instanceContext)
{
  Console.WriteLine("AfterReceiveRequest called.");
  return null;
}

public void BeforeSendReply(ref System.ServiceModel.Channels.Message reply, object correlationState)
{
  Console.WriteLine("BeforeSendReply called.");
}

下面的代码示例演示了如何使用 ApplyDispatchBehavior 方法将消息检查器添加到 DispatchRuntime.MessageInspectors 属性。

// IEndpointBehavior Members
public void AddBindingParameters(ServiceEndpoint serviceEndpoint, System.ServiceModel.Channels.BindingParameterCollection bindingParameters)
{
  return;
}

public void ApplyClientBehavior(ServiceEndpoint serviceEndpoint, ClientRuntime behavior)
{
  behavior.MessageInspectors.Add(new EndpointBehaviorMessageInspector());
}

public void ApplyDispatchBehavior(ServiceEndpoint serviceEndpoint, EndpointDispatcher endpointDispatcher)
{
  endpointDispatcher.DispatchRuntime.MessageInspectors.Add(new EndpointBehaviorMessageInspector());
}

public void Validate(ServiceEndpoint serviceEndpoint)
{
  return;
}

下面的代码示例演示了如何实现 System.ServiceModel.Configuration.BehaviorExtensionElement，以便从配置文件使用消息检查器行为。

// BehaviorExtensionElement members
public override Type BehaviorType
{
  get { return typeof(EndpointBehaviorMessageInspector); }
}

protected override object CreateBehavior()
{
  return new EndpointBehaviorMessageInspector();
}

最后，下面的配置文件演示了如何从配置使用前面的示例。

<configuration>
  <system.serviceModel>
    <services>
      <service 
        name="Microsoft.WCF.Documentation.SampleService"
        behaviorConfiguration="metadataSupport"
      >
        <host>
          <baseAddresses>
            <add baseAddress="http://localhost:8080/ServiceMetadata" />
          </baseAddresses>
        </host>
        <endpoint
          address="/SampleService"
          binding="wsHttpBinding"
          behaviorConfiguration="withMessageInspector" 
          contract="Microsoft.WCF.Documentation.ISampleService"
        />
        <endpoint
           address="mex"
           binding="mexHttpBinding"
           contract="IMetadataExchange"
        />
      </service>
    </services>
    <behaviors>
      <serviceBehaviors>
      <behavior name="metadataSupport">
        <serviceMetadata httpGetEnabled="true" httpGetUrl=""/>
      </behavior>
      </serviceBehaviors>
      <endpointBehaviors>
        <behavior name="withMessageInspector">
          <endpointMessageInspector />
        </behavior>
      </endpointBehaviors>
    </behaviors>
    <extensions>
      <behaviorExtensions>
        <add 
          name="endpointMessageInspector"
          type="Microsoft.WCF.Documentation.EndpointBehaviorMessageInspector, HostApplication, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null"
        />
      </behaviorExtensions>
    </extensions>
  </system.serviceModel>
</configuration>

注解

实现 IEndpointBehavior 接口可以在应用程序级别，为客户端或服务应用程序修改、检查或扩展终结点范围内的某些执行方面。

  • 使用 AddBindingParameters 方法可以在运行时传递自定义数据，从而使绑定支持自定义行为。

  • 使用 ApplyClientBehavior 方法可以在客户端应用程序中修改、检查或插入对终结点中的扩展。

  • 使用 ApplyDispatchBehavior 方法可以在服务应用程序中修改、检查或插入对终结点范围执行的扩展。

  • 使用 Validate 方法可以确认 ServiceEndpoint 是否满足特定需求。 这可用于确保终结点启用某一配置设置、支持特定功能和其他要求。

IEndpointBehavior 对象可以使用这些方法中的任何一种，但通常只有一种方法很重要：在这种情况下，未使用的方法可以返回，不执行任何操作。

注意

所有 IEndpointBehavior 方法会将 ServiceEndpoint 对象作为参数传递。 此参数只用于检查；如果您修改了 ServiceEndpoint 对象，则执行行为将是不确定的。

通常，IEndpointBehavior 对象用于访问服务应用程序中的 System.ServiceModel.Dispatcher.DispatchRuntime、System.ServiceModel.Dispatcher.DispatchOperation、System.ServiceModel.Dispatcher.EndpointDispatcher 和 System.ServiceModel.Dispatcher.ChannelDispatcher 对象的各个属性，以及客户端应用程序中的 System.ServiceModel.Dispatcher.ClientRuntime 和 System.ServiceModel.Dispatcher.ClientOperation 对象的各个属性。 此外，您还可分别通过使用 ClientRuntime.CallbackDispatchRuntime 和 DispatchRuntime.CallbackClientRuntime 属性来访问双向客户端和服务的属性。

有关各种可用属性和自定义项的说明，请参阅 扩展 ServiceHost 和服务模型层。

在 (确定自定义项并在必要时实现自定义接口) 并且 IEndpointBehavior 已确定为适当的自定义范围后，必须将自定义项插入到 Windows Communication Foundation (WCF) 运行时中，方法是 IEndpointBehavior 实现终结点行为并将其添加到运行时。

有两种方法可以将该行为添加到运行时：

  • 以编程方式，先将自定义终结点行为添加到 Behaviors 属性，然后打开服务主机（位于服务应用程序中）或通道工厂（位于客户端应用程序中）。

  • 使用应用程序配置文件配置该行为。 有关详细信息，请参阅 <behaviorExtensions>。

若要执行服务自定义计划任务，则必须先将 IEndpointBehavior 对象添加到 ServiceEndpoint.Behaviors 属性，然后构造服务运行时，该构造操作是在对 ICommunicationObject.Open 调用 System.ServiceModel.ServiceHost 方法时执行的。 若要执行客户端自定义任务，则必须对 IEndpointBehavior 调用 ServiceEndpoint.Behaviors 方法或 ChannelFactory<TChannel>.CreateChannel 方法之前，先将 ICommunicationObject.Open 对象添加到 ChannelFactory<TChannel> 属性。

方法

AddBindingParameters(ServiceEndpoint, BindingParameterCollection)

实现此方法可以在运行时将数据传递给绑定，从而支持自定义行为。
ApplyClientBehavior(ServiceEndpoint, ClientRuntime)

在终结点范围内实现客户端的修改或扩展。
ApplyDispatchBehavior(ServiceEndpoint, EndpointDispatcher)

在终结点范围内实现服务的修改或扩展。
Validate(ServiceEndpoint)

实现此方法可以确认终结点是否满足某些设定条件。

适用于