自定义消息拦截器

项目
05/09/2023

MessageInterceptor 示例演示通道扩展模型的用法。特别是，演示如何实现可创建通道工厂和通道侦听器的自定义绑定元素，以便在运行时堆栈的特定点截获所有传入和传出消息。此示例还包括一个客户端和一个服务器，用于演示这些自定义工厂的使用。

在此示例中，客户端和服务都是控制台程序 (.exe)。客户端和服务都使用一个通用库 (.dll)，其中包含自定义绑定元素及其关联的运行库对象。

注意

本主题的最后介绍了此示例的设置过程和生成说明。

此示例介绍了使用通道框架并遵循 WCF 最佳做法在 Windows Communication Foundation (WCF) 中创建自定义分层通道的推荐过程。创建自定义分层通道的步骤如下所示：

确定您的通道工厂和通道侦听器将要支持哪些通道形状。
创建支持您的通道形状的通道工厂和通道侦听器。
添加一个绑定元素，用于将自定义分层通道添加到通道堆栈中。
添加一个绑定元素扩展部分，以便将新的绑定元素公开到配置系统。

通道形状

编写自定义分层通道的第一步是确定该通道需要哪些形状。对于我们的消息拦截器，支持我们下面的层所支持的任何形状（例如，如果我们下面的层可以生成 IOutputChannel 和 IDuplexSessionChannel，则我们也公开 IOutputChannel 和 IDuplexSessionChannel）。

通道工厂和侦听器工厂

编写自定义分层通道的下一步是为客户端通道创建 IChannelFactory 的实现，并为服务通道创建 IChannelListener 的实现。

这些类采用内部工厂和侦听器，并将除 OnCreateChannel 和 OnAcceptChannel 之外的所有调用委托给内部工厂和侦听器。

class InterceptingChannelFactory<TChannel> : ChannelFactoryBase<TChannel>
{
    //...
}

class InterceptingChannelListener<TChannel> : ListenerFactoryBase<TChannel>
{
    //...
}

添加绑定元素

此示例定义了一个自定义绑定元素：InterceptingBindingElement。 InterceptingBindingElement 采用 ChannelMessageInterceptor 作为输入，并使用此 ChannelMessageInterceptor 处理通过它传递的消息。这是唯一必须公开的类。工厂、侦听器和通道都可以是公共运行库接口的内部实现。

public class InterceptingBindingElement : BindingElement
{
}

添加配置支持

为了与绑定配置集成，库定义了一个配置节处理程序作为绑定元素扩展部分。客户端和服务器配置文件必须向配置系统注册该绑定元素扩展。希望将其绑定元素公开给配置系统的实现程序可以从此类派生。

public abstract class InterceptingElement : BindingElementExtensionElement
{
    //...
}

添加策略

为了与我们的策略系统集成，InterceptingBindingElement 实现了 IPolicyExportExtension，以表明我们应参与生成策略。若要支持在生成的客户端导入策略，用户可以注册 InterceptingBindingElementImporter 的派生类并重写 CreateMessageInterceptor()，以生成启用策略的 ChannelMessageInterceptor 类。

示例：可丢弃的消息拦截器

此示例中包括了丢弃消息的 ChannelMessageInspector 的示例实现。

class DroppingServerElement : InterceptingElement
{
    protected override ChannelMessageInterceptor CreateMessageInterceptor()
    {
        return new DroppingServerInterceptor();
    }
}

您可以按如下方式从配置中访问该示例：

<configuration>
    ...
    <system.serviceModel>
        ...
        <extensions>
            <bindingElementExtensions>
                <add name="droppingInterceptor"
                   type=
          "Microsoft.ServiceModel.Samples.DroppingServerElement, library"/>
            </bindingElementExtensions>
        </extensions>
    </system.serviceModel>
</configuration>

客户端和服务器都使用这个新创建的配置部分，将自定义工厂插入其运行库通道堆栈的最低层（在传输层之上）。

<customBinding>
  <binding name="sampleBinding">
    <droppingInterceptor/>
    <httpTransport/>
  </binding>
</customBinding>

客户端使用 MessageInterceptor 库在编号为偶数的消息中添加一个自定义头。另一方面，服务则使用 MessageInterceptor 库丢弃所有没有这个特殊头的消息。

运行服务后再运行客户端，您应该可以看到以下客户端输出。

Reporting the next 10 wind speed
100 kph
Server dropped a message.
90 kph
80 kph
Server dropped a message.
70 kph
60 kph
Server dropped a message.
50 kph
40 kph
Server dropped a message.
30 kph
20 kph
Server dropped a message.
10 kph
Press ENTER to shut down client

客户端向服务报告了 10 个不同的风速，但只用这个特殊的头标记了其中 5 个。

在服务上，您应看到以下输出：

Press ENTER to exit.
Dangerous wind detected! Reported speed (90) is greater than 64 kph.
Dangerous wind detected! Reported speed (70) is greater than 64 kph.
5 wind speed reports have been received.

设置、生成和运行示例

使用以下命令安装 ASP.NET 4.0。

%windir%\Microsoft.NET\Framework\v4.0.XXXXX\aspnet_regiis.exe /i /enable

请确保已执行 Windows Communication Foundation 示例的一次性安装过程。
要生成解决方案，请按照生成 Windows Communication Foundation 示例中的说明进行操作。
要使用单机配置或跨计算机配置来运行示例，请按照运行 Windows Communication Foundation 示例中的说明进行操作。
先运行 Service.exe，然后运行 Client.exe 并观察两个控制台窗口的输出。