SpringBoot集成RabbitMQ详解(附带实例)
Spring Boot 提供了 spring-bootstarter-amqp 组件对消息队列进行支持,使用非常简单,仅需要非常少的配置即可实现完整的消息队列服务。
下面通过示例演示集成 RabbitMQ 实现消息的接收和发送:
示例代码如下:
示例代码如下:
最后,单击 Run Test 或在方法上右击,选择 Run 'contextLoads()',运行单元测试程序,查看后台输出情况,结果如下图所示:

图 1 消息发送、接收单元测试的运行结果
通过上面的程序输出日志可以看到,消费者已经收到了生产者发送的消息并进行了处理。这是常用的简单使用示例。

图 2 消息发送、接收实体单元测试的运行结果
通过上面的示例成功实现了 RabbitMQ 发送和接收实体对象,使得消息的数据结构更加清晰,也更加贴合面向对象的编程思想。
RabbitMQ发送和接收消息
Spring Boot 提供了 spring-boot-starter-amqp 组件,只需要简单地配置即可与 Spring Boot 无缝集成。下面通过示例演示集成 RabbitMQ 实现消息的接收和发送:
1) 配置pom包
创建 Spring Boot 项目并在 pom.xml 文件中添加 spring-bootstarter-amqp 等相关组件依赖:<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-amqp</artifactId> </dependency>在上面的示例中,引入 Spring Boot 自带的 amqp 组件 spring-bootstarter-amqp。
2) 修改配置文件
修改 application.properties 配置文件,配置 rabbitmq 的 host 地址、端口以及账户信息:spring.rabbitmq.host=10.2.1.231 spring.rabbitmq.port=5672 spring.rabbitmq.username=zhangweizhong spring.rabbitmq.password=weizhong1988 spring.rabbitmq.virtualHost=order在上面的示例中,主要配置 RabbitMQ 服务的地址。RabbitMQ 配置由 spring.rabbitmq.* 配置属性控制。virtual-host 配置项指定 RabbitMQ 服务创建的虚拟主机,不过这个配置项不是必需的。
3) 创建消费者
消费者可以消费生产者发送的消息。接下来创建消费者类 Consumer,并使用 @RabbitListener 注解来指定消息的处理方法。示例代码如下:
@Component public class Consumer { @RabbitHandler @RabbitListener(queuesToDeclare = @Queue("rabbitmq_queue")) public void process(String message) { System.out.println("消费者消费消息111=====" + message); } }在上面的示例中,Consumer 消费者通过 @RabbitListener 注解创建侦听器端点,绑定 rabbitmq_queue 队列:
- @RabbitListener 注解提供了 @QueueBinding、@Queue、@Exchange 等对象,通过这个组合注解配置交换机、绑定路由并且配置监听功能等。
- @RabbitHandler 注解为具体接收的方法。
4) 创建生产者
生产者用来产生消息并进行发送,需要用到 RabbitTemplate 类。与之前的 RedisTemplate 类似,RabbitTemplate 是实现发送消息的关键类。示例代码如下:
@Component public class Producer { @Autowired private RabbitTemplate rabbitTemplate; public void produce() { String message = new Date() + "Beijing"; System.out.println("生产者产生消息=====" + message); rabbitTemplate.convertAndSend("rabbitmq_queue", message); } }如上面的示例所示,RabbitTemplate 提供了 convertAndSend 方法发送消息。convertAndSend 方法有 routingKey 和 message 两个参数:
- routingKey 为要发送的路由地址。
- message 为具体的消息内容。发送者和接收者的 queuename 必须一致,不然无法接收。
5) 运行测试
创建对应的测试类 ApplicationTests,验证消息发送和接收是否成功:@RunWith(SpringRunner.class) @SpringBootTest public class ApplicationTests { @Autowired Producer producer; @Test public void contextLoads() throws InterruptedException { producer.produce(); Thread.sleep(1*1000); } }在上面的示例中,首先注入生产者对象,然后调用 produce() 方法来发送消息。
最后,单击 Run Test 或在方法上右击,选择 Run 'contextLoads()',运行单元测试程序,查看后台输出情况,结果如下图所示:

图 1 消息发送、接收单元测试的运行结果
通过上面的程序输出日志可以看到,消费者已经收到了生产者发送的消息并进行了处理。这是常用的简单使用示例。
RabbitMQ发送和接收实体对象
Spring Boot 支持对象的发送和接收,且不需要额外的配置。下面通过一个例子来演示 RabbitMQ 发送和接收实体对象。1) 定义实体类
首先,定义发送与接收的对象实体 User 类,代码如下:public class User implements Serializable { public String name; public String password; // 省略get和set方法 }在上面的示例中,定义了普通的 User 实体对象。需要注意的是,实体类对象必须继承 Serializable 序列化接口,否则会报数据无法序列化的错误。
2) 定义消费者
修改 Consumer 类,将参数换成 User 对象。示例代码如下:@Component public class Consumer { @RabbitHandler @RabbitListener(queuesToDeclare = @Queue("rabbitmq_queue_object")) public void process(User user) { System.out.println("消费者消费消息111user=====name:" + user.getName()+",password:"+user.getPassword()); } }其实,消费者类和消息处理方法和之前的类似,只不过将参数换成了实体对象,监听 rabbitmq_queue_object 队列。
3) 定义生产者
修改 Producer 类,定义 User 实体对象,并通过 convertAndSend() 方法发送对象消息。示例代码如下:@Component public class Producer { @Autowired private RabbitTemplate rabbitTemplate; public void produce() { User user=new User(); user.setName("weiz"); user.setPassword("123456"); System.out.println("生产者生产消息111=====" + user); rabbitTemplate.convertAndSend("rabbitmq_queue_object", user); } }在上面的示例中,还是调用 convertAndSend() 方法发送实体对象。convertAndSend() 方法支持 String、Integer、Object 等基础的数据类型。
4) 验证测试
创建单元测试类,注入生产者对象,然后调用 produceObj() 方法发送实体对象消息,从而验证消息能否被成功接收。@RunWith(SpringRunner.class) @SpringBootTest public class ApplicationTests { @Autowired Producer producer; @Test public void testProduceObj() throws InterruptedException { producer.produceObj(); Thread.sleep(1*1000); } }最后,单击 Run Test 或在方法上右击,选择 Run 'contextLoads()',运行单元测试程序,查看后台输出情况,运行结果如下图所示:

图 2 消息发送、接收实体单元测试的运行结果
通过上面的示例成功实现了 RabbitMQ 发送和接收实体对象,使得消息的数据结构更加清晰,也更加贴合面向对象的编程思想。
相关文章
- SpringBoot集成Redis详解(附带实例)
- SpringBoot是什么?SpringBoot的优缺点有哪些?
- SpringBoot URL映射详解(附带实例)
- SpringBoot @PathVariable实现参数传递(附带实例)
- SpringBoot传递参数的5种方法(附带实例)
- SpringBoot @Scheduled定时任务详解(附带实例)
- SpringBoot Cron表达式的用法(新手必看)
- SpringBoot @Scheduled实现定时任务(附带实例)
- SpringBoot实现RabbitMQ简单队列(附带实例)
- SpringBoot是什么,SpringBoot简介(新手必看)