【SpringBoot整合RabbitMQ和队列TTL】

野性酷女 2023-09-23 23:25 67阅读 0赞

本笔记内容为尚硅谷SpringBoot整合RabbitMQ部分

**目录**

一、整合SpringBoot

1、创建一个springboot项目

2、添加依赖

3、修改配置文件

4、添加 Swagger 配置类

二、队列 TTL实战演示

1、RabbitMQ 中的 TTL

2、代码架构图

3、配置类代码

4、消息生产者代码

5、消息消费者代码

三、延时队列优化

1、代码架构图

2、配置文件类代码

3、消息生产者代码

三、RabbitMQ插件实现延迟队列

1、安装延时队列插件

2、代码架构图

3、配置文件类代码

4、消息生产者代码

5、消息消费者代码

6、总结

--------------------

# 一、整合SpringBoot #

--------------------

### 1、创建一个springboot项目 ###

![d5dec8b009504e0f9a1dceca5063cb3a.png][]

### 2、添加依赖 ###

<dependencies>
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-amqp</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>fastjson</artifactId>
                <version>1.2.47</version>
            </dependency>
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
            </dependency>
            
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger2</artifactId>
                <version>2.9.2</version>
            </dependency>
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger-ui</artifactId>
                <version>2.9.2</version>
            </dependency>
            
            <dependency>
                <groupId>org.springframework.amqp</groupId>
                <artifactId>spring-rabbit-test</artifactId>
                <scope>test</scope>
            </dependency>
    
            <dependency>
                <groupId>org.slf4j</groupId>
                <artifactId>slf4j-log4j12</artifactId>
                <version>1.7.25</version>
            </dependency>
        </dependencies>

### 3、修改配置文件 ###

application.properties

IP、用户名和密码改为自己对应的即可

spring.rabbitmq.host=192.168.88.129
    spring.rabbitmq.port=5672 
    spring.rabbitmq.username=admin
    spring.rabbitmq.password=1234

### 4、添加 Swagger 配置类 ###

Swagger是实战测试时用的，和本次学习的rabbitmq没关系

在config包下创建SwaggerConfig.java类

@Configuration
    @EnableSwagger2
    public class SwaggerConfig {
        @Bean
        public Docket webApiConfig(){
            return new Docket(DocumentationType.SWAGGER_2)
                    .groupName("webApi")
                    .apiInfo(webApiInfo())
                    .select()
                    .build();
        }
        private ApiInfo webApiInfo(){
            return new ApiInfoBuilder()
                    .title("rabbitmq 接口文档")
                    .description(" 本文档描述了 rabbitmq 微服务接口定义")
                    .version("1.0")
                    .contact(new Contact("ZuHao", "http://atguigu.com","1913455524@qq.com"))
                    .build();
        }
    }

# 二、队列 TTL实战演示 #

--------------------

## 1、RabbitMQ 中的 TTL ##

TTL 是什么呢？TTL 是 RabbitMQ 中一个消息或者队列的属性，表明一条消息或者该队列中的所有消息的最大存活时间，单位是毫秒。换句话说，如果一条消息设置了 TTL 属性或者进入了设置TTL 属性的队列，那么这条消息如果在 TTL 设置的时间内没有被消费，则会成为"死信"。如果同时配置了队列的 TTL 和消息的TTL，那么较小的那个值将会被使用，有两种方式设置 TTL。

## 2、代码架构图 ##

![84462bfff8a4490d81ee87fe9ac936cf.png][]

## 3、配置类代码 ##

在config包下创建TtlQueueConfig.java类，内容是交换机和队列绑定的部分

@Configuration
    public class TtlQueueConfig {
        public static final String X_EXCHANGE = "X";
        public static final String QUEUE_A = "QA";
        public static final String QUEUE_B = "QB";
        public static final String Y_DEAD_LETTER_EXCHANGE = "Y";
        public static final String DEAD_LETTER_QUEUE = "QD";
        // 声明 xExchange
        @Bean("xExchange")
        public DirectExchange xExchange(){
            return new DirectExchange(X_EXCHANGE);
        }
        // 声明 xExchange
        @Bean("yExchange")
        public DirectExchange yExchange(){
            return new DirectExchange(Y_DEAD_LETTER_EXCHANGE);
        }
        // 声明队列 A ttl 为 10s 并绑定到对应的死信交换机
        @Bean("queueA")
        public Queue queueA(){
            Map<String, Object> args = new HashMap<>(3);
            // 声明当前队列绑定的死信交换机
            args.put("x-dead-letter-exchange", Y_DEAD_LETTER_EXCHANGE);
            // 声明当前队列的死信路由 key
            args.put("x-dead-letter-routing-key", "YD");
            // 声明队列的 TTL
            args.put("x-message-ttl", 10000);
            return QueueBuilder.durable(QUEUE_A).withArguments(args).build();
        }
        // 声明队列 A 绑定 X 交换机
        @Bean
        public Binding queueaBindingX(@Qualifier("queueA") Queue queueA,
                                      @Qualifier("xExchange") DirectExchange xExchange){
            return BindingBuilder.bind(queueA).to(xExchange).with("XA");
        }
        // 声明队列 B ttl 为 40s 并绑定到对应的死信交换机
        @Bean("queueB")
        public Queue queueB(){
            Map<String, Object> args = new HashMap<>(3);
            // 声明当前队列绑定的死信交换机
            args.put("x-dead-letter-exchange", Y_DEAD_LETTER_EXCHANGE);
            // 声明当前队列的死信路由 key
            args.put("x-dead-letter-routing-key", "YD");
            // 声明队列的 TTL
            args.put("x-message-ttl", 40000);
            return QueueBuilder.durable(QUEUE_B).withArguments(args).build();
        }
        // 声明队列 B 绑定 X 交换机
        @Bean
        public Binding queuebBindingX(@Qualifier("queueB") Queue queue1B,
                                      @Qualifier("xExchange") DirectExchange xExchange){
            return BindingBuilder.bind(queue1B).to(xExchange).with("XB");
        }
        // 声明死信队列 QD
        @Bean("queueD")
        public Queue queueD(){
            return new Queue(DEAD_LETTER_QUEUE);
        }
        // 声明死信队列 QD 绑定关系
        @Bean
        public Binding deadLetterBindingQAD(@Qualifier("queueD") Queue queueD,
                                            @Qualifier("yExchange") DirectExchange yExchange){
            return BindingBuilder.bind(queueD).to(yExchange).with("YD");
        }
    }

**注意：记得导包别导错**

## 4、消息生产者代码 ##

controller包下的SendMsgController类

@Slf4j
    @RequestMapping("ttl")
    @RestController
    public class SendMsgController {
        @Autowired
        private RabbitTemplate rabbitTemplate;
        @GetMapping("sendMsg/{message}")
        public void sendMsg(@PathVariable String message){
            log.info(" 当前时间：{}, 发送一条信息给两个 TTL 队列:{}", new Date(), message);
            rabbitTemplate.convertAndSend("X", "XA", " 消息来自 ttl 为 为 10S 的队列: "+message);
            rabbitTemplate.convertAndSend("X", "XB", " 消息来自 ttl 为 为 40S 的队列: "+message);
        }
    }

## 5、消息消费者代码 ##

@Slf4j
    @Component
    public class DeadLetterQueueConsumer {
        @RabbitListener(queues = "QD")
        public void receiveD(Message message, Channel channel) throws IOException {
            String msg = new String(message.getBody());
            log.info(" 当前时间：{}, 收到死信队列信息{}", new Date().toString(), msg);
        }
    }

启动项目并浏览器上发起一个请求 http://localhost:8080/ttl/sendMsg/嘻嘻嘻

![58a281678ae5461bb2e949a787cf8263.png][]

成功运行！

![d6d8ecf043844c658f62ba2aac8074fc.png][]

# 三、延时队列优化 #

--------------------

## 1、代码架构图 ##

在这里新增了一个队列 QC,绑定关系如下,该队列不设置 TTL 时间

![73ac3594330b4d53b688fa45bff5cc27.png][]

## 2、配置文件类代码 ##

在config包下创建MsgTtlQueueConfig.java类

/**
     * Description: 优化TTL队列 配置文件代码-延迟队列
     *      ttl时间由发送者来设置（灵活）
     *      RabbitMq只会检查第一个消息是否过期，若第二个消息比第一个消息时间短也不会优先执行（可以用RabbitMq插件解决）
     */
    @Configuration
    public class MsgTtlQueueConfig {
        public static final String Y_DEAD_LETTER_EXCHANGE = "Y";
        public static final String QUEUE_C = "QC";
        // 声明队列 C 死信交换机
        @Bean("queueC")
        public Queue queueB(){
            Map<String, Object> args = new HashMap<>(3);
            // 声明当前队列绑定的死信交换机
            args.put("x-dead-letter-exchange", Y_DEAD_LETTER_EXCHANGE);
            // 声明当前队列的死信路由 key
            args.put("x-dead-letter-routing-key", "YD");
            // 没有声明 TTL 属性
            return QueueBuilder.durable(QUEUE_C).withArguments(args).build();
        }
        // 声明队列 C 绑定 X 交换机
        @Bean
        public Binding queuecBindingX(@Qualifier("queueC") Queue queueC,
                                      @Qualifier("xExchange") DirectExchange xExchange){
            return BindingBuilder.bind(queueC).to(xExchange).with("XC");
        }
    }

## 3、消息生产者代码 ##

controller包下的SendMsgController类添加以下方法

@GetMapping("sendExpirationMsg/{message}/{ttlTime}")
        public void sendMsg(@PathVariable String message,@PathVariable String ttlTime) {
            rabbitTemplate.convertAndSend("X", "XC", message, msg ->{
                //发送消息的时候延迟时长
                msg.getMessageProperties().setExpiration(ttlTime);
                return msg;
            });
            log.info(" 当前时间：{}, 发送一条时长{} 毫秒 TTL 信息给队列 C:{}", new Date(),ttlTime, message);
        }

启动项目，发起请求

http://localhost:8080/ttl/sendExpirationMsg/你好 1/20000  
http://localhost:8080/ttl/sendExpirationMsg/你好 2/2000

![cae04e1d878144a292ac5710c646b99a.png][]

# 三、RabbitMQ插件实现延迟队列 #

--------------------

上文提到的问题如果不能实现在消息粒度上的 TTL，并使其在设置的 TTL 时间及时死亡，就无法设计成一个通用的延时队列。

## 1、安装延时队列插件 ##

在官网上下载 [https://www.rabbitmq.com/community-plugins.html][https_www.rabbitmq.com_community-plugins.html]，下载  
**rabbitmq\_delayed\_message\_exchange** 插件，然后解压放置到 RabbitMQ 的插件目录。

把下载好的插件拷贝到/usr/lib/rabbitmq/lib/rabbitmq\_server-3.8.8/plugins 目录下

![0332ef0273bf4931be5372bbe0866186.png][]

进入 RabbitMQ 的安装目录下的 plgins 目录，执行下面命令让该插件生效(后面可不加版本号)

![a03dc7ce75724277a14986b85f0505f7.png][]

然后重启 RabbitMQ

![3df3bf6b4dab47c9b7f64d40476ac7e1.png][]

![9b888636f90449f28cba47e6961ffbe8.png][]

![7f2d609404884c6eae68b80acbcb0142.png][]

![ff97241cd20f4740b06672054e475b84.png][]

## 2、代码架构图 ##

![f74f5a28d8364d4897a05cb2ae44b700.png][]

## 3、配置文件类代码 ##

在我们自定义的交换机中，这是一种新的交换类型，该类型消息支持延迟投递机制 消息传递后并不会立即投递到目标队列中，而是存储在 mnesia(一个分布式数据系统)表中，当达到投递时间时，才投递到目标队列中。

在config包下创建DelayedQueueConfig类

@Configuration
    public class DelayedQueueConfig {
        public static final String DELAYED_QUEUE_NAME = "delayed.queue";
        public static final String DELAYED_EXCHANGE_NAME = "delayed.exchange";
        public static final String DELAYED_ROUTING_KEY = "delayed.routingkey";
        @Bean
        public Queue delayedQueue() {
            return new Queue(DELAYED_QUEUE_NAME);
        }
        // 自定义交换机 我们在这里定义的是一个延迟交换机
        @Bean
        public CustomExchange delayedExchange() {
            Map<String, Object> args = new HashMap<>();
        // 自定义交换机的类型
            args.put("x-delayed-type", "direct");
            return new CustomExchange(DELAYED_EXCHANGE_NAME, "x-delayed-message", true, false,
                    args);
        }
        @Bean
        public Binding bindingDelayedQueue(@Qualifier("delayedQueue") Queue queue,
                                           @Qualifier("delayedExchange") CustomExchange
                                                   delayedExchange) {
            return
                    BindingBuilder.bind(queue).to(delayedExchange).with(DELAYED_ROUTING_KEY).noargs();
        }
    }

## 4、消息生产者代码 ##

在controller包下的SendMsgController类中添加

public static final String DELAYED_EXCHANGE_NAME = "delayed.exchange";
    public static final String DELAYED_ROUTING_KEY = "delayed.routingkey";
    
    @GetMapping("sendDelayMsg/{message}/{delayTime}")
        public void sendMsg(@PathVariable String message,@PathVariable Integer delayTime) {
            rabbitTemplate.convertAndSend(DELAYED_EXCHANGE_NAME, DELAYED_ROUTING_KEY, message,
                    correlationData ->{
                        correlationData.getMessageProperties().setDelay(delayTime);
                        return correlationData;
                    });
            log.info(" 当 前 时 间 ： {}, 发 送 一 条 延 迟 {} 毫 秒 的 信 息 给 队 列 delayed.queue:{}", new
                    Date(),delayTime, message);
        }

## 5、消息消费者代码 ##

在consumer包下创建DelayQueueConsumer 类

@Slf4j
    @Component
    public class DelayQueueConsumer {
        public static final String DELAYED_QUEUE_NAME = "delayed.queue";
        @RabbitListener(queues = DELAYED_QUEUE_NAME)
        public void receiveDelayedQueue(Message message){
            String msg = new String(message.getBody());
            log.info(" 当前时间：{}, 收到延时队列的消息：{}", new Date().toString(), msg);
        }
    }

发起请求：  
http://localhost:8080/ttl/sendDelayMsg/come on baby1/20000  
http://localhost:8080/ttl/sendDelayMsg/come on baby2/2000

![5a29c2670a5348b6a9f3c9723cc497b0.png][]

## 6、总结 ##

延时队列在需要延时处理的场景下非常有用，使用 RabbitMQ 来实现延时队列可以很好的利用RabbitMQ 的特性，如：消息可靠发送、消息可靠投递、死信队列来保障消息至少被消费一次以及未被正确处理的消息不会被丢弃。另外，通过 RabbitMQ 集群的特性，可以很好的解决单点故障问题，不会因为单个节点挂掉导致延时队列不可用或者消息丢失。  
当然，延时队列还有很多其它选择，比如利用 Java 的 DelayQueue，利用 Redis 的 zset，利用 Quartz或者利用 kafka 的时间轮，这些方式各有特点,看需要适用的场景

[d5dec8b009504e0f9a1dceca5063cb3a.png]: https://img-blog.csdnimg.cn/d5dec8b009504e0f9a1dceca5063cb3a.png
[84462bfff8a4490d81ee87fe9ac936cf.png]: https://img-blog.csdnimg.cn/84462bfff8a4490d81ee87fe9ac936cf.png
[58a281678ae5461bb2e949a787cf8263.png]: https://img-blog.csdnimg.cn/58a281678ae5461bb2e949a787cf8263.png
[d6d8ecf043844c658f62ba2aac8074fc.png]: https://img-blog.csdnimg.cn/d6d8ecf043844c658f62ba2aac8074fc.png
[73ac3594330b4d53b688fa45bff5cc27.png]: https://img-blog.csdnimg.cn/73ac3594330b4d53b688fa45bff5cc27.png
[cae04e1d878144a292ac5710c646b99a.png]: https://img-blog.csdnimg.cn/cae04e1d878144a292ac5710c646b99a.png
[https_www.rabbitmq.com_community-plugins.html]: https://www.rabbitmq.com/community-plugins.html
[0332ef0273bf4931be5372bbe0866186.png]: https://img-blog.csdnimg.cn/0332ef0273bf4931be5372bbe0866186.png
[a03dc7ce75724277a14986b85f0505f7.png]: https://img-blog.csdnimg.cn/a03dc7ce75724277a14986b85f0505f7.png
[3df3bf6b4dab47c9b7f64d40476ac7e1.png]: https://img-blog.csdnimg.cn/3df3bf6b4dab47c9b7f64d40476ac7e1.png
[9b888636f90449f28cba47e6961ffbe8.png]: https://img-blog.csdnimg.cn/9b888636f90449f28cba47e6961ffbe8.png
[7f2d609404884c6eae68b80acbcb0142.png]: https://img-blog.csdnimg.cn/7f2d609404884c6eae68b80acbcb0142.png
[ff97241cd20f4740b06672054e475b84.png]: https://img-blog.csdnimg.cn/ff97241cd20f4740b06672054e475b84.png
[f74f5a28d8364d4897a05cb2ae44b700.png]: https://img-blog.csdnimg.cn/f74f5a28d8364d4897a05cb2ae44b700.png
[5a29c2670a5348b6a9f3c9723cc497b0.png]: https://img-blog.csdnimg.cn/5a29c2670a5348b6a9f3c9723cc497b0.png