SpringBoot整合RabbitMQ示例詳解

更新時(shí)間：2023年07月12日 08:35:54 作者：卑微小鐘

這篇文章主要介紹了SpringBoot整合RabbitMQ示例詳解,RabbitMQ是一個(gè)實(shí)現(xiàn)了AMQP高級(jí)消息隊(duì)列協(xié)議的消息隊(duì)列服務(wù)，用Erlang語(yǔ)言。是面向消息的中間件,需要的朋友可以參考下

SpringBoot整合RabbitMQ

1.生產(chǎn)者SpringBootProducer

1.1 創(chuàng)建工程并導(dǎo)入依賴

我們使用的springboot版本為2.5.6，其他都是根據(jù)spring-boot-starter-parent自動(dòng)選擇版本

引入以下工程即可

spring-boot-starter-test 用于測(cè)試
junit 用于單元測(cè)試
spring-boot-starter-amqp SpringBoot和RabbitMQ的整合方案

<?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.5.6</version>
        <relativePath/>
    </parent>
    <artifactId>springboot-producer</artifactId>
    <version>1.0-SNAPSHOT</version>
    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-amqp</artifactId>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>

1.2 創(chuàng)建配置文件并配置

SpringBoot配置文件名稱為application.yml

需要配置的內(nèi)容如下：

# 配置RabbitMQ的基本信息
spring:
  rabbitmq:
    # 地址
    host: 192.168.52.128
    # 端口
    port: 5672
    # 用戶名
    username: admin
    # 密碼
    password: admin
    # 虛擬機(jī)
    virtual-host: /test

1.3 創(chuàng)建項(xiàng)目啟動(dòng)類

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

1.4 創(chuàng)建RabbitMQ配置類

@Configuration
public class RabbitMQConfig {
	// 配置代碼都寫在這里
}

（1）設(shè)置默認(rèn)的交換機(jī)的名稱和隊(duì)列名稱

/**
 * 默認(rèn)測(cè)試的交換機(jī)機(jī)名稱
 * springboot_topic_exchange
 */
public static final String EXCHANGE_NAME = "springboot_topic_exchange";
/**
 * 默認(rèn)的隊(duì)列名稱
 * springboot_root_queue
 */
public static final String QUEUE_NAME = "springboot_root_queue";

（2）創(chuàng)建通配符類型的交換機(jī)

/**
 * 創(chuàng)建交換機(jī)
 *
 * @return 交換機(jī)
 */
@Bean("bootExchange")
public Exchange bootExchange() {
    // 創(chuàng)建一個(gè)通配符的交換機(jī)
    return ExchangeBuilder.topicExchange(EXCHANGE_NAME).durable(true).build();
}

這里需要在bean上加上名稱（雖然如果沒有時(shí)會(huì)使用方法名，但是嚴(yán)謹(jǐn)），便于之后交換機(jī)和隊(duì)列綁定操作。

除了通配符交換機(jī)外，還支持廣播型交換機(jī)、定向型交換機(jī)。

廣播型交換機(jī)

/**
 * 創(chuàng)建交換機(jī)
 *
 * @return 交換機(jī)
 */
@Bean("bootExchange")
public Exchange bootExchange() {
    // 創(chuàng)建一個(gè)通配符的交換機(jī)
    return ExchangeBuilder.topicExchange(EXCHANGE_NAME).durable(true).build();
}

定向型交換機(jī)

@Bean("directExchange")
public Exchange directExchange() {
    return ExchangeBuilder.directExchange("direct_exchange").durable(true).build();
}

（3）創(chuàng)建一個(gè)隊(duì)列

/**
 * 創(chuàng)建隊(duì)列
 *
 * @return 隊(duì)列
 */
@Bean("bootQueue")
public Queue bootQueue() {
    return QueueBuilder.durable(QUEUE_NAME).build();
}

（4）綁定交換機(jī)和隊(duì)列

/**
 * 綁定隊(duì)列和交換機(jī)
 * 主要：隊(duì)列、交換機(jī)、routing key
 *
 * @return 綁定關(guān)系
 */
@Bean
public Binding bindingQueueExchange(@Qualifier("bootQueue") Queue queue, @Qualifier("bootExchange") Exchange exchange) {
    return BindingBuilder.bind(queue).to(exchange).with("boot.#").noargs();
}

（5）完整配置類

@Configuration
public class RabbitMQConfig {
    /**
     * 默認(rèn)測(cè)試的交換機(jī)機(jī)名稱
     * springboot_topic_exchange
     */
    public static final String EXCHANGE_NAME = "springboot_topic_exchange";
    /**
     * 默認(rèn)的隊(duì)列名稱
     * springboot_root_queue
     */
    public static final String QUEUE_NAME = "springboot_root_queue";
    /**
     * 創(chuàng)建交換機(jī)
     *
     * @return 交換機(jī)
     */
    @Bean("bootExchange")
    public Exchange bootExchange() {
        // 創(chuàng)建一個(gè)通配符的交換機(jī)
        return ExchangeBuilder.topicExchange(EXCHANGE_NAME).durable(true).build();
    }
    /**
     * 創(chuàng)建隊(duì)列
     *
     * @return 隊(duì)列
     */
    @Bean("bootQueue")
    public Queue bootQueue() {
        return QueueBuilder.durable(QUEUE_NAME).build();
    }
    /**
     * 綁定隊(duì)列和交換機(jī)
     * 主要：隊(duì)列、交換機(jī)、routing key
     *
     * @return 綁定關(guān)系
     */
    @Bean
    public Binding bindingQueueExchange(@Qualifier("bootQueue") Queue queue, @Qualifier("bootExchange") Exchange exchange) {
        return BindingBuilder.bind(queue).to(exchange).with("boot.#").noargs();
    }
}

1.5 測(cè)試發(fā)送消息

@SpringBootTest
@RunWith(SpringRunner.class)
public class ProducerTest {
    @Autowired
    private RabbitTemplate rabbitTemplate;
    @Test
    public void testSend() {
        rabbitTemplate.convertAndSend(RabbitMQConfig.EXCHANGE_NAME, "boot.name", "Spring Boot RabbitMQ");
    }
}

2.消費(fèi)者SpringBootConsumer

2.1 創(chuàng)建工程并導(dǎo)入依賴

&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;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 https://maven.apache.org/xsd/maven-4.0.0.xsd"&gt;
    &lt;modelVersion&gt;4.0.0&lt;/modelVersion&gt;
    &lt;parent&gt;
        &lt;groupId&gt;org.springframework.boot&lt;/groupId&gt;
        &lt;artifactId&gt;spring-boot-starter-parent&lt;/artifactId&gt;
        &lt;version&gt;2.5.6&lt;/version&gt;
        &lt;relativePath/&gt; &lt;!-- lookup parent from repository --&gt;
    &lt;/parent&gt;
    &lt;groupId&gt;com.example&lt;/groupId&gt;
    &lt;artifactId&gt;springboot-consumer&lt;/artifactId&gt;
    &lt;version&gt;0.0.1-SNAPSHOT&lt;/version&gt;
    &lt;name&gt;springboot-consumer&lt;/name&gt;
    &lt;description&gt;springboot-consumer&lt;/description&gt;
    &lt;properties&gt;
        &lt;java.version&gt;1.8&lt;/java.version&gt;
    &lt;/properties&gt;
    &lt;dependencies&gt;
        &lt;dependency&gt;
            &lt;groupId&gt;org.springframework.boot&lt;/groupId&gt;
            &lt;artifactId&gt;spring-boot-starter-amqp&lt;/artifactId&gt;
        &lt;/dependency&gt;
        &lt;dependency&gt;
            &lt;groupId&gt;org.springframework.boot&lt;/groupId&gt;
            &lt;artifactId&gt;spring-boot-starter-test&lt;/artifactId&gt;
            &lt;scope&gt;test&lt;/scope&gt;
        &lt;/dependency&gt;
        &lt;dependency&gt;
            &lt;groupId&gt;org.springframework.amqp&lt;/groupId&gt;
            &lt;artifactId&gt;spring-rabbit-test&lt;/artifactId&gt;
            &lt;scope&gt;test&lt;/scope&gt;
        &lt;/dependency&gt;
    &lt;/dependencies&gt;
    &lt;build&gt;
        &lt;plugins&gt;
            &lt;plugin&gt;
                &lt;groupId&gt;org.springframework.boot&lt;/groupId&gt;
                &lt;artifactId&gt;spring-boot-maven-plugin&lt;/artifactId&gt;
            &lt;/plugin&gt;
        &lt;/plugins&gt;
    &lt;/build&gt;
&lt;/project&gt;

PS:以上依賴是由springboot工程創(chuàng)建完成，和之前手動(dòng)創(chuàng)建沒有本質(zhì)差別

2.2 創(chuàng)建配置文件并配置

SpringBoot配置文件名稱為application.yml

需要配置的內(nèi)容如下：

# 配置RabbitMQ的基本信息
spring:
  rabbitmq:
    # 地址
    host: 192.168.52.128
    # 端口
    port: 5672
    # 用戶名
    username: admin
    # 密碼
    password: admin
    # 虛擬機(jī)
    virtual-host: /test

2.3 創(chuàng)建項(xiàng)目啟動(dòng)類

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

2.3 創(chuàng)建監(jiān)聽器

@Component
public class RabbitMQListener {
    @RabbitListener(queues = "springboot_root_queue")
    public void listenerQueue(Message message) {
        System.out.println("RabbitMQListener:" + new String(message.getBody()));
    }
}