1 简介

  • 在Spring项目中，可以使用Spring-Rabbit去操作RabbitMQ。尤其是在SpringBoot项目中只需要引入对应的amqp的启动器依赖即可，可以很方便的使用RabbitTemplate发送消息，使用注解接收消息。
  • 一般的开发过程中：
  • SpringBoot整合RabbitMQ - 图1生产者工程：
    • ①application.yaml文件中配置RabbitMQ的相关信息。
    • ②在生产者工程中编写配置类，用于创建交换机和队列，并进行绑定。
    • ③注入RabbitTemplate对象，通过RabbitTemplate对象发送消息到交换机。
  • SpringBoot整合RabbitMQ - 图2消费者工程：
    • ①application.yaml文件配置RabbitMQ的相关信息。
    • ②创建消息处理类，用于接收队列中的消息并进行处理。

2 创建总工程

2.1 创建总工程

  • 略。

创建总工程.png

2.2 导入依赖

  • pom.xml
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <modelVersion>4.0.0</modelVersion>
  5.     <packaging>pom</packaging>
  6.     <modules>
  7.         <module>rabbitmq-producer</module>
  8.         <module>rabbitmq-consumer</module>
  9.     </modules>
  10.     <parent>
  11.         <groupId>org.springframework.boot</groupId>
  12.         <artifactId>spring-boot-starter-parent</artifactId>
  13.         <version>2.3.8.RELEASE</version>
  14.         <relativePath/>
  15.     </parent>
  16.     <groupId>com.example</groupId>
  17.     <artifactId>rabbitmq-demo</artifactId>
  18.     <version>1.0</version>
  19.     <name>rabbitmq-demo</name>
  21.     <properties>
  22.         <java.version>1.8</java.version>
  23.     </properties>
  24.     <dependencies>
  25.         <dependency>
  26.             <groupId>org.springframework.boot</groupId>
  27.             <artifactId>spring-boot-starter-amqp</artifactId>
  28.         </dependency>
  29.         <dependency>
  30.             <groupId>org.springframework.boot</groupId>
  31.             <artifactId>spring-boot-starter-web</artifactId>
  32.         </dependency>
  34.         <dependency>
  35.             <groupId>org.springframework.boot</groupId>
  36.             <artifactId>spring-boot-starter-test</artifactId>
  37.             <scope>test</scope>
  38.             <exclusions>
  39.                 <exclusion>
  40.                     <groupId>org.junit.vintage</groupId>
  41.                     <artifactId>junit-vintage-engine</artifactId>
  42.                 </exclusion>
  43.             </exclusions>
  44.         </dependency>
  45.         <dependency>
  46.             <groupId>org.springframework.amqp</groupId>
  47.             <artifactId>spring-rabbit-test</artifactId>
  48.             <scope>test</scope>
  49.         </dependency>
  50.     </dependencies>
  52.     <build>
  53.         <plugins>
  54.             <plugin>
  55.                 <groupId>org.springframework.boot</groupId>
  56.                 <artifactId>spring-boot-maven-plugin</artifactId>
  57.             </plugin>
  58.         </plugins>
  59.     </build>
  61. </project>

2.3 创建生产者和消费者工程

  • 略。

3 搭建生产者工程

3.1 创建工程

  • 略。

3.2 导入依赖

  • 略（父工程已经导入）。

3.3 启动类

  • 启动类：
  1. package com.xudaxian;
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.SpringBootApplication;
  6. /**
  7.  * @version 1.0
  8.  * @since 2021-02-04 22:11
  9.  */
  10. @SpringBootApplication
  11. public class ProducerApplication {
  12.     public static void main(String[] args) {
  13.         SpringApplication.run(ProducerApplication.class, args);
  14.     }
  15. }

3.4 配置RabbitMQ

3.4.1 配置文件

  • 创建application.yml文件，内容如下：
  1. server:
  2.   # 端口
  3.   port: 8888
  5. spring:
  6.   # RabbitMQ
  7.   rabbitmq:
  8.     host: 192.168.49.100
  9.     port: 5672
  10.     virtual-host: /xudaxian
  11.     username: xudaxian
  12.     password: 123456

3.4.2 绑定交换机和队列

  • 创建RabbitMQConfig.java文件，内容如下：
  1. package com.xudaxian.config;
  3. import org.springframework.amqp.core.*;
  4. import org.springframework.amqp.rabbit.connection.ConnectionFactory;
  5. import org.springframework.amqp.rabbit.core.RabbitAdmin;
  6. import org.springframework.beans.factory.annotation.Autowired;
  7. import org.springframework.context.annotation.Bean;
  8. import org.springframework.context.annotation.Configuration;
  10. /**
  11.  * @version 1.0
  12.  * @since 2021-02-05 08:45
  13.  */
  14. @Configuration
  15. public class RabbitMQConfig {
  16.     //交换机名称
  17.     public static String EXCHANGE_NAME = "xudaxian_topic_exchange";
  18.     //队列名称
  19.     public static String QUEUE_NAME = "xudaxian_queue";
  21.     //声明交换机
  22.     @Bean
  23.     public Exchange exchange() {
  24.         return ExchangeBuilder.topicExchange(EXCHANGE_NAME).durable(true).build();
  25.     }
  27.     //声明队列
  28.     @Bean
  29.     public Queue queue() {
  30.         return QueueBuilder.durable(QUEUE_NAME).build();
  31.     }
  33.     //绑定交换机和队列
  34.     @Bean
  35.     public Binding binding(@Autowired Queue queue, @Autowired Exchange exchange) {
  36.         return BindingBuilder.bind(queue).to(exchange).with("item.#").noargs();
  37.     }
  38.     /**
  39.      * 如果不配置RabbitAdmin，默认情况下，SpringBoot启动的时候是不会自动创建交换机和消息队列的，而是等到发送消息的时候
  40.      *
  41.      * @param connectionFactory
  42.      * @return
  43.      */
  44.     @Bean
  45.     public RabbitAdmin rabbitAdmin(ConnectionFactory connectionFactory) {
  46.         RabbitAdmin rabbitAdmin = new RabbitAdmin(connectionFactory);
  47.         //只有设置为true的时候，SpringBoot启动的时候会加载RabbitAdmin
  48.         rabbitAdmin.setAutoStartup(true);
  49.         rabbitAdmin.declareExchange(exchange());
  50.         rabbitAdmin.declareQueue(queue());
  51.         return rabbitAdmin;
  52.     }
  53. }

3.5 消息发送的Controller

  • 创建ProducerController.java文件，内容如下：
  1. package com.xudaxian.web;
  3. import com.xudaxian.config.RabbitMQConfig;
  4. import org.springframework.amqp.rabbit.core.RabbitTemplate;
  5. import org.springframework.beans.factory.annotation.Autowired;
  6. import org.springframework.web.bind.annotation.GetMapping;
  7. import org.springframework.web.bind.annotation.RequestParam;
  8. import org.springframework.web.bind.annotation.RestController;
  10. /**
  11.  * @version 1.0
  12.  * @since 2021-02-04 22:27
  13.  */
  14. @RestController
  15. public class ProducerController {
  17.     @Autowired
  18.     private RabbitTemplate rabbitTemplate;
  20.     /**
  21.      * @param msg        发送的消息
  22.      * @param routingKey 路由key
  23.      * @return
  24.      */
  25.     @GetMapping(value = "/sendMessage")
  26.     public String sendMessage(@RequestParam(value = "msg") String msg, @RequestParam(value = "routingKey") String routingKey) {
  28.         rabbitTemplate.convertAndSend(RabbitMQConfig.EXCHANGE_NAME, routingKey, msg);
  30.         return "发送消息成功";
  31.     }
  33. }

3.6 测试

4 搭建消费者工程

4.1 创建工程

  • 略。

4.2 导入依赖

  • 略（父工程已经导入）。

4.3 启动类

  • 启动类：
  1. package com.xudaxian;
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.SpringBootApplication;
  6. /**
  7.  * @version 1.0
  8.  * @since 2021-02-04 22:40
  9.  */
  10. @SpringBootApplication
  11. public class ConsumerApplication {
  12.     public static void main(String[] args) {
  13.         SpringApplication.run(ConsumerApplication.class, args);
  14.     }
  15. }

4.4 配置RabbitMQ

  • 创建application.yml文件，内容如下：
  1. server:
  2.   # 端口
  3.   port: 8889
  5. spring:
  6.   # RabbitMQ
  7.   rabbitmq:
  8.     host: 192.168.49.100
  9.     port: 5672
  10.     virtual-host: /xudaxian
  11.     username: xudaxian
  12.     password: 123456
  • 创建RabbitMQConfig.java文件，内容如下:
  1. package com.xudaxian.config;
  3. import org.springframework.amqp.core.Queue;
  4. import org.springframework.amqp.core.QueueBuilder;
  5. import org.springframework.amqp.rabbit.connection.ConnectionFactory;
  6. import org.springframework.amqp.rabbit.core.RabbitAdmin;
  7. import org.springframework.context.annotation.Bean;
  8. import org.springframework.context.annotation.Configuration;
  10. /**
  11.  * @version 1.0
  12.  * @since 2021-02-06 10:55
  13.  */
  14. @Configuration
  15. public class RabbitMQConfig {
  16.     public static String QUEUE_NAME = "xudaxian_queue";
  18.     @Bean
  19.     public Queue queue() {
  20.         return QueueBuilder.durable(QUEUE_NAME).build();
  21.     }
  23.     /**
  24.      * 如果不配置RabbitAdmin，默认情况下，SpringBoot启动的时候是不会自动创建交换机和消息队列的，而是等到发送消息的时候
  25.      *
  26.      * @param connectionFactory
  27.      * @return
  28.      */
  29.     @Bean
  30.     public RabbitAdmin rabbitAdmin(ConnectionFactory connectionFactory) {
  31.         RabbitAdmin rabbitAdmin = new RabbitAdmin(connectionFactory);
  32.         //只有设置为true的时候，SpringBoot启动的时候会加载RabbitAdmin
  33.         rabbitAdmin.setAutoStartup(true);
  34.         rabbitAdmin.declareQueue(queue());
  35.         return rabbitAdmin;
  36.     }
  37. }

4.5 消息监听处理类

  • 创建RabbitMQListener.java文件，内容如下：
  1. package com.xudaxian.listener;
  3. import org.springframework.amqp.rabbit.annotation.RabbitListener;
  4. import org.springframework.stereotype.Component;
  6. /**
  7.  * @version 1.0
  8.  * @since 2021-02-04 23:06
  9.  */
  10. @Component
  11. public class RabbitMQListener {
  13.     @RabbitListener(queues = "xudaxian_queue")
  14.     public void listener(String message) {
  15.         System.out.println("消费者接受到的消息：" + message);
  16.     }
  17. }