详细介绍Spring Boot + RabbitMQ实现延迟队列

背景

何为延迟队列？

顾名思义，延迟队列就是进入该队列的消息会被延迟消费的队列。而通常的队列，消息一旦入队了以后就会被消费者立刻消费。

延迟队列能作什么？

延迟队列多用于须要延迟工做的场景。最多见的是如下两种场景：

1. 延迟消费。好比：
   • 用户生成订单以后，须要过一段时间校验订单的支付状态，若是订单仍未支付则须要及时地关闭订单。
   • 用户注册成功以后，须要过一段时间好比一周后校验用户的使用状况，若是发现用户活跃度较低，则发送邮件或者短信来提醒用户使用。
2. 延迟重试。好比消费者从队列里消费消息时失败了，可是想要延迟一段时间后自动重试。

若是不使用延迟队列，那么咱们只能经过一个轮询扫描程序去完成。这种方案既不优雅，也不方便作成统一的服务便于开发人员使用。可是使用延迟队列的话，咱们就能够垂手可得地完成。

如何实现？

别急，在下文中，咱们将详细介绍如何利用Spring Boot加RabbitMQ来实现延迟队列。

本文出现的示例代码都已push到Github仓库中：github.com/Lovelcp/blo…

实现思路

在介绍具体的实现思路以前，咱们先来介绍一下RabbitMQ的两个特性，一个是Time-To-Live Extensions，另外一个是Dead Letter Exchanges。

Time-To-Live Extensions

RabbitMQ容许咱们为消息或者队列设置TTL（time to live），也就是过时时间。TTL代表了一条消息可在队列中存活的最大时间，单位为毫秒。也就是说，当某条消息被设置了TTL或者当某条消息进入了设置了TTL的队列时，这条消息会在通过TTL秒后“死亡”，成为Dead Letter。若是既配置了消息的TTL，又配置了队列的TTL，那么较小的那个值会被取用。更多资料请查阅官方文档。

Dead Letter Exchange

刚才提到了，被设置了TTL的消息在过时后会成为Dead Letter。其实在RabbitMQ中，一共有三种消息的“死亡”形式：

1. 消息被拒绝。经过调用basic.reject或者basic.nack而且设置的requeue参数为false。
2. 消息由于设置了TTL而过时。
3. 消息进入了一条已经达到最大长度的队列。

若是队列设置了Dead Letter Exchange（DLX），那么这些Dead Letter就会被从新publish到Dead Letter Exchange，经过Dead Letter Exchange路由到其余队列。更多资料请查阅官方文档。

流程图

聪明的你确定已经想到了，如何将RabbitMQ的TTL和DLX特性结合在一块儿，实现一个延迟队列。

针对于上述的延迟队列的两个场景，咱们分别有如下两种流程图：

延迟消费

延迟消费是延迟队列最为经常使用的使用模式。以下图所示，生产者产生的消息首先会进入缓冲队列（图中红色队列）。经过RabbitMQ提供的TTL扩展，这些消息会被设置过时时间，也就是延迟消费的时间。等消息过时以后，这些消息会经过配置好的DLX转发到实际消费队列（图中蓝色队列），以此达到延迟消费的效果。

延迟重试

延迟重试本质上也是延迟消费的一种，可是这种模式的结构与普通的延迟消费的流程图较为不一样，因此单独拎出来介绍。

以下图所示，消费者发现该消息处理出现了异常，好比是由于网络波动引发的异常。那么若是不等待一段时间，直接就重试的话，极可能会致使在这期间内一直没法成功，形成必定的资源浪费。那么咱们能够将其先放在缓冲队列中（图中红色队列），等消息通过一段的延迟时间后再次进入实际消费队列中（图中蓝色队列），此时因为已通过了“较长”的时间了，异常的一些波动一般已经恢复，这些消息能够被正常地消费。

代码实现

接下来咱们将介绍如何在Spring Boot中实现基于RabbitMQ的延迟队列。咱们假设读者已经拥有了Spring Boot与RabbitMQ的基本知识。若是想快速了解Spring Boot的相关基础知识，能够参考我以前写的一篇文章。

初始化工程

首先咱们在Intellij中建立一个Spring Boot工程，而且添加spring-boot-starter-amqp扩展。

配置队列

从上述的流程图中咱们能够看到，一个延迟队列的实现，须要一个缓冲队列以及一个实际的消费队列。又因为在RabbitMQ中，咱们拥有两种消息过时的配置方式，因此在代码中，咱们一共配置了三条队列：

• delay_queue_per_message_ttl：TTL配置在消息上的缓冲队列。
• delay_queue_per_queue_ttl：TTL配置在队列上的缓冲队列。
• delay_process_queue：实际消费队列。

咱们经过Java Config的方式将上述的队列配置为Bean。因为咱们添加了spring-boot-starter-amqp扩展，Spring Boot在启动时会根据咱们的配置自动建立这些队列。为了方便接下来的测试，咱们将delay_queue_per_message_ttl以及delay_queue_per_queue_ttl的DLX配置为同一个，且过时的消息都会经过DLX转发到delay_process_queue。

delay_queue_per_message_ttl

首先介绍delay_queue_per_message_ttl的配置代码：

@Bean
Queue delayQueuePerMessageTTL() {
    return QueueBuilder.durable(DELAY_QUEUE_PER_MESSAGE_TTL_NAME)
                       .withArgument("x-dead-letter-exchange", DELAY_EXCHANGE_NAME) // DLX，dead letter发送到的exchange
                       .withArgument("x-dead-letter-routing-key", DELAY_PROCESS_QUEUE_NAME) // dead letter携带的routing key
                       .build();
}复制代码

其中，x-dead-letter-exchange声明了队列里的死信转发到的DLX名称，x-dead-letter-routing-key声明了这些死信在转发时携带的routing-key名称。

delay_queue_per_queue_ttl

相似地，delay_queue_per_queue_ttl的配置代码：

@Bean
Queue delayQueuePerQueueTTL() {
    return QueueBuilder.durable(DELAY_QUEUE_PER_QUEUE_TTL_NAME)
                       .withArgument("x-dead-letter-exchange", DELAY_EXCHANGE_NAME) // DLX
                       .withArgument("x-dead-letter-routing-key", DELAY_PROCESS_QUEUE_NAME) // dead letter携带的routing key
                       .withArgument("x-message-ttl", QUEUE_EXPIRATION) // 设置队列的过时时间
                       .build();
}复制代码

delay_queue_per_queue_ttl队列的配置比delay_queue_per_message_ttl队列的配置多了一个x-message-ttl，该配置用来设置队列的过时时间。

delay_process_queue

delay_process_queue的配置最为简单：

@Bean
Queue delayProcessQueue() {
    return QueueBuilder.durable(DELAY_PROCESS_QUEUE_NAME)
                       .build();
}复制代码

配置Exchange

配置DLX

首先，咱们须要配置DLX，代码以下：

@Bean
DirectExchange delayExchange() {
    return new DirectExchange(DELAY_EXCHANGE_NAME);
}复制代码

而后再将该DLX绑定到实际消费队列即delay_process_queue上。这样全部的死信都会经过DLX被转发到delay_process_queue：

@Bean
Binding dlxBinding(Queue delayProcessQueue, DirectExchange delayExchange) {
    return BindingBuilder.bind(delayProcessQueue)
                         .to(delayExchange)
                         .with(DELAY_PROCESS_QUEUE_NAME);
}复制代码

配置延迟重试所需的Exchange

从延迟重试的流程图中咱们能够看到，消息处理失败以后，咱们须要将消息转发到缓冲队列，因此缓冲队列也须要绑定一个Exchange。在本例中，咱们将delay_process_per_queue_ttl做为延迟重试里的缓冲队列。具体代码是如何配置的，这里就不赘述了，你们能够查阅我Github中的代码。

定义消费者

咱们建立一个最简单的消费者ProcessReceiver，这个消费者监听delay_process_queue队列，对于接受到的消息，他会：

• 若是消息里的消息体不等于FAIL_MESSAGE，那么他会输出消息体。
• 若是消息里的消息体刚好是FAIL_MESSAGE，那么他会模拟抛出异常，而后将该消息重定向到缓冲队列（对应延迟重试场景）。

另外，咱们还须要新建一个监听容器用于存放消费者，代码以下：

@Bean
SimpleMessageListenerContainer processContainer(ConnectionFactory connectionFactory, ProcessReceiver processReceiver) {
    SimpleMessageListenerContainer container = new SimpleMessageListenerContainer();
    container.setConnectionFactory(connectionFactory);
    container.setQueueNames(DELAY_PROCESS_QUEUE_NAME); // 监听delay_process_queue
    container.setMessageListener(new MessageListenerAdapter(processReceiver));
    return container;
}复制代码

至此，咱们前置的配置代码已经所有编写完成，接下来咱们须要编写测试用例来测试咱们的延迟队列。

编写测试用例

延迟消费场景

首先咱们编写用于测试TTL设置在消息上的测试代码。

咱们借助spring-rabbit包下提供的RabbitTemplate类来发送消息。因为咱们添加了spring-boot-starter-amqp扩展，Spring Boot会在初始化时自动地将RabbitTemplate当成bean加载到容器中。

解决了消息的发送问题，那么又该如何为每一个消息设置TTL呢？这里咱们须要借助MessagePostProcessor。MessagePostProcessor一般用来设置消息的Header以及消息的属性。咱们新建一个ExpirationMessagePostProcessor类来负责设置消息的TTL属性：

/** * 设置消息的失效时间 */
public class ExpirationMessagePostProcessor implements MessagePostProcessor {
    private final Long ttl; // 毫秒

    public ExpirationMessagePostProcessor(Long ttl) {
        this.ttl = ttl;
    }

    @Override
    public Message postProcessMessage(Message message) throws AmqpException {
        message.getMessageProperties()
               .setExpiration(ttl.toString()); // 设置per-message的失效时间
        return message;
    }
}复制代码

而后在调用RabbitTemplate的convertAndSend方法时，传入ExpirationMessagePostPorcessor便可。咱们向缓冲队列中发送3条消息，过时时间依次为1秒，2秒和3秒。具体的代码以下所示：

@Test
public void testDelayQueuePerMessageTTL() throws InterruptedException {
    ProcessReceiver.latch = new CountDownLatch(3);
    for (int i = 1; i <= 3; i++) {
        long expiration = i * 1000;
        rabbitTemplate.convertAndSend(QueueConfig.DELAY_QUEUE_PER_MESSAGE_TTL_NAME,
                (Object) ("Message From delay_queue_per_message_ttl with expiration " + expiration), new ExpirationMessagePostProcessor(expiration));
    }
    ProcessReceiver.latch.await();
}复制代码

细心的朋友必定会问，为何要在代码中加一个CountDownLatch呢？这是由于若是没有latch阻塞住测试方法的话，测试用例会直接结束，程序退出，咱们就看不到消息被延迟消费的表现了。

那么相似地，测试TTL设置在队列上的代码以下：

@Test
public void testDelayQueuePerQueueTTL() throws InterruptedException {
    ProcessReceiver.latch = new CountDownLatch(3);
    for (int i = 1; i <= 3; i++) {
        rabbitTemplate.convertAndSend(QueueConfig.DELAY_QUEUE_PER_QUEUE_TTL_NAME,
                "Message From delay_queue_per_queue_ttl with expiration " + QueueConfig.QUEUE_EXPIRATION);
    }
    ProcessReceiver.latch.await();
}复制代码

咱们向缓冲队列中发送3条消息。理论上这3条消息会在4秒后同时过时。

延迟重试场景

咱们一样还需测试延迟重试场景。

@Test
public void testFailMessage() throws InterruptedException {
    ProcessReceiver.latch = new CountDownLatch(6);
    for (int i = 1; i <= 3; i++) {
        rabbitTemplate.convertAndSend(QueueConfig.DELAY_PROCESS_QUEUE_NAME, ProcessReceiver.FAIL_MESSAGE);
    }
    ProcessReceiver.latch.await();
}复制代码

咱们向delay_process_queue发送3条会触发FAIL的消息，理论上这3条消息会在4秒后自动重试。

查看测试结果

延迟消费场景

延迟消费的场景测试咱们分为了TTL设置在消息上和TTL设置在队列上两种。首先，咱们先看一下TTL设置在消息上的测试结果：

从上图中咱们能够看到，ProcessReceiver分别通过1秒、2秒、3秒收到消息。测试结果代表消息不只被延迟消费了，并且每条消息的延迟时间是能够被个性化设置的。TTL设置在消息上的延迟消费场景测试成功。
而后，TTL设置在队列上的测试结果以下图：

从上图中咱们能够看到，ProcessReceiver通过了4秒的延迟以后，同时收到了3条消息。测试结果代表消息不只被延迟消费了，同时也证实了当TTL设置在队列上的时候，消息的过时时间是固定的。TTL设置在队列上的延迟消费场景测试成功。

延迟重试场景

接下来，咱们再来看一下延迟重试的测试结果：

ProcessReceiver首先收到了3条会触发FAIL的消息，而后将其移动到缓冲队列以后，过了4秒，又收到了刚才的那3条消息。延迟重试场景测试成功。

总结

本文首先介绍了延迟队列的概念以及用途，而且经过代码详细讲解了如何经过Spring Boot和RabbitMQ实现一个延迟队列。但愿本文可以对你们平时的学习和工做能有所启发和帮助。有什么意见或者问题欢迎在评论下方留言，谢谢！

本文首发于kissyu.org/2017/11/18/…
欢迎评论和转载！
订阅下方微信公众号，获取第一手资讯！