微软消息队列-MicroSoft Message Queue(MSMQ)队列的C#使用

目录

• 定义的接口
• 接口实现
• 创建队列工厂
• 写入队列
• 获取消息

什么是MSMQ

Message Queuing(MSMQ) 是微软开发的消息中间件，可应用于程序内部或程序之间的异步通讯。主要的机制是：消息的发送者把本身想要发送的信息放入一个容器中（咱们称之为Message），而后把它保存至一个系统公用空间的消息队列(Message Queue)中；本地或者是异地的消息接收程序再从该队列中取出发给它的消息进行处理。下图展现了这一流程

MSMQ队列是一个可持久的队列，所以没必要担忧不间断地插入队列会致使数据的丢失,在网站系统中不用担忧网站挂掉后数据丢失问题。
MSMQ微软消息队列，这个是个很好的异步通讯技术。很是相似于咱们手机发短信，虽然对方关机了，但只要一开机通讯服务器仍然自动会传送信息。因此MSMQ有这样的时间监控技术.很实用.能够确保通讯的稳定性.

使用MSMQ的基本流程

　　1. 启动MSMQ服务，【控制面板】--【程序与功能】--【关闭/打开windows功能】--添加MSMQ功能，勾选所有选项。

控制面板->控制面板->全部控制面板项->程序和功能->选中安装

　　2. 建立Message Queue队列。
　　3. 打开Message Queue队列。
　　4. 将消息发送至Message Queue队列或者从Message Queue队列中接收消息。
　　5. 关闭Message Queue队列。

C# 中使用MSMQ

使用MessageQueue类操做MSMQ，其在System.Messaging命名空间下，须要添加引用

定义的接口

public interface IMessageSender<T> : IDisposable
{
    /// <summary>
    ///     发送消息
    /// </summary>
    /// <param name="message">消息对象</param>
    void SendMessage(T message);

    void SendMessages(List<T> message);

    /// <summary>
    ///     发送消息
    /// </summary>
    /// <param name="message">消息对象</param>
    /// <param name="label">消息标签</param>
    void SendMessage(T message, string label);
}

接口实现

/// <summary>
///     消息队列对象，由MQueueFactory建立指定路径的队列对象，可发送或批量接收消息。
/// </summary>
/// <typeparam name="T">消息队列存储的消息对象类型</typeparam>
public sealed class MQueue<T> : IDisposable, IMessageSender<T>, IMessageReceiver<T>
{
    public MQueue(MessageQueue mq, string user = "Everyone")
    {
        InnerQueue = mq;
        InnerQueue.Formatter = new XmlMessageFormatter(new[] { typeof(T) });

        InnerQueue.SetPermissions(user ?? "Everyone",
            MessageQueueAccessRights.GenericRead | MessageQueueAccessRights.DeleteMessage |
            MessageQueueAccessRights.DeleteQueue | MessageQueueAccessRights.DeleteJournalMessage);
    }
    #region IMessageSender
    /// <summary>
    ///     内部消息队列对象
    /// </summary>
    private MessageQueue InnerQueue { get; set; }

    /// <summary>
    ///     发送消息
    /// </summary>
    /// <param name="message">消息对象</param>
    public void SendMessage(T message)
    {
        InnerQueue.Send(message);
    }

    public void SendMessages(List<T> message)
    {
        foreach (var item in message)
        {
            InnerQueue.Send(item);
        }
    }

    /// <summary>
    ///     发送消息
    /// </summary>
    /// <param name="message">消息对象</param>
    /// <param name="label">消息标签</param>
    public void SendMessage(T message, string label)
    {
        try
        {
            InnerQueue.Send(message, label);
        }
        catch (Exception ex)
        {
            var path = InnerQueue.Path;
            InnerQueue = new MessageQueue(path);
        }
    }
    #endregion 

    #region IMessageReceiver
    /// <summary>
    /// 获取队列中全部消息
    /// </summary>
    /// <typeparam name="T">消息类型</typeparam>
    /// <param name="exTarget">异常时触发</param>
    /// <returns></returns>
    public List<T> GetAllMessages<T>(MQExceptionTarget exTarget = null)
    {
        return GetMessagesByNum<T>(null, exTarget);
    }
    /// <summary>
    /// 获取队列中指定数量消息
    /// </summary>
    /// <typeparam name="T">消息类型</typeparam>
    /// <param name="num">一次最多取num条数据，默认取全部数据</param>
    /// <param name="exTarget">异常委托</param>
    /// <returns></returns>
    public List<T> GetMessagesByNum<T>(int? num = null, MQExceptionTarget exTarget = null)
    {
        var list = new List<T>();
        if (num.HasValue && num <= 0)
        {
            return list;
        }
        MessageEnumerator enumerator = InnerQueue.GetMessageEnumerator2();
        while (enumerator.MoveNext())
        {
            Message msg = enumerator.RemoveCurrent();
            enumerator.Reset();
            if (msg != null)
            {
                try
                {
                    list.Add((T)msg.Body);
                    if (num.HasValue && list.Count >= num)
                    {
                        break;
                    }
                }
                catch (Exception ex)
                {
                    if (exTarget != null)
                        exTarget(ex);
                }
            }
        }
        return list;
    }
    #endregion

    public void Dispose()
    {
        if (InnerQueue != null)
        {
            InnerQueue.Dispose();
        }
    }
}

创建队列工厂

/// <summary>
///  消息队列工厂，经过指定路径建立或获取相应队列对象
/// </summary>
public class MQueueFactory
{
    /// <summary>
    ///     默认队列路径，在未指定路径的状况下，将建立并返回该路径的消息队列对象
    /// </summary>
    private const string DefaultPath = @".\private$\myQueue";

    /// <summary>
    ///     建立默认路径的消息队列对象
    /// </summary>
    /// <typeparam name="T">消息队列存储的消息对象类型</typeparam>
    /// <returns></returns>
    public static MQueue<T> Create<T>()
    {
        return Create<T>(DefaultPath);
    }

    /// <summary>
    ///     建立指定路径的消息队列路径
    /// </summary>
    /// <typeparam name="T">消息队列存储的消息对象类型</typeparam>
    /// <param name="connStr">指定的消息队列连接字符串 def:".\private$\myQueue"</param>
    /// <param name="autoCreate">不存在则建立队列 远程地址不能建立</param>
    /// <param name="user">得到队列额外权限的我的、组或计算机</param>
    /// <param name="cacheKey">web中Cache键值</param>
    /// <returns></returns>
    public static MQueue<T> Create<T>(string connStr=@".\private$\myQueue", bool autoCreate = false, string user = "Everyone", string cacheKey = "MQCache")
    {
        string path = connStr ?? DefaultPath;
        HttpContext httpContext = HttpContext.Current;
        if (autoCreate && !MessageQueue.Exists(path))
        {
            MessageQueue.Create(path);
        }
        var mq = new MessageQueue(path);
        if (httpContext != null)
        {
            string key = "MQueue" + typeof(T).Name + cacheKey;
            if ((httpContext.Cache[key] == null))
            {
                httpContext.Cache[key] = new MQueue<T>(mq);
            }
            return httpContext.Cache[key] as MQueue<T>;
        }
        return new MQueue<T>(mq,user);
    }
}

写入队列

MQueueFactory.Create<string>(@".\private$\myQueue", autoCreate: true).SendMessage("我是写入的数据~~~");

获取消息

MQueueFactory.Create<string>(@".\private$\myQueue").GetAllMessages<string>();

代码来源：https://www.cnblogs.com/morang/p/mqdemo-msmq.html