Day10_06_消息队列之SpringBoot结合RabbitMQ使用教程

朴灿烈づ我的快乐病毒、 2024-01-20 08:10 14阅读 0赞

## SpirngBoot结合RabbitMQ使用教程 ##

### 一. 创建项目 ###

创建一个新的项目,整个项目目录结构如下  
![Image 1][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70][]

#### 1. 父项目的pom.xml文件 ####

<?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>
        <groupId>com.syc.boot</groupId>
        <artifactId>Day12_boot_amqp</artifactId>
        <packaging>pom</packaging>
        <version>1.0-SNAPSHOT</version>
    
        <modules>
            <module>amqp-producer</module>
            <module>amqp-consumer</module>
            <module>amqp-commons</module>
        </modules>
    
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>1.5.12.RELEASE</version>
            <relativePath/> 
        </parent>
    
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
            <encoding>UTF-8</encoding>
            <java.version>1.8</java.version>
            <maven.compiler.source>1.8</maven.compiler.source>
            <maven.compiler.target>1.8</maven.compiler.target>
    
            <mysql.version>5.0.7</mysql.version>
            <mybatis.boot.version>1.3.1</mybatis.boot.version>
            <lombok.version>1.16.20</lombok.version>
        </properties>
    
        <dependencies>
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
    
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-amqp</artifactId>
            </dependency>
    
            
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>${lombok.version}</version>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
        </dependencies>
    
        <build>
            <pluginManagement>
                <plugins>
                    <plugin>
                        <groupId>org.springframework.boot</groupId>
                        <artifactId>spring-boot-maven-plugin</artifactId>
                        <version>${spring-boot.version}</version>
                    </plugin>
                    <plugin>
                        <artifactId>maven-compiler-plugin</artifactId>
                        <configuration>
                            <target>${java.version}</target>
                            <source>${java.version}</source>
                            <encoding>UTF-8</encoding>
                        </configuration>
                    </plugin>
                </plugins>
            </pluginManagement>
        </build>
    
    </project>

### 二. 创建消息生产者模块 ###

#### 1. 创建项目模块 ####

创建一个名为 `amqp-producer` 的消息生产者模块.  
该模块的目录结构为:  
![Image 1][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 1][]

#### 2. application.yml ####

spring:
      application:
        name: amqp-producer
      rabbitmq:
        host: localhost
        port: 5672
        username: guest
        password: guest

#### 3. 创建队列配置 ####

package com.syc.boot.config;
    
    import org.springframework.amqp.core.Queue;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    
    /**
     * 4种交换机之一:
     * 直接型交换机,也是默认的交换机.
     */
    @Configuration
    public class DirectRabbitMQConfig {
    
        //交换机和队列要进行绑定:
        //默认的交换机是DirectExchange,
        //每个交换机都需要利用路由键来和队列绑定在一起.
        //如果采用的是DirectExchange交换机,默认情况下,队里的名字就是路由键的名字.
        //该交换机是一对一的,一个消息被发送者发送出去之后,只能被一个消费者接受.
        @Bean
        public Queue queue(){
            //firstRabbit,是队列的名字,
            return new Queue("firstRabbit");
        }
    
        @Bean
        public Queue objectQueue(){
            //firstRabbit,是队列的名字,
            return new Queue("firstObject");
        }
    }

#### 3. 创建消息提供者 ####

package com.syc.boot;
    
    import com.syc.boot.domain.User;
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.amqp.core.AmqpTemplate;
    import org.springframework.amqp.core.Message;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Component;
    
    import java.util.Date;
    
    /**
     *
     */
    @Slf4j
    @Component
    public class FirstRabbitProducer {
    
        @Autowired
        private AmqpTemplate template;
    
        public void sendMsg() {
            //Message msg=new Message();
            //template.send(msg);
    
            //第一个参数是路由键
            String content="hello,"+new Date();
            log.warn("消息发送--->content={}",content);
            template.convertAndSend("firstRabbit", content);
        }
    
        //发送对象
        public void sendUser() {
            User user=new User();
            user.setId("1");
            user.setUsername("syc");
            user.setPassword("123");
            log.warn("消息发送--->User={}",user.toString());
            template.convertAndSend("firstObject", user);
        }
    
    }

#### 4. 创建测试用例 ####

package com.syc.boot;
    
    import org.junit.Test;
    import org.junit.runner.RunWith;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.test.context.junit4.SpringRunner;
    
    /**
     *
     */
    @RunWith(SpringRunner.class)
    @SpringBootTest(classes = ProviderApplication.class)
    public class FirstRabbitTest {
    
        @Autowired
        private FirstRabbitProducer producer;
    
        @Test
        public void firstSendTest() {
            for (int i = 0; i < 10; i++) {
                producer.sendMsg();
            }
        }
    
     }

#### 5. 项目入口类 ####

package com.syc.boot;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    public class ProviderApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(ProviderApplication.class, args);
        }
    }

#### 6. 启动测试类 ####

执行测试类中的firstSendTest()测试方法.看到控制台打印如下日志.  
![Image 1][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 2][]

并且此时RabbitMQ中的firstRabbit队列中有10条待消费的消息.  
![Image 1][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 3][]

### 三. 创建消息消费者模块 ###

#### 1. 创建消费者模块 ####

创建一个名为 `amqp-consumer` 的消费者模块.  
项目结构图:  
![Image 1][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 4][]

#### 2. application.yml ####

spring:
      application:
        name: amqp-consumer
      rabbitmq:
        host: localhost
        port: 5672
        username: guest
        password: guest

#### 3. 创建消息消费者 ####

package com.syc.boot.msg;
    
    import com.syc.boot.domain.User;
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.amqp.rabbit.annotation.RabbitHandler;
    import org.springframework.amqp.rabbit.annotation.RabbitListener;
    import org.springframework.stereotype.Component;
    
    /**
     *
     */
    @Slf4j
    @Component
    public class FirstRabbitConsumer {
    
        @RabbitListener(queues = "firstRabbit")
        @RabbitHandler
        public void receiveMsg(String msg) {
            log.warn("接受消息---->content:{}", msg);
        }
        
    }

#### 4. 项目入口类 ####

package com.syc.boot;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    public class ConsumerApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(ConsumerApplication.class, args);
        }
    }

#### 5. 启动项目,接收消息 ####

项目启动后,可以看到控制台打印如下消息  
![Image 1][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 5][]

同时RabbitMQ控制台中firstRabbit队列中的消息全部消费掉,消息数量为0.  
![Image 1][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 6][]

[Image 1]: 
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/20/fcb23630b8094078ae00738ac7331f1a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/20/ab7c9dba03a044b8be94e1ce119783fa.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/20/6ea86219af90452f9867eecd0fb0c129.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/20/fe746b40ab75491884406211eac8fe2a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/20/d07b68d3cbac42929d4a467817e6b2d0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/20/e96a05bf27774e63b2e09c6188d4ad0b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 6]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/20/9f701797da1348139d6057aa46d1f56d.png