Spring Boot - 简单地使用 RabbitMQ

环境

操作系统：

Windows 10 x64

集成开发环境：

Spring Tool Suite 4 
Version: 4.14.0.RELEASE
Build Id: 202203131612

RabbitMQ 版本信息：

$ rabbitmqctl status | grep version
RabbitMQ version: 3.8.9

准备

在 CentOS 7 中安装 RabbitMQ 3.8.9

RabbitMQ - 最简单的消息模型 “Hello World“

简单使用 RabbitMQ

项目结构

配置

在 pom.xml 配置文件中，主要引入 amqp 依赖（第 24 ~ 27 行）：

<?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 https://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.6.6</version>
        <relativePath /> <!-- lookup parent from repository -->
    </parent>
    
    <groupId>com.mk</groupId>
    <artifactId>Spring-Boot-RabbitMQ</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>Spring-Boot-RabbitMQ</name>
    <description>Demo project for Spring Boot</description>
    
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-amqp</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.amqp</groupId>
            <artifactId>spring-rabbit-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

在 application.yml 配置文件中，添加 RabbitMQ 服务参数：

spring:
  rabbitmq:
    host: 192.168.88.158
    port: 5672
    virtual-host: /mail
    username: mail
    password: 123

编码 & 测试

创建生产者：

package com.mk.mq;

import org.springframework.amqp.rabbit.core.RabbitTemplate;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component
public class RabbitMQProducer {
    
    @Autowired
    private RabbitTemplate rabbitTemplate;

    
    public void send(Object message) {
        
        /* 
         * Convert a Java object to an Amqp Message 
         * and send it to a default exchange 
         * with a specific routing key. 
         */
        rabbitTemplate.convertAndSend("mail", message);
    }
}

创建消费者：

package com.mk.mq;

import org.springframework.amqp.rabbit.annotation.Queue;
import org.springframework.amqp.rabbit.annotation.RabbitHandler;
import org.springframework.amqp.rabbit.annotation.RabbitListener;
import org.springframework.stereotype.Component;

@Component
@RabbitListener(queuesToDeclare = @Queue(name = "mail"))
public class RabbitMQConsumer {

    @RabbitHandler
    public void handler(Object message) {
        System.out.println("RabbitMQConsumer.handler(): " + message);
    }

//    @RabbitHandler
//    public void handler(String message) {
//        System.out.println("RabbitMQConsumer.handler(): " + message);
//    }
}

修改测试类，在其中调用生产者：

package com.mk;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import com.mk.mq.RabbitMQProducer;

@SpringBootTest
class SpringBootRabbitMqApplicationTests {
    
    @Autowired
    private RabbitMQProducer rabbitMQProducer;
    
    
    @Test
    void contextLoads() {
        rabbitMQProducer.send("Hello World!");
    }
}

控制台输出：

RabbitMQConsumer.handler(): (Body:'Hello World!' MessageProperties [headers={}, contentType=text/plain, contentEncoding=UTF-8, contentLength=0, receivedDeliveryMode=PERSISTENT, priority=0, redelivered=false, receivedExchange=, receivedRoutingKey=mail, deliveryTag=1, consumerTag=amq.ctag-ZYy9VKZu9naawp7mJ8dD5Q, consumerQueue=mail])

参考

Spring Boot(八)：RabbitMQ 详解