Spring整合RabbitMQ


一、Spring整合RabbitMQ

1、创建生产者工程

(1)依赖

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-context</artifactId>
    <version>5.1.7.RELEASE</version>
</dependency>

<dependency>
    <groupId>org.springframework.amqp</groupId>
    <artifactId>spring-rabbit</artifactId>
    <version>2.1.8.RELEASE</version>
</dependency>

<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.12</version>
</dependency>

 <dependency>
           <groupId>org.springframework</groupId>
       <artifactId>spring-test</artifactId>
       <version>5.1.7.RELEASE</version>
 </dependency>

(2)配置

  1. 创建src\main\resources\properties\rabbitmq.properties`连接参数等配置文件

    rabbitmq.host=主机ip地址
    rabbitmq.port=5672
    # 连接用户及密码
    rabbitmq.username=rewind
    rabbitmq.password=rewind
    # 虚拟主机
    rabbitmq.virtual-host=/rewind
  2. 创建src\main\resources\spring\spring-rabbitmq.xml` 整合配置文件

    <?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:context="http://www.springframework.org/schema/context"
        xmlns:rabbit="http://www.springframework.org/schema/rabbit"
        xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        https://www.springframework.org/schema/context/spring-context.xsd
        http://www.springframework.org/schema/rabbit
        http://www.springframework.org/schema/rabbit/spring-rabbit.xsd">
     <!--加载配置文件-->
     <context:property-placeholder location="classpath:properties/rabbitmq.properties"/>
    
     <!-- 定义rabbitmq connectionFactory -->
     <rabbit:connection-factory id="connectionFactory" host="${rabbitmq.host}"
                                port="${rabbitmq.port}"
                                username="${rabbitmq.username}"
                                password="${rabbitmq.password}"
                                virtual-host="${rabbitmq.virtual-host}"/>
     <!--定义管理交换机、队列-->
     <rabbit:admin connection-factory="connectionFactory"/>
    
     <!--定义持久化队列,不存在则自动创建;不绑定到交换机则绑定到默认交换机
     默认交换机类型为direct,名字为:"",路由键为队列的名称
     -->
     <rabbit:queue id="spring_queue" name="spring_queue" auto-declare="true"/>
    
     <!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~广播;所有队列都能收到消息~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
     <!--定义广播交换机中的持久化队列,不存在则自动创建-->
     <rabbit:queue id="spring_fanout_queue_1" name="spring_fanout_queue_1" auto-declare="true"/>
    
     <!--定义广播交换机中的持久化队列,不存在则自动创建-->
     <rabbit:queue id="spring_fanout_queue_2" name="spring_fanout_queue_2" auto-declare="true"/>
    
     <!--定义广播类型交换机;并绑定上述两个队列-->
     <rabbit:fanout-exchange id="spring_fanout_exchange" name="spring_fanout_exchange" auto-declare="true">
         <rabbit:bindings>
             <rabbit:binding queue="spring_fanout_queue_1"/>
             <rabbit:binding queue="spring_fanout_queue_2"/>
         </rabbit:bindings>
     </rabbit:fanout-exchange>
    
     <!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~通配符;*匹配一个单词,#匹配多个单词 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
     <!--定义广播交换机中的持久化队列,不存在则自动创建-->
     <rabbit:queue id="spring_topic_queue_star" name="spring_topic_queue_star" auto-declare="true"/>
     <!--定义广播交换机中的持久化队列,不存在则自动创建-->
     <rabbit:queue id="spring_topic_queue_well" name="spring_topic_queue_well" auto-declare="true"/>
     <!--定义广播交换机中的持久化队列,不存在则自动创建-->
     <rabbit:queue id="spring_topic_queue_well2" name="spring_topic_queue_well2" auto-declare="true"/>
    
     <rabbit:topic-exchange id="spring_topic_exchange" name="spring_topic_exchange" auto-declare="true">
         <rabbit:bindings>
             <rabbit:binding pattern="heima.*" queue="spring_topic_queue_star"/>
             <rabbit:binding pattern="heima.#" queue="spring_topic_queue_well"/>
             <rabbit:binding pattern="itcast.#" queue="spring_topic_queue_well2"/>
         </rabbit:bindings>
     </rabbit:topic-exchange>
    
     <!--定义rabbitTemplate对象操作可以在代码中方便发送消息-->
     <rabbit:template id="rabbitTemplate" connection-factory="connectionFactory"/>
    </beans>

    (3)发送消息

    创建测试文件src\test\java\com\itheima\rabbitmq\ProducerTest.java

    @RunWith(SpringJUnit4ClassRunner.class)
    @ContextConfiguration(locations = "classpath:spring/spring-rabbitmq.xml")
    public class ProducerTest {
    
     @Autowired
     private RabbitTemplate rabbitTemplate;
    
     /**
      * 只发队列消息
      * 默认交换机类型为 direct
      * 交换机的名称为空,路由键为队列的名称
      */
     @Test
     public void queueTest(){
         //路由键与队列同名
         rabbitTemplate.convertAndSend("spring_queue", "只发队列spring_queue的消息。");
     }
    
     /**
      * 发送广播
      * 交换机类型为 fanout
      * 绑定到该交换机的所有队列都能够收到消息
      */
     @Test
     public void fanoutTest(){
         /**
          * 参数1:交换机名称
          * 参数2:路由键名(广播设置为空)
          * 参数3:发送的消息内容
          */
         rabbitTemplate.convertAndSend("spring_fanout_exchange", "", "发送到spring_fanout_exchange交换机的广播消息");
     }
    
     /**
      * 通配符
      * 交换机类型为 topic
      * 匹配路由键的通配符,*表示一个单词,#表示多个单词
      * 绑定到该交换机的匹配队列能够收到对应消息
      */
     @Test
     public void topicTest(){
         /**
          * 参数1:交换机名称
          * 参数2:路由键名
          * 参数3:发送的消息内容
          */
         rabbitTemplate.convertAndSend("spring_topic_exchange", "heima.bj", "发送到spring_topic_exchange交换机heima.bj的消息");
         rabbitTemplate.convertAndSend("spring_topic_exchange", "heima.bj.1", "发送到spring_topic_exchange交换机heima.bj.1的消息");
         rabbitTemplate.convertAndSend("spring_topic_exchange", "heima.bj.2", "发送到spring_topic_exchange交换机heima.bj.2的消息");
         rabbitTemplate.convertAndSend("spring_topic_exchange", "itcast.cn", "发送到spring_topic_exchange交换机itcast.cn的消息");
     }
    }

    2、创建消费者工程

    (1)依赖

    <dependency>
          <groupId>org.springframework</groupId>
          <artifactId>spring-context</artifactId>
          <version>5.1.7.RELEASE</version>
    </dependency>
    
org.springframework.amqp spring-rabbit 2.1.8.RELEASE ``` ### (2)配置 1. src\main\resources\properties\rabbitmq.properties`连接参数等配置文件; 同上
  1. src\main\resources\spring\spring-rabbitmq.xml` 整合配置文件;

    <?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:context="http://www.springframework.org/schema/context"
        xmlns:rabbit="http://www.springframework.org/schema/rabbit"
        xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        https://www.springframework.org/schema/context/spring-context.xsd
        http://www.springframework.org/schema/rabbit
        http://www.springframework.org/schema/rabbit/spring-rabbit.xsd">
     <!--加载配置文件-->
     <context:property-placeholder location="classpath:properties/rabbitmq.properties"/>
    
     <!-- 定义rabbitmq connectionFactory -->
     <rabbit:connection-factory id="connectionFactory" host="${rabbitmq.host}"
                                port="${rabbitmq.port}"
                                username="${rabbitmq.username}"
                                password="${rabbitmq.password}"
                                virtual-host="${rabbitmq.virtual-host}"/>
    
     <bean id="springQueueListener" class="com.itheima.rabbitmq.listener.SpringQueueListener"/>
     <bean id="fanoutListener1" class="com.itheima.rabbitmq.listener.FanoutListener1"/>
     <bean id="fanoutListener2" class="com.itheima.rabbitmq.listener.FanoutListener2"/>
     <bean id="topicListenerStar" class="com.itheima.rabbitmq.listener.TopicListenerStar"/>
     <bean id="topicListenerWell" class="com.itheima.rabbitmq.listener.TopicListenerWell"/>
     <bean id="topicListenerWell2" class="com.itheima.rabbitmq.listener.TopicListenerWell2"/>
    
     <rabbit:listener-container connection-factory="connectionFactory" auto-declare="true">
         <rabbit:listener ref="springQueueListener" queue-names="spring_queue"/>
         <rabbit:listener ref="fanoutListener1" queue-names="spring_fanout_queue_1"/>
         <rabbit:listener ref="fanoutListener2" queue-names="spring_fanout_queue_2"/>
         <rabbit:listener ref="topicListenerStar" queue-names="spring_topic_queue_star"/>
         <rabbit:listener ref="topicListenerWell" queue-names="spring_topic_queue_well"/>
         <rabbit:listener ref="topicListenerWell2" queue-names="spring_topic_queue_well2"/>
     </rabbit:listener-container>
    </beans>

    (3)消息监听器

    创建com\rewind\rabbitmq\listener\SpringQueueListener.java

    public class SpringQueueListener implements MessageListener {
     public void onMessage(Message message) {
         try {
             String msg = new String(message.getBody(), "utf-8");
    
             System.out.printf("接收路由名称为:%s,路由键为:%s,队列名为:%s的消息:%s \n",
                     message.getMessageProperties().getReceivedExchange(),
                     message.getMessageProperties().getReceivedRoutingKey(),
                     message.getMessageProperties().getConsumerQueue(),
                     msg);
         } catch (Exception e) {
             e.printStackTrace();
         }
     }
    }

二、Spring Boot整合RabbitMQ

在Spring项目中,可以使用Spring-Rabbit去操作RabbitMQ
https://github.com/spring-projects/spring-amqp

尤其是在spring boot项目中只需要引入对应的amqp启动器依赖即可,方便的使用RabbitTemplate发送消息,使用注解接收消息。

一般在开发过程中

生产者工程:

  1. application.yml文件配置RabbitMQ相关信息;

  2. 在生产者工程中编写配置类,用于创建交换机和队列,并进行绑定

  3. 注入RabbitTemplate对象,通过RabbitTemplate对象发送消息到交换机

消费者工程:

  1. application.yml文件配置RabbitMQ相关信息

  2. 创建消息处理类,用于接收队列中的消息并进行处理

1、生产者工程

(1)依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.4.RELEASE</version>
    </parent>
    <groupId>com.itheima</groupId>
    <artifactId>springboot-rabbitmq-producer</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-amqp</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
        </dependency>
    </dependencies>
</project>

(2)启动类

@SpringBootApplication
public class ProducerApplication {
    public static void main(String[] args) {
        SpringApplication.run(ProducerApplication.class);
    }
}

(3)配置RabbitMQ

 ① 配置文件application.yml

spring:
  rabbitmq:
    host: localhost
    port: 5672
    virtual-host: /rewind
    username: rewind
    password: rewind

 ② 绑定交换机和队列

创建配置类com.rewind.rabbitmq.config.RabbitMQConfig

@Configuration
public class RabbitMQConfig {
    //交换机名称
    public static final String ITEM_TOPIC_EXCHANGE = "item_topic_exchange";
    //队列名称
    public static final String ITEM_QUEUE = "item_queue";

    //声明交换机
    @Bean("itemTopicExchange")
    public Exchange topicExchange(){
        return ExchangeBuilder.topicExchange(ITEM_TOPIC_EXCHANGE).durable(true).build();
    }

    //声明队列
    @Bean("itemQueue")
    public Queue itemQueue(){
        return QueueBuilder.durable(ITEM_QUEUE).build();
    }

    //绑定队列和交换机
    @Bean
    public Binding itemQueueExchange(@Qualifier("itemQueue") Queue queue,
                                     @Qualifier("itemTopicExchange") Exchange exchange){
        return BindingBuilder.bind(queue).to(exchange).with("item.#").noargs();
    }

}

2、消费者工程

(1)依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.4.RELEASE</version>
    </parent>
    <groupId>com.itheima</groupId>
    <artifactId>springboot-rabbitmq-consumer</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-amqp</artifactId>
        </dependency>
    </dependencies>

</project>

(2)启动类,同生产者

(3)配置RabbitMQ

创建applicationyml配置文件,内容同生产者

(4)消息监听处理类

com.rewind.rabbitmq.listener.MyListener

@Component
public class MyListener {

    /**
     * 监听某个队列的消息
     * @param message 接收到的消息
     */
    @RabbitListener(queues = "item_queue")
    public void myListener1(String message){
        System.out.println("消费者接收到的消息为:" + message);
    }
}

(5)测试类

@RunWith(SpringRunner.class)
@SpringBootTest
public class RabbitMQTest {

    @Autowired
    private RabbitTemplate rabbitTemplate;

    @Test
    public void test(){
        rabbitTemplate.convertAndSend(RabbitMQConfig.ITEM_TOPIC_EXCHANGE, "item.insert", "商品新增,routing key 为item.insert");
        rabbitTemplate.convertAndSend(RabbitMQConfig.ITEM_TOPIC_EXCHANGE, "item.update", "商品修改,routing key 为item.update");
        rabbitTemplate.convertAndSend(RabbitMQConfig.ITEM_TOPIC_EXCHANGE, "item.delete", "商品删除,routing key 为item.delete");
    }
}

先运行上述测试程序(交换机和队列才能先被声明和绑定),然后启动消费者;在消费者工程springboot-rabbitmq-consumer中控制台查看是否接收到对应消息。


  目录