詳細介紹Spring Boot + RabbitMQ實現延遲佇列

wooyoo發表於2017-11-20
Spring BootMQ佇列

背景

何為延遲佇列？

顧名思義，延遲佇列就是進入該佇列的訊息會被延遲消費的佇列。而一般的佇列，訊息一旦入隊了之後就會被消費者馬上消費。

延遲佇列能做什麼？

延遲佇列多用於需要延遲工作的場景。最常見的是以下兩種場景：

  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/…
歡迎評論和轉載！
訂閱下方微信公眾號，獲取第一手資訊！

相關文章