Springboot集成rabbitmq——实现延迟队列_springboot rabbitmq 延迟队列

目录

1.rabbitmq简介

2.延迟队列

3.Springboot集成rabbitmq

4.以死信队列形式实现

5.以插件形式实现

1.rabbitmq简介

 MQ(message queue)，从字面意思上看，本质是个队列，遵从先入先出的规则，只不过队列中存放的内容是 message 而已，是一种跨进程的通信机制，用于上下游传递消息。RabbitMq是开发中常用的一种消息中间件，由于实现服务之间的消息转发。使用了 MQ 之后，消息发送上游只需要依赖 MQ，不用依赖其他服务。

它主要基于四大核心概念：生产者、交换机、队列、消费者。其工作原理如下：

 简单来说，工作原理如下：

生产者——>生成消息——>建立连接——>交换机——>队列——>建立连接——>消费者

2.延迟队列

延时队列最重要的特性就体现在它的延时属性上，延时队列中的元素是希望在指定时间到了以后或之前取出和处理，简单来说，延时队列就是用来存放需要在指定时间被处理的元素的队列。

其可使用的应用场景如下：

1. 订单在十分钟之内未支付则自动取消
2. 新创建的店铺，如果在十天内都没有上传过商品，则自动发送消息提醒。
3. 用户注册成功后，如果三天内没有登陆则进行短信提醒。

3.Springboot集成rabbitmq

关于springboot集成rabbitmq，首先我们需要导入相关依赖：

<dependencies>
    <!--RabbitMQ 依赖-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-amqp</artifactId>
    </dependency>
    <!--springboot 依赖-->
   <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</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>
    <!--RabbitMQ 测试依赖-->
    <dependency>
        <groupId>org.springframework.amqp</groupId>
        <artifactId>spring-rabbit-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

编写配置文件，用以连接rabbitmq（此处使用application.yml形式）：

spring:
  rabbitmq:
    host: 127.0.0.1   #主机地址
    port: 5672    #端口号
    username: guest   #用户名   
    password: guest   #密码

然后，我们就可以在springboot项目中使用rabbitmq相关的包，或是使用 rabbitTemplate 来使用相关的方法。

4.以死信队列形式实现

死信，顾名思义就是无法被消费的消息。一般来说，producer 将消息投递到 broker 或者直接到queue 里了，consumer 从 queue 取出消息进行消费，但某些时候由于特定的原因导致queu 中的某些消息无法被消费，这样的消息如果没有后续的处理，就变成了死信，有死信自然就有了死信队列。

而由于TTL（生存时间）过期导致的死信，就是我们实现延迟队列的的方式。

我们需要声明如下形式的交互机和队列，以及对应的routing key，并进行绑定：

import org.springframework.amqp.core.*;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
 
import java.util.HashMap;
import java.util.Map;
 
 
@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";
    //通用队列
    public static final String QUEUE_C = "QC";
 
    // 声明 xExchange
    @Bean("xExchange")
    public DirectExchange xExchange() {
        return new DirectExchange(X_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");
    }
    //声明通用队列C 不设ttl，由消费者决定ttl
    @Bean("queueC")
    public Queue queueC() {
        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");
        return QueueBuilder.durable(QUEUE_C).withArguments(args).build();
    }
    // 声明队列 A 绑定 X 交换机
    @Bean
    public Binding queuecBindingX(@Qualifier("queueC") Queue queueC,
                                  @Qualifier("xExchange") DirectExchange xExchange) {
        return BindingBuilder.bind(queueC).to(xExchange).with("XC");
    }
 
 
    // 声明 死信队列交换机
    @Bean("yExchange")
    public DirectExchange yExchange() {
        return new DirectExchange(Y_DEAD_LETTER_EXCHANGE);
    }
    //声明死信队列 QD
    @Bean("queueD")
    public Queue queueD() {
        return new Queue(DEAD_LETTER_QUEUE,true);
    }
    //声明死信队列 QD 绑定关系
    @Bean
    public Binding deadLetterBindingQAD(@Qualifier("queueD") Queue queueD,
                                        @Qualifier("yExchange") DirectExchange yExchange) {
        return BindingBuilder.bind(queueD).to(yExchange).with("YD");
    }
 
}

 其中，QD为死信队列。当QA和QB队列中的消息，达到设定的TTL（10s和40s）后，将进入指定的死信队列QD。该方法下一个TTL指定一个队列

其中的QC作为通用的队列，即在消费者处指定消息对应的TTL，TTL过期后转入死信队列。使用该通用队列可以避免每增加一个新的时间需求，就要新增一个队列的问题。但该方法由于队列先进先出的性质，会导致一定的问题：

即先发出一个TTL为10s的消息a，进入队列；再马上发出一个TTL为2s的消息b，进入队列。由于队列的性质，会在消息a的TTL结束后，a进入2死信队列后，b才会进入死信队列。而不是根据TTL的时间，b比a先进入死信队列。

声明交换机、队列，并绑定成功后，编写死信队列消费者代码;

import com.rabbitmq.client.Channel;
import lombok.extern.slf4j.Slf4j;
import org.springframework.amqp.core.Message;
import org.springframework.amqp.rabbit.annotation.RabbitListener;
import org.springframework.stereotype.Component;
 
import java.io.IOException;
import java.util.Date;
 
 
@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);
    }
 
}

 在controller中编写生产者代码，进行测试：

1.导入RabbitTemplate，以便使用rabbitmq相关方法。

    @Resource
    private RabbitTemplate rabbitTemplate;

 生产者代码，发消息给队列QA和QB：

    @GetMapping("/ttl/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);
    }

 结果如图：

 测试通用队列QC的效果：

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

结果如图：

可以看到， 两条消息几乎同时到达死信队列，因为TTL为2s的消息由于被堵在TTL为10s的消息后导致。

5.以插件形式实现

上述问题可以通过插件解决，可去官网下载 (opens new window) rabbitmq_delayed_message_exchange 插件，放置到 RabbitMQ 的插件目录，并使用命令安装：rabbitmq-plugins enable rabbitmq_delayed_message_exchange

安装成功后，效果如图：

使用该插件后，延时队列的工作原理如图：

消息将不再存放在延时队列中，而是存放于延迟交换机中，由交换机进行分配。

声明交互机及队列代码如下：

import org.springframework.amqp.core.Binding;
import org.springframework.amqp.core.BindingBuilder;
import org.springframework.amqp.core.CustomExchange;
import org.springframework.amqp.core.Queue;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
 
import java.util.HashMap;
import java.util.Map;
 
@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("delayedQueue")
    public Queue delayedQueue() {
        return new Queue(DELAYED_QUEUE_NAME);
    }
 
    //自定义交换机 我们在这里定义的是一个延迟交换机
    @Bean("delayedExchange")
    public CustomExchange delayedExchange() {
        Map<String, Object> args = new HashMap<>();
        //自定义交换机的类型，指定分发方式
        args.put("x-delayed-type", "direct");
        //此处type指定为延迟交换机
        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();
    }
}

 编写监听延迟队列代码：

import lombok.extern.slf4j.Slf4j;
import org.springframework.amqp.core.Message;
import org.springframework.amqp.rabbit.annotation.RabbitListener;
import org.springframework.stereotype.Component;
import java.util.Date;
import static com.seven.rabbitmq.config.DelayedQueueConfig.DELAYED_QUEUE_NAME;
 
@Slf4j
@Component
public class DelayQueueConsumer {
 
    @RabbitListener(queues = DELAYED_QUEUE_NAME)
    public void receiveDelayedQueue(Message message) {
        String msg = new String(message.getBody());
        log.info("当前时间：{},收到延时队列的消息：{}", new Date().toString(), msg);
    }
}

编写消费者代码：

    @GetMapping("/ttl/send/delay/{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);
    }

测试结果：

可以看到，消息b在TTL过期后，由延迟交换机马上分发出去，不需等待TTL为10s的消息a过期，达到预设目的。