ASP.NET CORE 6.0实现MassTransit

KysonDu

已于 2024-06-17 10:06:32 修改

阅读量494

点赞数 4

文章标签： asp.net 后端 c# visual studio

于 2024-06-07 09:29:34 首次发布

本文链接：https://blog.csdn.net/weixin_41140260/article/details/139515079

版权

1. 安装必要的 NuGet 包

2. 配置 MassTransit、注册消费者

3. 定义消息和消费者

4. 发送消息

MassTransit 是一个轻量级的 .NET 消息总线（message bus）框架，它支持多种消息队列中间件，如 RabbitMQ、Azure Service Bus、ActiveMQ 等。它允许开发人员轻松实现分布式应用程序的消息传递和处理。

前提条件：RabbitMQ需要安装
参考安装教程：RabbitMQ在Windows下的安装过程、解决安装 RabbitMQ 安装不成功的问题

要在 .NET 6.0 Web API 中使用 MassTransit，你可以按照以下步骤进行：

1. 安装必要的 NuGet 包

首先，你需要安装 MassTransit 及其支持的消息队列中间件的 NuGet 包 MassTransit.RabbitMQ

2. 配置 MassTransit、注册消费者

在 Program.cs 文件中配置 MassTransit：

builder.Services.AddMassTransit(x =>
{
    // 添加接收者
    x.AddConsumer<MessageConsumer>();

    x.UsingRabbitMq((context, cfg) =>
    {
        // RabbitMQ服务器的本地地址进行连接
        cfg.Host("rabbitmq://localhost", h =>
        {
            h.Username("guest");
            h.Password("guest");
        });

        // 配置接收者队列
        cfg.ReceiveEndpoint("test-queue", e =>
        {
            e.ConfigureConsumer<MessageConsumer>(context);
        });
    });
});

3. 定义消息和消费者

定义一个消息类：

    /// <summary>
    /// 消费类
    /// </summary>
    public class TestMessage
    {
        public string Text { get; set; }
    }

定义一个消费者：

Consume 方法的作用

处理消息：Consume 方法的主要作用是处理接收到的消息。你可以在这个方法中编写业务逻辑来处理消息，例如保存到数据库、调用其他服务、进行计算等。
访问消息上下文：通过 ConsumeContext 对象，你可以访问消息的各种元数据，例如消息头、消息ID、重试次数等，这些信息在处理消息时可能是有用的。

    /// <summary>
    /// MessageConsumer 类是一个消费者，用于处理 TestMessage 类型的消息。
    /// </summary>
    public class MessageConsumer : IConsumer<TestMessage>
    {
        private readonly ILogger<MessageConsumer> _logger;
        /// <summary>
        /// 构造函数，用于注入依赖项。
        /// </summary>
        public MessageConsumer(ILogger<MessageConsumer> logger)
        {
            this._logger = logger;
        }

        /// <summary>
        /// 用于处理接收到的消息。
        /// </summary>
        /// <param name="context"></param>
        /// <returns></returns>
        public async Task Consume(ConsumeContext<TestMessage> context)
        {
            // 记录日志，传入一个上下文对象 context 和格式字符串 "Received message: {Text}"，
            // 这里的 {Text} 是 TestMessage 类中的属性。
            _logger.LogInformation("Received message: {Text}", context.Message.Text);

            // 处理消息，这里可以添加具体的处理逻辑。
            // 在这个示例中，我们简单地返回一个已完成的任务。
            await Task.CompletedTask;
        }
    }

4. 发送消息

你可以在你的控制器中发送消息：

    /// <summary>
    /// 这是一个用于处理消息队列的控制器类。
    /// </summary>
    [ApiController]
    [Route("[controller]")]
    public class QueueController : ControllerBase
    {
        private readonly IBus _bus;

        /// <summary>
        /// 构造函数，传入IBus类型的参数bus，将bus赋值给_bus public
        /// </summary>
        /// <param name="bus"></param>
        public QueueController(IBus bus)
        {
            _bus = bus;
        }

        /// <summary>
        /// 发送消息到消息队列
        /// </summary>
        /// <param name="message"></param>
        /// <returns></returns>
        [HttpPost]
        public async Task<IActionResult> SendMessage([FromBody] TestMessage message)
        {
            // 如果message为空或者message的Text属性为空，则返回一个BadRequest响应，响应的内容为"Invalid message."
            if (message == null || string.IsNullOrWhiteSpace(message.Text))
            {
                return BadRequest("Invalid message.");
            }

            // 否则，将message发布到消息总线_bus中
            await _bus.Publish(message);

            return Ok("Message sent.");
        }
    }

发送消息之后会在RabbitMQ队列里面可以看到接收队列的名称“test-queue”

以上步骤介绍了如何在 .NET 6.0 Web API 中配置和使用 MassTransit 进行消息传递。你可以根据具体需求选择不同的消息队列中间件并进行相应的配置。

在消息队列系统中，如果两个消费者订阅了同一个队列（如 “test-queue”），那么消息通常只会被其中一个消费者处理。这是因为消息队列通常使用工作队列模式，其中消息在多个消费者之间进行负载均衡，每个消息只被一个消费者处理一次。

具体来说，当你在第一个服务器上发送 SendMessage，消息会进入 test-queue 队列中。MassTransit 和消息队列中间件（如 RabbitMQ）会从队列中取出消息并将其分发给一个可用的消费者。如果第一个服务器的消费者已经取出并处理了消息，第二个服务器的消费者将不会处理同一条消息。

这是消息队列的典型工作方式，用于实现消息处理的负载均衡。