简单的分布式应用程序日志记录器（logger）－基于MSMQ（消息队列）

本篇是《基于.Net Remoting的应用程序日志》By Rickie的后续POST，在上一篇POST中，主要分析了codeproject.com上的《AppLogger, a Simple Distributed Application Logger - Part 1》By sebma，并提出了一些改进意见。

 

这一篇继续分析codeproject.com上的《AppLogger, a Simple Distributed Application Logger - Part 2 (Using MSMQ)》By sebma，基于消息队列（MSMQ）的实际应用程序，其中还包含如下技术：.Net Remoting, ThreadPool, Design Patterns (Proxy Pattern and Observer Pattern)，值得深入学习，相应的也提出了一些个人想法或意见。

 

codeproject.com网站提供了sebma先生的源程序下载URL，在此谢谢semba的文章。

 

言归正传，下面开始解析基于MSMQ的分布式应用程序日志记录器（logger）。

1．针对上一个Solution而言，需要改变的地方或文件

(1) 在BusinessFacade项目需要引用System.Messaging assembly，另外增加3个文件，分别为：

MsmqHelper.cs 提供helper方法来创建消息队列或打开消息队列。

ProxyMsmqHome.cs 实现IHome接口，获取消息队列的路径，并创建ProxyMsmqLogger对象。

ProxyMsmqLogger.cs 实现IAppLogger接口，并调用MsmqHelper class获取消息队列对象，并发送消息Message到消息队列。

 

(2) 在BusinessRules项目需要引用System.Messaging assembly，另外增加2个文件，分别为：

MsmqObserver.cs 遵循Observer模式，MsmqObserver class监听消息队列，当有接收到消息时，并通知订阅者的回调方法。

MsmqLogger.cs 实现IAppLogger接口，定义回调方法NotifyMe，转发消息Message到实际的Logger，如DBLogger，EmailLogger，FileLogger等，由这些实际的Logger负责将Message持续化。

 

(3) Client端配置文件app.config

<!--

      AppLogger.Home.Location refers to the URL of AppLogger's IHome

 -->

 <add key="AppRemotingLogger.Home.Location" value="http://localhost/AppRemotingLogger/AppRemotingLogger.IHome.soap" />

 <!--

 <add key="AppRemotingLogger.Home.Location" value="msmq:FormatName:DIRECT=OS:inspire\private$\AppRemotingLogger" />

-->

如果采用MSMQ队列，则注释上面的Remoting URL，改用下面的Message Queue Path。

 

2．Client端测试程序

Client端程序基本不需要修改，只是添加了一个Windows Form，如下是简单的Demo界面：

 

 

3．MSMQ Server Logger项目

因为我采用IIS作为Remote Objects的host server，因此这里另外添加了一个MSMQ Server Logger项目，来单独处理消息队列中的消息，负责访问消息队列并调用Logger对象将消息持久化。

 

应用程序Demo界面如下：

 

需要在app.config配置文件中指定消息队列的路径（Message Queue Path）：

<add key="AppRemotingLogger.MSMQ" value="FormatName:DIRECT=OS:inspire\private$\appremotinglogger" />

 

4．需要改进的地方

      终止消息队列的m_objMsmq2Listen.BeginReceive()，源代码存在一些bug，并不能真正停止该BeginReceive线程。

源代码如下：

 /// <summary>

 /// Stop this observer.

 /// </summary>

 public void Terminate()

 {

        if (m_blnRunning)

        {

            m_blnRunning = false;

            // m_objMsmq2Listen.Close();

        }

 }

 

改进后的代码如下：

public void Terminate()

{

      if (m_blnRunning)

      {

           m_blnRunning = false;

           m_objMsmq2Listen.ReceiveCompleted -= new System.Messaging.ReceiveCompletedEventHandler(OnMessageReceived);

          

           // Send a null message to Message Queue

           m_objMsmq2Listen.Send(new object());

           if(this.m_objArgs != null)

                 m_objMsmq2Listen.EndReceive(this.m_objArgs.AsyncResult);

           else

                 m_objMsmq2Listen.EndReceive(firstAsyncResult);

           m_objMsmq2Listen.Close();

           m_objMsmq2Listen.Dispose();

      }

}

代码解释：先取消ReceiveCompleted事件的Event Handler，m_objMsmq2Listen.ReceiveCompleted -= new System.Messaging.ReceiveCompletedEventHandler(OnMessageReceived);

然后，发送一个空消息到消息队列：

m_objMsmq2Listen.Send(new object());

通过调用m_objMsmq2Listen.EndReceive()方法终止m_objMsmq2Listen.BeginReceive()线程。最后释放消息队列占用的资源。

 

References:

1. Sebma, codeproject.com, AppLogger, a Simple Distributed Application Logger - Part 1

2. Sebma, codeproject.com, AppLogger, a Simple Distributed Application Logger - Part 2 (Using MSMQ)

3. Rickie, 基于.Net Remoting的应用程序日志

4. Rickie, ThreadPool（线程池） in .Net