ASP.NET Core2利用MassTransit整合RabbitMQ

在ASP.NET Core上利用MassTransit來整合使用RabbitMQ真的很簡單，程式碼也很簡潔。近期因為專案需要，我便在這基礎上再次進行了封裝，抽成了公共方法，使得使用RabbitMQ的呼叫變得更方便簡潔。那麼，就讓我們們來瞧瞧其魅力所在吧。

 

MassTransit

先看看MassTransit是個什麼寶貝（MassTransit官網的簡介）：

MassTransit是一個免費的開源輕量級訊息匯流排，用於使用.NET框架建立分散式應用程式。MassTransit在現有的頂級訊息傳輸上提供了一系列廣泛的功能，從而以開發人員友好的方式使用基於訊息的會話模式非同步連線服務。基於訊息的通訊是實現面向服務的體系結構的可靠且可擴充套件的方式。

通俗描述：

MassTransit就是一套基於訊息服務的高階封裝類庫，下游可聯接RabbitMQ、Redis、MongoDb等服務。

github官網：https://github.com/MassTransit/MassTransit

 

RabbitMQ

RabbitMQ是成熟的MQ佇列服務，是由 Erlang 語言開發的 AMQP 的開源實現。關於介紹RabbitMQ的中文資料也很多，有需要可以自行查詢。我這裡貼出其官網與下載安裝的連結，如下：

官網：http://www.rabbitmq.com

下載與安裝：http://www.rabbitmq.com/download.html

 

實現程式碼

通過上面的介紹，我們們已對MassTransit與RabbitMQ有了初步瞭解，那麼現在來看看如何在ASP.NET Core上優雅的使用RabbitMQ吧。

1、建立一個名為“RabbitMQHelp.cs”公共類，用於封裝操作RabbitMQ的公共方法，並通過Nuget來管理並引用“MassTransit”與“MassTransit.RabbitMQ”類庫。

2、“RabbitMQHelp.cs”公共類主要對外封裝兩個靜態方法，其程式碼如下：

using MassTransit;
using MassTransit.RabbitMqTransport;
using System;
using System.Collections.Generic;
using System.Text;
using System.Threading.Tasks;

namespace Lezhima.Comm
{
    /// <summary>
    /// RabbitMQ公共操作類，基於MassTransit庫
    /// </summary>
    public class RabbitMQHelp
    {
        #region 交換器

        /// <summary>
        /// 操作日誌交換器
        /// 同時需在RabbitMQ的管理後臺建立同名交換器
        /// </summary>
        public static readonly string actionLogExchange = "Lezhima.ActionLogExchange";


        #endregion


        #region 宣告變數

        /// <summary>
        /// MQ聯接地址，建議放到配置檔案
        /// </summary>
        private static readonly string mqUrl = "rabbitmq://192.168.1.181/";

        /// <summary>
        /// MQ聯接賬號，建議放到配置檔案
        /// </summary>
        private static readonly string mqUser = "admin";

        /// <summary>
        /// MQ聯接密碼，建議放到配置檔案
        /// </summary>
        private static readonly string mqPwd = "admin";

        #endregion

        /// <summary>
        /// 建立連線物件
        /// 不對外公開
        /// </summary>
        private static IBusControl CreateBus(Action<IRabbitMqBusFactoryConfigurator, IRabbitMqHost> registrationAction = null)
        {
            //通過MassTransit建立MQ聯接工廠
            return Bus.Factory.CreateUsingRabbitMq(cfg =>
            {
                var host = cfg.Host(new Uri(mqUrl), hst =>
                {
                    hst.Username(mqUser);
                    hst.Password(mqPwd);
                });
                registrationAction?.Invoke(cfg, host);
            });
        }


        /// <summary>
        /// MQ生產者
        /// 這裡使用fanout的交換型別
        /// </summary>
        /// <param name="obj"></param>
        public async static Task PushMessage(string exchange, object obj)
        {
            var bus = CreateBus();
            var sendToUri = new Uri($"{mqUrl}{exchange}");
            var endPoint = await bus.GetSendEndpoint(sendToUri);
            await endPoint.Send(obj);
        }

        /// <summary>
        /// MQ消費者
        /// 這裡使用fanout的交換型別
        /// consumer必需是實現IConsumer介面的類例項
        /// </summary>
        /// <param name="obj"></param>
        public static void ReceiveMessage(string exchange, object consumer)
        {
            var bus = CreateBus((cfg, host) =>
            {
                //從指定的訊息佇列獲取訊息 通過consumer來實現訊息接收
                cfg.ReceiveEndpoint(host, exchange, e =>
                {
                    e.Instance(consumer);
                });
            });
            bus.Start();
        }
    }
}

 

3、“RabbitMQHelp.cs”公共類已經有了MQ“生產者”與“消費者”兩個對外的靜態公共方法，其中“生產者”方法可以在業務程式碼中直接呼叫，可傳遞JSON、物件等型別的引數向指定的交換器傳送資料。而“消費者”方法是從指定交換器中進行接收繫結，但接收到的資料處理功能則交給了“consumer”類（因為在實際專案中，不同的資料有不同的業務處理邏輯，所以這裡我們直接就通過IConsumer介面交給具體的實現類去做了）。那麼，下面我們再來看看消費者裡傳遞進來的“consumer”類的程式碼吧：

using MassTransit;
using System;
using System.Collections.Generic;
using System.Text;
using System.Threading.Tasks;

namespace Lezhima.Storage.Consumer
{
    /// <summary>
    /// 從MQ接收並處理資料
    /// 實現MassTransit的IConsumer介面
    /// </summary>
    public class LogConsumer : IConsumer<ActionLog>
    {
        /// <summary>
        /// 實現Consume方法
        /// 接收並處理資料
        /// </summary>
        /// <param name="context"></param>
        /// <returns></returns>
        public Task Consume(ConsumeContext<ActionLog> context)
        {
            return Task.Run(async () =>
            {
                //獲取接收到的物件
                var amsg = context.Message;
                Console.WriteLine($"Recevied By Consumer:{amsg}");
                Console.WriteLine($"Recevied By Consumer:{amsg.ActionLogId}");
            });
        }
    }
}

 

呼叫程式碼

1、生產者呼叫程式碼如下：

/// <summary>
/// 測試MQ生產者
/// </summary>
/// <returns></returns>
[HttpGet]
public async Task<MobiResult> AddMessageTest()
{
    //宣告一個實體物件
    var model = new ActionLog();
    model.ActionLogId = Guid.NewGuid();
    model.CreateTime = DateTime.Now;
    model.UpdateTime = DateTime.Now;
    //呼叫MQ
    await RabbitMQHelp.PushMessage(RabbitMQHelp.actionLogExchange, model);

    return new MobiResult(1000, "操作成功");
}

 

2、消費者呼叫程式碼如下：

using Lezhima.Storage.Consumer;
using Microsoft.Extensions.Configuration;
using System;
using System.IO;

namespace Lezhima.Storage
{
    class Program
    {
        static void Main(string[] args)
        {
            var conf = new ConfigurationBuilder()
              .SetBasePath(Directory.GetCurrentDirectory())
              .AddJsonFile("appsettings.json", true, true)
              .Build();

            //呼叫接收者
            RabbitMQHelp.ReceiveMessage(RabbitMQHelp.actionLogExchange,
             new LogConsumer()
            );

            Console.ReadLine();
        }
    }
}

 

總結

1、基於MassTransit庫使得我們使用RabbitMQ變得更簡潔、方便。而基於再次封裝後，生產者與消費者將不需要關注具體的業務，也跟業務程式碼解耦了，更能適應專案的需要。

2、RabbitMQ的交換器需在其管理後臺自行建立，而這裡使用的fanout型別是因為其傳送速度最快，且能滿足我的專案需要，各位可視自身情況選用不同的型別。fanout型別不會儲存訊息，必需要消費者繫結交換器後才會傳送給消費者。

 

宣告

本文為作者原創，轉載請備註出處與保留原文地址，謝謝。如文章能給您帶來幫助，請點下推薦或關注，感謝您的支援！