Spring Boot 4.0 牵手RabbitMQ：注解魔法开启消息之旅

小码哥_常
4 阅读16分钟

Spring Boot 4.0 牵手RabbitMQ：注解魔法开启消息之旅

一、RabbitMQ 与 Spring Boot 4.0，为何是绝配？

在当今分布式系统盛行的时代，高效的消息通信与系统间的解耦变得至关重要。RabbitMQ 作为一款备受欢迎的消息队列中间件，以其强大的异步通信能力和出色的解耦特性脱颖而出。它就像是分布式系统中的 “信使”，在各个服务之间传递消息，让不同的服务能够异步地进行交互，避免了服务之间的直接依赖，大大降低了系统的耦合度。

举个例子，在一个电商系统中，订单服务创建订单后，无需立即同步调用库存服务和通知服务，而是将消息发送到 RabbitMQ。库存服务和通知服务可以按照自己的节奏从队列中获取消息并处理，这样不仅提高了系统的响应速度，还增强了系统的稳定性和扩展性。

而 Spring Boot 4.0 的发布，更是为开发者带来了一系列令人兴奋的新特性。它基于 Spring Framework 7.0 构建，在性能、开发体验和云原生适配等方面都有了显著的提升。例如，它对虚拟线程的支持，使得应用能够轻松应对高并发场景，极大地提高了系统的吞吐量；新的 API 和注解也让开发变得更加简洁高效。

当强大的 RabbitMQ 遇上全新升级的 Spring Boot 4.0，两者的结合就像是天作之合。Spring Boot 4.0 提供的便捷配置和强大的依赖管理，使得集成 RabbitMQ 变得轻而易举；而 RabbitMQ 则为 Spring Boot 应用带来了可靠的异步消息通信能力。在这其中，使用注解方式进行整合更是让开发过程如虎添翼，极大地提高了开发效率。接下来，就让我们一起深入探索 Spring Boot 4.0 整合 RabbitMQ 的注解方式使用指南。

二、环境搭建：准备就绪，开启整合

（一）创建 Spring Boot 4.0 项目

首先，我们需要创建一个 Spring Boot 4.0 项目。这里，Spring Initializr 为我们提供了极大的便利，它就像是一个贴心的项目初始化助手，只需简单几步操作，就能快速生成一个基础的 Spring Boot 项目框架。接下来，让我们看看具体的操作步骤。

  1. 打开浏览器，访问 Spring Initializr 的官方地址：start.spring.io/。如果在国内访问，你也可以使用镜像地址start.springboot.io/，以解决官方地址加载慢的问题。

  2. 在打开的页面中，我们可以看到一系列的项目配置选项。在 “Project Metadata” 部分，填写项目的基本信息，包括 Group（通常是公司或组织的域名倒置，例如com.example）、Artifact（项目的名称，例如spring-boot-rabbitmq-demo）、Name（项目的显示名称，默认与 Artifact 相同）、Description（项目描述，可简要介绍项目的用途）以及 Package name（项目的包名，默认根据 Group 和 Artifact 生成）。同时，选择 Maven 项目和 Java 语言，并将 Spring Boot 版本设置为 4.0.0。

  3. 点击 “Add Dependencies” 按钮，搜索并添加以下依赖：

    • Spring for RabbitMQ：这是 Spring Boot 与 RabbitMQ 集成的核心依赖，它提供了一系列的接口和工具类，让我们能够方便地在 Spring Boot 项目中使用 RabbitMQ 的各种功能，比如创建队列、发送和接收消息等。

    • Spring Web：如果你的项目需要提供 Web 服务，这个依赖是必不可少的。它包含了 Spring MVC 和 Tomcat 容器，让我们能够快速搭建一个 Web 应用，方便与外界进行交互。

  4. 配置完成后，点击 “GENERATE” 按钮，Spring Initializr 会根据我们的配置生成一个 ZIP 压缩包并自动下载。解压这个压缩包，我们就得到了一个完整的 Spring Boot 项目结构，其中pom.xml文件管理着项目的依赖关系，src/main/java目录存放着我们的 Java 代码，src/main/resources目录则存放着配置文件、静态资源等。

（二）安装与启动 RabbitMQ

安装 RabbitMQ，使用 Docker 是个高效的方式，它能快速构建出一个运行环境，并且隔离性好，不会对我们的本地系统造成过多的干扰。下面是具体的安装和启动步骤：

  1. 确保你的系统已经安装了 Docker。如果没有安装，可以参考 Docker 官方文档进行安装。

  2. 拉取 RabbitMQ 镜像，在终端中运行以下命令：


docker pull rabbitmq:management

这里使用的rabbitmq:management镜像，它不仅包含了 RabbitMQ 服务器，还自带了 Web 管理插件，通过这个插件，我们可以在浏览器中直观地管理和监控 RabbitMQ 的运行状态，比如查看队列中的消息、创建和删除队列等。 3. 拉取镜像后，通过以下命令启动 RabbitMQ 容器：


docker run -d --name rabbitmq -p 5672:5672 -p 15672:15672 rabbitmq:management

命令中的参数解释如下：

  • -d：表示以后台模式运行容器，这样我们在启动容器后，还可以继续在终端中执行其他命令，而不会被容器的运行过程所阻塞。

  • --name rabbitmq：为容器指定一个名称为rabbitmq，方便我们后续对容器进行管理和操作，比如停止、重启容器等。

  • -p 5672:5672：将容器的 5672 端口（RabbitMQ 的默认端口，用于应用程序与 RabbitMQ 进行通信）映射到主机的 5672 端口，这样我们的应用程序就可以通过主机的 5672 端口与容器中的 RabbitMQ 进行交互。

  • -p 15672:15672：将容器的 15672 端口（RabbitMQ 管理界面的端口）映射到主机的 15672 端口，这样我们就可以在浏览器中通过访问http://localhost:15672来打开 RabbitMQ 的管理界面。

  1. 启动容器后，打开浏览器，访问http://localhost:15672，在登录页面中，默认的用户名和密码都是guest。登录后，我们就可以看到 RabbitMQ 的管理界面，在这里，我们可以进行各种管理操作，比如创建新的用户、设置用户权限、创建队列和交换机等。

三、核心配置：搭建桥梁，连接两者

（一）配置文件详解

在 Spring Boot 项目中，我们主要在application.yml配置文件中配置 RabbitMQ 的连接参数。这些参数就像是连接 Spring Boot 应用与 RabbitMQ 服务器的桥梁，确保两者能够顺利通信。以下是一些关键配置参数及其作用：


spring:
  rabbitmq:
    host: localhost # RabbitMQ服务器地址
    port: 5672 # 端口号
    username: guest # 用户名
    password: guest # 密码
    virtual-host: / # 虚拟主机，相当于一个独立的消息隔离空间，可以在同一RabbitMQ服务器上创建多个虚拟主机，每个虚拟主机之间相互隔离，拥有自己的队列、交换机和绑定关系等。
    # 连接池配置 (Spring Boot 3.x 新特性)，设置连接超时时间为5秒。连接池可以复用连接，减少连接创建和销毁的开销，提高系统性能。
    connection-timeout: 5s 
    # 发布确认，设置为correlated，表示启用发布确认机制，并且使用关联数据（CorrelationData）来跟踪消息的确认情况。这样生产者可以知道消息是否成功发送到交换机。
    publisher-confirm-type: correlated 
    publisher-returns: true # 启用发布返回，当消息发送到交换机后，如果无法路由到任何队列，会将消息返回给生产者。
    template:
      mandatory: true # 当mandatory为true时，如果消息无法路由到队列，会触发ReturnCallback，将消息返回给生产者；如果为false，消息会被直接丢弃。
    listener:
      simple:
        acknowledge-mode: manual # 手动确认，设置为manual表示消费者需要手动调用`channel.basicAck`方法来确认消息已被成功处理，防止消息丢失。
        retry:
          enabled: true # 启用监听重试
          max-attempts: 3 # 最大重试次数
          initial-interval: 2s # 初始重试间隔时间为2秒

（二）注解声明队列、交换机和绑定

在 Spring Boot 中，我们可以通过配置类使用注解来声明队列、交换机和绑定关系。以一个订单处理的场景为例，假设我们有一个订单队列，用于接收订单消息，同时还配置了死信队列和延迟队列，以处理订单的超时和重试等情况。下面是具体的配置代码：


import org.springframework.amqp.core.*;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class RabbitMQConfig {
    // 声明订单队列，设置队列持久化，并且指定死信交换机和死信路由键，消息10秒过期，队列最大长度为1000。
    @Bean
    public Queue orderQueue() {
        return QueueBuilder.durable("order.queue")
               .deadLetterExchange("dlx.exchange")
               .deadLetterRoutingKey("order.dl")
               .ttl(10000)  // 10秒过期
               .maxLength(1000)
               .build();
    }

    // 声明死信队列，用于接收从订单队列中过期或被拒绝的消息。
    @Bean
    public Queue dlQueue() {
        return QueueBuilder.durable("dl.order.queue")
               .build();
    }

    // 声明订单交换机，类型为DirectExchange，并且设置为持久化。DirectExchange会根据路由键将消息直接路由到对应的队列。
    @Bean
    public DirectExchange orderExchange() {
        return ExchangeBuilder.directExchange("order.exchange")
               .durable(true)
               .build();
    }

    // 声明死信交换机，同样是DirectExchange类型且持久化。
    @Bean
    public DirectExchange dlxExchange() {
        return ExchangeBuilder.directExchange("dlx.exchange")
               .durable(true)
               .build();
    }

    // 声明订单队列与订单交换机的绑定关系，指定路由键为order.routing.key。
    @Bean
    public Binding orderBinding(Queue orderQueue, DirectExchange orderExchange) {
        return BindingBuilder.bind(orderQueue).to(orderExchange).with("order.routing.key");
    }

    // 声明死信队列与死信交换机的绑定关系，路由键为order.dl。
    @Bean
    public Binding dlBinding(Queue dlQueue, DirectExchange dlxExchange) {
        return BindingBuilder.bind(dlQueue).to(dlxExchange).with("order.dl");
    }

    // 声明延迟队列，使用RabbitMQ延迟消息插件，设置队列持久化，并添加x-delayed-type参数，指定为direct类型。
    @Bean
    public Queue delayedQueue() {
        return QueueBuilder.durable("delayed.queue")
               .withArgument("x-delayed-type", "direct")
               .build();
    }

    // 声明延迟交换机，类型为CustomExchange，并且设置为持久化，添加x-delayed-type参数，指定为direct类型。
    @Bean
    public CustomExchange delayedExchange() {
        Map<String, Object> args = new HashMap<>();
        args.put("x-delayed-type", "direct");
        return new CustomExchange("delayed.exchange", "x-delayed-message", true, false, args);
    }
}

在上述配置中，我们使用了@Bean注解来创建队列、交换机和绑定关系的 Bean 实例。通过这种方式，Spring 容器在启动时会自动创建这些组件，并将它们注册到 RabbitMQ 服务器上。同时，我们还设置了队列的一些属性，如持久化、死信相关配置以及延迟队列的特殊参数等，以满足不同的业务需求 。

四、生产者：消息的源头

（一）生产者服务类实现

在 Spring Boot 中，我们通过RabbitTemplate来发送消息。RabbitTemplate就像是一个智能的消息快递员，它封装了与 RabbitMQ 交互的细节，让我们可以方便地发送各种类型的消息。接下来，我们创建一个生产者服务类，展示如何发送简单消息、对象消息、确认消息和延迟消息。


import org.springframework.amqp.core.Message;
import org.springframework.amqp.core.MessageBuilder;
import org.springframework.amqp.rabbit.core.RabbitTemplate;
import org.springframework.amqp.rabbit.connection.CorrelationData;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.UUID;

@Service
public class MessageProducer {
    @Autowired
    private RabbitTemplate rabbitTemplate;
    @Autowired
    private ObjectMapper objectMapper;

    /**
     * 发送简单消息
     */
    public void sendSimpleMessage(String message) {
        rabbitTemplate.convertAndSend("order.exchange", "order.routing.key", message);
    }

    /**
     * 发送对象消息
     */
    public void sendOrderMessage(Order order) {
        rabbitTemplate.convertAndSend("order.exchange", "order.routing.key", order, message -> {
            // 设置消息属性
            message.getMessageProperties().setContentType("application/json");
            return message;
        });
    }

    /**
     * 发送确认消息
     */
    public void sendConfirmMessage(String message) {
        CorrelationData correlationData = new CorrelationData(UUID.randomUUID().toString());
        rabbitTemplate.convertAndSend("order.exchange", "order.routing.key", message, correlationData);
    }

    /**
     * 发送延迟消息
     */
    public void sendDelayedMessage(String message, int delayMillis) {
        Message msg = MessageBuilder.withBody(message.getBytes()).setHeader("x-delay", delayMillis).build();
        rabbitTemplate.send("delayed.exchange", "delayed.routing.key", msg);
    }
}

在上述代码中：

  • sendSimpleMessage方法用于发送简单的字符串消息，它直接使用rabbitTemplate的convertAndSend方法，将消息发送到指定的交换机和路由键。

  • sendOrderMessage方法用于发送对象消息，在发送前，通过 Lambda 表达式设置消息的内容类型为application/json，这样接收方可以正确地解析消息。

  • sendConfirmMessage方法发送带有确认机制的消息，通过CorrelationData为消息设置一个唯一的标识，方便后续确认消息是否成功发送。

  • sendDelayedMessage方法用于发送延迟消息，它使用MessageBuilder构建消息，并设置x-delay头来指定延迟时间 。

（二）发布者确认回调

发布者确认回调是确保消息成功发送到 RabbitMQ 的重要机制。在复杂的网络环境中，消息的发送可能会因为各种原因失败，比如网络波动、RabbitMQ 服务器故障等。发布者确认回调就像是消息发送的 “安全卫士”，它可以让生产者及时了解消息的发送状态，从而采取相应的措施，避免消息丢失。

在 Spring Boot 中，我们可以通过@PostConstruct注解来初始化RabbitTemplate的确认回调方法。以下是具体的代码实现：


import org.springframework.amqp.rabbit.core.RabbitTemplate;
import org.springframework.amqp.rabbit.connection.CorrelationData;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class MessageProducer {
    @Autowired
    private RabbitTemplate rabbitTemplate;

    @PostConstruct
    public void init() {
        rabbitTemplate.setConfirmCallback((correlationData, ack, cause) -> {
            if (ack) {
                System.out.println("消息发送成功: " + correlationData);
            } else {
                System.err.println("消息发送失败: " + cause);
            }
        });
    }
}

在上述代码中，init方法使用@PostConstruct注解，确保在MessageProducer实例化后，立即初始化RabbitTemplate的确认回调。setConfirmCallback方法接收一个回调函数，当消息发送到 RabbitMQ 后，RabbitMQ 会根据消息的处理结果调用这个回调函数。correlationData是消息的唯一标识，ack表示消息是否成功被 RabbitMQ 接收，cause则在消息发送失败时，提供失败的原因 。

五、消费者：消息的归宿

（一）消费者组件开发

在 Spring Boot 中，我们使用@RabbitListener注解来开发消费者组件。这个注解就像是一个消息监听的 “哨岗”，一旦有消息进入指定的队列，它就会立即触发对应的方法来处理消息。以下是一个消费者组件的示例代码：


import org.springframework.amqp.rabbit.annotation.RabbitListener;
import org.springframework.stereotype.Component;

@Component
public class OrderConsumer {
    @RabbitListener(queues = "order.queue")
    public void receiveOrder(String message) {
        System.out.println("接收到订单消息: " + message);
        // 处理订单消息的业务逻辑
        // 比如调用订单处理服务，更新订单状态等
    }
}

在上述代码中，@RabbitListener注解标注在receiveOrder方法上，指定监听的队列是order.queue。当有消息进入该队列时，receiveOrder方法会被自动调用，message参数就是队列中的消息内容。在实际应用中，我们可以在这个方法中编写具体的业务逻辑，比如解析订单数据、调用订单处理服务、更新订单状态到数据库等 。

（二）手动确认与异常处理

在消息处理过程中，手动确认消息是确保消息可靠性的重要环节。当消费者成功处理完消息后，需要手动调用basicAck方法通知 RabbitMQ，这样 RabbitMQ 才会将该消息从队列中移除。如果消费者在处理消息时发生异常，我们可以通过调用basicNack方法拒绝消息，并根据业务需求决定是否将消息重新放回队列或让其进入死信队列。

以下是一个包含手动确认和异常处理的消费者代码示例：


import com.rabbitmq.client.Channel;
import org.springframework.amqp.core.Message;
import org.springframework.amqp.rabbit.annotation.RabbitListener;
import org.springframework.stereotype.Component;

@Component
public class OrderConsumer {
    @RabbitListener(queues = "order.queue")
    public void receiveOrder(Message message, Channel channel) {
        long deliveryTag = message.getMessageProperties().getDeliveryTag();
        try {
            String msg = new String(message.getBody());
            System.out.println("接收到订单消息: " + msg);
            // 处理订单消息的业务逻辑
            // 模拟业务处理成功
            boolean success = true; 
            if (success) {
                // 手动确认消息，参数1：消息的唯一标识，参数2：是否批量确认，这里设置为false表示只确认当前这一条消息
                channel.basicAck(deliveryTag, false); 
            } else {
                // 拒绝消息，参数1：消息的唯一标识，参数2：是否批量拒绝，参数3：是否重新放回队列，这里设置为false表示不重新放回队列，消息会进入死信队列
                channel.basicNack(deliveryTag, false, false); 
            }
        } catch (Exception e) {
            try {
                // 处理异常时拒绝消息，进入死信队列
                channel.basicNack(deliveryTag, false, false); 
            } catch (Exception ex) {
                ex.printStackTrace();
            }
            e.printStackTrace();
        }
    }
}

在上述代码中，receiveOrder方法接收Message和Channel两个参数。Message包含了从队列中获取的消息内容和相关属性，Channel则用于与 RabbitMQ 进行交互，执行确认或拒绝消息的操作。在try块中，我们模拟了业务处理的过程，根据处理结果调用basicAck或basicNack方法。如果在处理过程中发生异常，在catch块中，我们先调用basicNack方法拒绝消息，让其进入死信队列，然后打印异常信息，以便后续排查问题 。

六、测试与验证：眼见为实

（一）启动项目

在完成上述配置和开发后，我们就可以启动 Spring Boot 项目了。启动项目就像是给整个消息通信系统按下了 “启动键”，让各个组件开始运转起来。我们可以使用 IDE（如 IntelliJ IDEA 或 Eclipse）的启动按钮直接启动项目，也可以在项目根目录下通过命令行运行mvn spring-boot:run来启动。

当项目启动时，Spring Boot 会自动读取application.yml中的配置信息，尝试与 RabbitMQ 服务器建立连接。如果连接成功，控制台会输出一些与 RabbitMQ 相关的日志信息，表明项目已经成功连接到 RabbitMQ 服务器。同时，Spring 容器会根据配置类中使用注解声明的队列、交换机和绑定关系，在 RabbitMQ 服务器上创建相应的组件。例如，我们之前声明的订单队列、死信队列、订单交换机和死信交换机等都会被创建出来，为后续的消息发送和接收做好准备 。

（二）发送与接收消息

为了验证消息的发送和接收是否正常，我们可以通过测试接口或单元测试来发送消息。如果项目中添加了 Spring Web 依赖，我们可以创建一个简单的控制器类，提供一个发送消息的接口。例如：


import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MessageController {
    @Autowired
    private MessageProducer messageProducer;

    @GetMapping("/send")
    public String sendMessage(@RequestParam String message) {
        messageProducer.sendSimpleMessage(message);
        return "消息发送成功: " + message;
    }
}

在上述代码中，MessageController类提供了一个/send接口，接收一个message参数，并调用MessageProducer的sendSimpleMessage方法发送消息。我们可以通过浏览器访问http://localhost:8080/send?message=Hello,RabbitMQ!（假设项目的端口为 8080）来发送消息。

发送消息后，我们可以观察控制台输出，查看消费者是否成功接收到消息。如果消费者组件配置正确，控制台会输出类似于 “接收到订单消息: Hello,RabbitMQ!” 的日志信息。同时，我们还可以登录 RabbitMQ 管理界面，在 “Queues” 页面中查看队列的消息数量变化。如果消息发送和接收正常，我们会看到订单队列的消息数量先增加（因为生产者发送了消息），然后减少（因为消费者接收并处理了消息）。

除了通过接口发送消息，我们还可以使用单元测试来验证消息的发送和接收。在src/test/java目录下创建一个测试类，例如MessageTest：


import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import static org.junit.jupiter.api.Assertions.assertTrue;

@SpringBootTest
public class MessageTest {
    @Autowired
    private MessageProducer messageProducer;

    @Test
    public void testSendMessage() {
        String message = "Test message from unit test";
        messageProducer.sendSimpleMessage(message);
        // 这里可以添加更多的断言来验证消息发送的结果，比如确认回调是否被正确调用等
        assertTrue(true); 
    }
}

在上述单元测试中，我们注入了MessageProducer并调用其sendSimpleMessage方法发送消息。虽然目前只是简单地断言测试通过，但在实际应用中，我们可以添加更多的断言逻辑，比如验证确认回调是否被正确调用、消息是否成功进入队列等，以确保消息发送的正确性 。

avatar
文章
阅读
粉丝