Spring Cloud Stream 使用延遲消息實現定時任務（RabbitMQ）

應用場景

我們在使用一些開源調度系統（比如：elastic-job等）的時候，對於任務的執行時間通常都是有規律性的，可能是每隔半小時執行一次，或者每天凌晨一點執行一次。然而實際業務中還存在另外一種定時任務，它可能需要一些觸發條件纔開始定時，比如：編寫博文時候，設置2小時之後發送。對於這些開始時間不確定的定時任務，我們也可以通過Spring Cloud Stream來很好的處理。

爲了實現開始時間不確定的定時任務觸發，我們將引入延遲消息的使用。RabbitMQ中提供了關於延遲消息的插件，所以本文就來具體介紹以下如何利用Spring Cloud Stream以及RabbitMQ輕鬆的處理上述問題。

動手試試

插件安裝

關於RabbitMQ延遲消息的插件介紹可以查看官方網站：https://www.rabbitmq.com/blog...

安裝方式很簡單，只需要在這個頁面：http://www.rabbitmq.com/commu... 中找到rabbitmq_delayed_message_exchange插件，根據您使用的RabbitMQ版本選擇對應的插件版本下載即可。

注意：只有RabbitMQ 3.6.x以上才支持

在下載好之後，解壓得到.ez結尾的插件包，將其複製到RabbitMQ安裝目錄下的plugins文件夾。

然後通過命令行啓用該插件：

rabbitmq-plugins enable rabbitmq_delayed_message_exchange

該插件在通過上述命令啓用後就可以直接使用，不需要重啓。

另外，如果您沒有啓用該插件，您可能爲遇到類似這樣的錯誤：

ERROR 156 --- [ 127.0.0.1:5672] o.s.a.r.c.CachingConnectionFactory : Channel shutdown: connection error; protocol method: #method(reply-code=503, reply-text=COMMAND_INVALID - unknown exchange type 'x-delayed-message', class-id=40, method-id=10)

應用編碼

下面通過編寫一個簡單的例子來具體體會一下這個屬性的用法：

@EnableBinding(TestApplication.TestTopic.class)
@SpringBootApplication
public class TestApplication {

    public static void main(String[] args) {
        SpringApplication.run(TestApplication.class, args);
    }

    @Slf4j
    @RestController
    static class TestController {

        @Autowired
        private TestTopic testTopic;

        /**
         * 消息生產接口
         *
         * @param message
         * @return
         */
        @GetMapping("/sendMessage")
        public String messageWithMQ(@RequestParam String message) {
            log.info("Send: " + message);
            testTopic.output().send(MessageBuilder.withPayload(message).setHeader("x-delay", 5000).build());
            return "ok";
        }

    }

    /**
     * 消息消費邏輯
     */
    @Slf4j
    @Component
    static class TestListener {

        @StreamListener(TestTopic.INPUT)
        public void receive(String payload) {
            log.info("Received: " + payload);
        }

    }

    interface TestTopic {

        String OUTPUT = "example-topic-output";
        String INPUT = "example-topic-input";

        @Output(OUTPUT)
        MessageChannel output();

        @Input(INPUT)
        SubscribableChannel input();

    }

}

內容很簡單，既包含了消息的生產，也包含了消息消費。在/sendMessage接口的定義中，發送了一條消息，一條消息的頭信息中包含了x-delay字段，該字段用來指定消息延遲的時間，單位爲毫秒。所以上述代碼發送的消息會在5秒之後被消費。在消息監聽類TestListener中，對TestTopic.INPUT通道定義了@StreamListener，這裏會對延遲消息做具體的邏輯。由於消息的消費是延遲的，從而變相實現了從消息發送那一刻起開始的定時任務。

在啓動應用之前，還要需要做一些必要的配置，下面分消息生產端和消費端做說明：

消息生產端

spring.cloud.stream.bindings.example-topic-output.destination=delay-topic
spring.cloud.stream.rabbit.bindings.example-topic-output.producer.delayed-exchange=true

注意這裏的一個新參數spring.cloud.stream.rabbit.bindings.example-topic-output.producer.delayed-exchange，用來開啓延遲消息的功能，這樣在創建exchange的時候，會將其設置爲具有延遲特性的exchange，也就是用到上面我們安裝的延遲消息插件的功能。

消息消費端

spring.cloud.stream.bindings.example-topic-input.destination=delay-topic
spring.cloud.stream.bindings.example-topic-input.group=test
spring.cloud.stream.rabbit.bindings.example-topic-input.consumer.delayed-exchange=true

在消費端也一樣，需要設置spring.cloud.stream.rabbit.bindings.example-topic-output.producer.delayed-exchange=true。如果該參數不設置，將會出現類似下面的錯誤：

ERROR 9340 --- [ 127.0.0.1:5672] o.s.a.r.c.CachingConnectionFactory       : Channel shutdown: channel error; protocol method: #method<channel.close>(reply-code=406, reply-text=PRECONDITION_FAILED - inequivalent arg 'type' for exchange 'delay-topic' in vhost '/': received 'topic' but current is ''x-delayed-message'', class-id=40, method-id=10)

完成了上面配置之後，就可以啓動應用，並嘗試訪問localhost:8080/sendMessage?message=hello接口來發送一個消息到MQ中了。此時可以看到類似下面的日誌：

2019-01-02 23:28:45.318  INFO 96164 --- [ctor-http-nio-3] c.d.s.TestApplication$TestController     : Send: hello
2019-01-02 23:28:45.328  INFO 96164 --- [ctor-http-nio-3] o.s.a.r.c.CachingConnectionFactory       : Attempting to connect to: [localhost:5672]
2019-01-02 23:28:45.333  INFO 96164 --- [ctor-http-nio-3] o.s.a.r.c.CachingConnectionFactory       : Created new connection: rabbitConnectionFactory.publisher#5c5f9a03:0/SimpleConnection@3278a728 [delegate=amqp://[email protected]:5672/, localPort= 53536]
2019-01-02 23:28:50.349  INFO 96164 --- [ay-topic.test-1] c.d.stream.TestApplication$TestListener  : Received: hello

從日誌中可以看到，Send: hello和Received: hello兩條輸出之間間隔了5秒，符合我們上面編碼設置的延遲時間。

深入思考

在代碼層面已經完成了定時任務，那麼我們如何查看延遲的消息數等信息呢？

此時，我們可以打開RabbitMQ的Web控制檯，首先可以進入Exchanges頁面，看看這個特殊exchange，具體如下：

可以看到，這個exchange的Type類型是x-delayed-message。點擊該exchange的名稱，進入詳細頁面，就可以看到更多具體信息了：

代碼示例

本文示例讀者可以通過查看下面倉庫的中的stream-delayed-message項目：

• Github
• Gitee

如果您對這些感興趣，歡迎star、follow、收藏、轉發給予支持！

以下專題教程也許您會有興趣

• Spring Boot基礎教程
• Spring Cloud基礎教程

本文首發於我的獨立博客：http://blog.didispace.com/spr...