实践重于理论——创建一个监控程序探测WCF的并发处理

时间：2014-03-11 12:01 来源：作者：收藏

由于WCF的并发是针对某个封装了服务实例的 InstanceContext 而言的（参考《并发的本质》《并发中的同步》），所以在不同的实例上下文模式下，会表现出不同的并发行为。接下来，我们从具体的实例上下文模式的角度来剖析WCF的并发处理机制，如果对WCF实例

由于WCF的并发是针对某个封装了服务实例的InstanceContext而言的（参考《并发的本质》《并发中的同步》），所以在不同的实例上下文模式下，会表现出不同的并发行为。接下来，我们从具体的实例上下文模式的角度来剖析WCF的并发处理机制，如果对WCF实例上下文模式和实例上下文提供机制不了解的话，请参阅《WCF技术剖析（卷1）》第9章。

为了使读者对采用不同实例上下文对并发的影响有一个深刻的认识，会创建一个简单的WCF应用，并在此基础上添加监控功能，主要监控各种事件的执行时间，比如客户端服务调用的开始和结束时间，服务操作开始执行和结束执行的时间等等。读者可以根据实时输出的监控信息，对WCF的并发处理情况有一个很直观的认识。 [源代码从这里下载]

一、服务契约定义

本实例依然采用我们熟悉的四层结构，即契约、服务、寄宿和客户端。为了以可视化的形式实时输出监控信息，对于客户端和服务寄宿程序均采用Windows Form应用类型。我们依然以计算服务作为例子，下面是服务契约的定义。

using System.ServiceModel;

namespace Artech.ConcurrentServiceInvocation.Service.Interface

{

[ServiceContract(Namespace="http://www.artech.com/")]

public interface ICalculator

{

[OperationContract]

double Add(double x, double y);

}

}

二、创建监控器：EventMonitor

由于我们需要监控各种事件的时间，所以我定义了一个名为EventType的枚举表示不同的事件类型。8个枚举值分别表示开始和结束服务调用（客户端）、开始和结束服务操作执行（服务端）、开始和结束回调（服务端）以及开始和结束回调操作的执行（客户端）。关于回调的事件枚举选项在本例中不会需要，主要是为了后续演示的需要。

using System;

namespace Artech.ConcurrentServiceInvocation.Service.Interface

{

public enum EventType

{ 

StartCall,

EndCall,

StartExecute,

EndExecute,

StartCallback,

EndCallback,

StartExecuteCallback,

EndExecuteCallback

}

}

然后我定义了如下一个EventMonitor的静态类，该类通过两个重载的Send方法触发事件的形式发送事件通知。我定义了专门的事件参数类型MonitorEventArgs，封装客户端ID、事件类型和触发时间。Send具有两个重载，一个具有用整数表示的客户端ID，另一个没有。前者用于客户端，可以显式指定客户端ID，后者需要从客户端手工添加的消息报头提取客户端ID，该消息报头的名称和命名空间通过两个常量定义。

using System;

using System.ServiceModel;

namespace Artech.ConcurrentServiceInvocation.Service.Interface

{

public static class EventMonitor

{

public const string CientIdHeaderNamespace = "http://www.artech.com/";

public const string CientIdHeaderLocalName = "ClientId";

public static EventHandler<MonitorEventArgs> MonitoringNotificationSended;

  

public static void Send(EventType eventType)

{

if (null != MonitoringNotificationSended)

{ 

int clientId = OperationContext.Current.IncomingMessageHeaders.GetHeader<int>(CientIdHeaderLocalName,CientIdHeaderNamespace);                

MonitoringNotificationSended(null,new MonitorEventArgs(clientId,eventType,DateTime.Now));

}

}

  

public static void Send(int clientId, EventType eventType)

{

if (null != MonitoringNotificationSended)

{ 

MonitoringNotificationSended(null,new MonitorEventArgs(clientId,eventType,DateTime.Now));

}

}        

}

  

public class MonitorEventArgs : EventArgs

{

public int ClientId{ get; private set; }

public EventType EventType{ get; private set; }

public DateTime EventTime{ get; private set; }

  

public MonitorEventArgs(int clientId, EventType eventType, DateTime eventTime)

{

this.ClientId = clientId;

this.EventType = eventType;

this.EventTime = eventTime;

}

}

}

三、创建服务类型：CalculatorService

EventMonitor的Send方法可以直接用在CalculatorService的Add操作方法中，实时输出操作方法开始和结束执行的时间，已经当前处理的客户端的ID。下面的代码是CalculatorService的定义，需要注意的是我通过ServiceBehaviorAttribute将UseSynchronizationContext属性设置成False，至于为什么需要这么做，是后续文章需要讲述的内容。服务操作Add通过将当前线程挂起5秒钟，用以模拟一个相对耗时的操作，便于我们更好的通过监控输出的时间分析并发处理的情况。

using System.ServiceModel;

using System.Threading;

using Artech.ConcurrentServiceInvocation.Service.Interface;

namespace Artech.ConcurrentServiceInvocation.Service

{

[ServiceBehavior(UseSynchronizationContext = false)]

public class CalculatorService : ICalculator

{

public double Add(double x, double y)

{

EventMonitor.Send(EventType.StartExecute);

Thread.Sleep(5000);

double result = x + y;           

EventMonitor.Send(EventType.EndExecute);

return result;

}

}

}

四、通过Windows Forms应用寄宿服务

然后，我们在一个Windows Form应用中对上面创建的CalculatorService进行寄宿，并将该应用作为服务端的监控器。在这个应用中，我只添加了如图1所示的简单的窗体，整个窗体仅仅有一个唯一的ListBox控件，在运行的是时候相应的监控信息就实时地逐条追加到该ListBox之中。

图1 服务端监控窗体设计界面

我们通过注册EventMonitor的静态MonitoringNotificationSended事件的形式实时输出服务端监控信息。同时，对CalculatorService的寄宿实现在监控窗体的Load事件中，整个窗体后台代码如下所示。

using System;

using System.ServiceModel;

using System.Threading;

using System.Windows.Forms;

using Artech.ConcurrentServiceInvocation.Service;

using Artech.ConcurrentServiceInvocation.Service.Interface;

namespace Artech.ConcurrentServiceInvocation.Hosting

{

public partial class MonitorForm : Form

{

private SynchronizationContext _syncContext;

private ServiceHost _serviceHost;

  

public MonitorForm()

{

InitializeComponent();

}

  

private void MonitorForm_Load(object sender, EventArgs e)

{

string header = string.Format("{0, -13}{1, -22}{2}", "Client", "Time", "Event");

this.listBoxExecutionProgress.Items.Add(header);

_syncContext = SynchronizationContext.Current;

EventMonitor.MonitoringNotificationSended += ReceiveMonitoringNotification;

this.Disposed += delegate

{

EventMonitor.MonitoringNotificationSended -= ReceiveMonitoringNotification;

_serviceHost.Close();

};

_serviceHost = new ServiceHost(typeof(CalculatorService));

_serviceHost.Open();

}

  

public void ReceiveMonitoringNotification(object sender, MonitorEventArgs args)

{    

string message = string.Format("{0, -15}{1, -20}{2}", args.ClientId, args.EventTime.ToLongTimeString(), args.EventType);

_syncContext.Post(state => this.listBoxExecutionProgress.Items.Add(message), null);

}

}

}

下面是WCF相关的配置，我们采用WS2007HttpBinding作为终结点的绑定类型。

<xml version="1.0" encoding="utf-8" >

<configuration>

<system.serviceModel>

<services>

<service name="Artech.ConcurrentServiceInvocation.Service.CalculatorService">

<endpoint address="http://127.0.0.1:3721/calculatorservice" binding="ws2007HttpBinding" contract="Artech.ConcurrentServiceInvocation.Service.Interface.ICalculator" />

</service>

</services>

</system.serviceModel>

</configuration>

五、创建客户端程序

最后我们编写客户端程序，这也是一个Windows Form应用。该应用既作为CalculatorService的客户端程序而存在，同时也是客户端的监控器。整个应用具有一个与图1一样的窗体。同样以注册EventMonitor的静态MonitoringNotificationSended事件的形式实时输出客户端监控信息。在监控窗体的Load时间中，利用ThreadPool创建5个服务代理以并发的形式进行服务调用。这五个服务代理对象对应的客户端ID分别为从1到5，并通过消息报头的形式发送到服务端。整个监控窗体的代码如下所示，相应的配置就不在列出来了。

using System;

using System.ServiceModel;

using System.Threading;

using System.Windows.Forms;

using Artech.ConcurrentServiceInvocation.Service.Interface;

namespace Artech.ConcurrentServiceInvocation.Client

{

public partial class MonitorForm : Form

{

private SynchronizationContext _syncContext;

private ChannelFactory<ICalculator> _channelFactory;

private static int clientIdIndex = 0;

  

public MonitorForm()

{

InitializeComponent();

}

  

private void MonitorForm_Load(object sender, EventArgs e)

{

string header = string.Format("{0, -13}{1, -22}{2}", "Client", "Time", "Event");

this.listBoxExecutionProgress.Items.Add(header); 

_syncContext = SynchronizationContext.Current;

_channelFactory = new ChannelFactory<ICalculator>("calculatorservice");

  

EventMonitor.MonitoringNotificationSended += ReceiveMonitoringNotification;

this.Disposed += delegate

{

EventMonitor.MonitoringNotificationSended -= ReceiveMonitoringNotification;

_channelFactory.Close();

};

  

for (int i = 1; i <= 5; i++)

{

ThreadPool.QueueUserWorkItem(state =>

{

int clientId = Interlocked.Increment(ref clientIdIndex);

ICalculator proxy = _channelFactory.CreateChannel();

using (proxy as IDisposable)

{

EventMonitor.Send(clientId, EventType.StartCall);

using (OperationContextScope contextScope = new OperationContextScope(proxy as IContextChannel))

{

MessageHeader<int> messageHeader = new MessageHeader<int>(clientId);

OperationContext.Current.OutgoingMessageHeaders.Add(messageHeader.GetUntypedHeader(EventMonitor.CientIdHeaderLocalName, EventMonitor.CientIdHeaderNamespace));

proxy.Add(1, 2);

}

EventMonitor.Send(clientId, EventType.EndCall);

}

}, null);

}

} 

  

public void ReceiveMonitoringNotification(object sender, MonitorEventArgs args)

{

string message = string.Format("{0, -15}{1, -20}{2}", args.ClientId, args.EventTime.ToLongTimeString(), args.EventType);

_syncContext.Post(state => this.listBoxExecutionProgress.Items.Add(message), null);

}

}

}

到此为止，我们的监控程序就完成了。接下来我将借助于这么一个监控程序对讲述不同的实例上下文模式、不同的并发模式、以及并发请求基于相同或者不同的代理的情况下，最终会表现出怎样的并发处理行为。比如在ConcurrencyMode.Single + InstanceContextMode.Single的情况下，客户端和服务端将会输出如图2所示的监控信息，从中我们会看出并发的请求最终却是以串行化执行的。具体分析，请关注下篇。