Spring 项目集成 RabbitMQ 及自动创建队列

Java
留言

   简单记录 Spring 项目集成 RabbitMQ 的过程，重点记录生产者项目自动创建队列的操作，因该问题给项目带来很多麻烦。

   本文内容分别在 Spring(V5.2.6)和 Spring Boot(V2.5.14)两个项目中经过了验证，下述示例代码来自于 SpringBoot 项目，迁移到 Spring 项目中需稍微调整。

一、Spring Boot 集成 RabbitMQ

1. 在 Maven 中加入依赖

Spring 项目和 SpringBoot 项目的依赖有区别，按需引入：

1
2
3
4
5
6
7
8
9
10
11
<!-- Spring Boot -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-amqp</artifactId>
</dependency>
<!-- Spring -->
<dependency>
    <groupId>org.springframework.amqp</groupId>
    <artifactId>spring-rabbit</artifactId>
    <version>2.2.9.RELEASE</version>
</dependency>

2. 在 Spring 配置文件增加配置项

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
spring:
    rabbitmq:
    	# 基础项
        host: 192.168.1.123
        port: 5672
        username: admin
        password: admin
        # virtualhost 需要提前在 MQ 的 Web 管理界面里手动创建，或者配置默认 host"/"
        virtual-host: /test
        # 生产者
        # 确认消息已发送到交换机(Exchange)
        publisher-confirm-type: correlated
        # 确认消息已发送到队列(Queue)
        publisher-returns: true
        # 消费者
        listener:
            type: simple
            simple:
                default-requeue-rejected: false
                acknowledge-mode: auto # 确认模式
                prefetch: 1 # 限制每次发送一条数据
                max-concurrency: 1 # 启动消费者最大数量
                concurrency: 1 # 同一个队列启动几个消费者
                retry:
                    enabled: true # 是否支持重试

说明：这里仅按照现有项目的配置列出，在实际的项目中，还是需要根据自身实际情况做出调整。

3. 编写生产者代码

3.1 创建 RabbitMQ 配置类：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
@Configuration
public class RabbitMQConfig {
    //queue
    public static final String WORK_QUEUE = "test.queue";
    //exchange
    public static final String WORK_DIRECTEXCHANGE = "test.directExchange";
    //routing
    public static final String WORK_DIRECTROUTING = "test.directRouting";

    @Bean
    public RabbitTemplate rabbitTemplate(ConnectionFactory connectionFactory) {
        RabbitTemplate rabbitTemplate = new RabbitTemplate(connectionFactory);
        return rabbitTemplate;
    }

    // Queue
    @Bean
    public Queue directQueue() {
        Map<String, Object> argsMap = new HashMap<String, Object>();
        argsMap.put("x-max-priority", 5);
        Queue queue = new Queue(WORK_QUEUE, true, false, false, argsMap);
        return queue;
    }

    //Direct 交换机
    @Bean
    DirectExchange directExchange() {
        return new DirectExchange(WORK_DIRECTEXCHANGE, true, false);
    }

    // 绑定
    @Bean
    Binding bindingDirect() {
        return BindingBuilder.bind(directQueue()).to(directExchange()).with(WORK_DIRECTROUTING);
    }
}

3.2 编写发送消息工具类：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
@Component
public class RabbitMQUtils {
    private static RabbitTemplate rabbitTemplate;

    @Autowired
    public RabbitMQUtils(RabbitTemplate rabbitTemplate) {
        this.rabbitTemplate = rabbitTemplate;
    }

    public static void sendMsg(String msg) throws AmqpException {
        try {
            rabbitTemplate.convertAndSend(RabbitMQConfig.WORK_DIRECTEXCHANGE, RabbitMQConfig.WORK_DIRECTROUTING, msg);
        } catch (AmqpException e) {
            throw new AmqpException ("RabbitMQ 发送消息异常 ", e);
        }
    }

}

3.3 编写单元测试，测试发送消息结果。

4. 编写消费者代码

4.1 编写监听器：

1
2
3
4
5
6
7
8
@Component
public class RabbitMQListener {
	@RabbitListener(queues = {Constants.WORK_QUEUE})// 监听队列
	public void listener(String msg, Message message)  {
		System.out.println(msg);
		System.out.println(message.getBody());
	}
}

二、存在的问题

1. 问题描述

实际项目中，消息的生产者和消费者不在同一项目中，如果先启动消费者会因为没有队列而启动失败。

2. 尝试解决

2.1 方式一：最容易想到的是，在 MQ 的 Web 管理界面中手动创建队列：

  • 该方式在实际操作是个不容易的事情，因为还要创建 Channel 和 Exchange，何况发布的人不一定是开发的人，沟通繁琐，极易出错，好像程序还是半成品似的；

2.2 方式二：启动消费者项目时，监听器发现不存在队列自动创建：

  • “通过 @RabbitListener”的参数，确实可以实现；
  • 但是这种方式在我的项目中出现了新问题，消费者项目启动后创建了队列，但是生产者发送消息出错，貌似没有了权限？
  • 当时因为项目工期，并未深究，具体错误也没记录下来；应该是自己的代码有问题；
  • 因此，不能确认该方式的可行性，或者具体实现方式。

2.3 方式三：先启动生产者项目：

  • 因 RabbitMQ 懒加载模式，所以单纯启动项目是不会创建队列的；
  • 因此，最开始的想法是，启动项目后，先发送一条测试消息去创建队列，项目确实用该方式使用了一段时间；
  • 近期在升级项目时，发现个现象，没有队列时候的第一条消息确实可以创建队列，但是 MQ 里没有消息，是空队列；
  • 种种问题促使自己重新寻找解决方式，在生产者项目启动后可以自动创建队列，因此有了本篇文章；
  • 很惭愧，其实答案一直在，但是自己对 MQ 的认知一直停留在简单使用里，希望有机会能深入的学习一下吧。

三、生产者项目创建队列

1. 在 RabbitMQ 配置类中加入 RabbitAdmin

1
2
3
4
5
6
@Bean
public RabbitAdmin rabbitAdmin(ConnectionFactory connectionFactory) {
    RabbitAdmin rabbitAdmin = new RabbitAdmin(connectionFactory);
    rabbitAdmin.setAutoStartup(true);
    return rabbitAdmin;
}

2. 通过 RabbitAdmin 声明队列，完成队列的创建

1
2
3
4
5
6
7
8
9
@Bean
public Queue directQueue() {
    Map<String, Object> argsMap = new HashMap<String, Object>();
    argsMap.put("x-max-priority", 5);
    Queue queue = new Queue(WORK_QUEUE, true, false, false, argsMap);
    // 声明队列
    rabbitAdmin.declareQueue(queue);
    return queue;
}

3. 修改后的完整配置类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
@Configuration
public class RabbitMQConfig {
    //queue
    public static final String WORK_QUEUE = "test.queue";
    //exchange
    public static final String WORK_DIRECTEXCHANGE = "test.directExchange";
    //routing
    public static final String WORK_DIRECTROUTING = "test.directRouting";
    @Autowired
    private RabbitAdmin rabbitAdmin;
    
    @Bean
    public RabbitTemplate rabbitTemplate(ConnectionFactory connectionFactory) {
        RabbitTemplate rabbitTemplate = new RabbitTemplate(connectionFactory);
        return rabbitTemplate;
    }
    
    @Bean
    public RabbitAdmin rabbitAdmin(ConnectionFactory connectionFactory) {
        RabbitAdmin rabbitAdmin = new RabbitAdmin(connectionFactory);
        rabbitAdmin.setAutoStartup(true);
        return rabbitAdmin;
    }

    @Bean
    public Queue directQueue() {
        Map<String, Object> argsMap = new HashMap<String, Object>();
        argsMap.put("x-max-priority", 5);
        Queue queue = new Queue(WORK_QUEUE, true, false, false, argsMap);
        rabbitAdmin.declareQueue(queue);
        return queue;
    }

    //Direct 交换机
    @Bean
    DirectExchange directExchange() {
        return new DirectExchange(WORK_DIRECTEXCHANGE, true, false);
    }

    // 绑定
    @Bean
    Binding bindingDirect() {
        return BindingBuilder.bind(directQueue()).to(directExchange()).with(WORK_DIRECTROUTING);
    }
}

4. 启动项目，查看队列创建情况

  • 经过多次测试，在仅手动创建 virtual-host 的前提下，启动项目，队列可以自动创建，且发送 / 接收消息都正常完成。