Spring Cloud Stream 使用延遲消息實(shí)現(xiàn)定時(shí)任務(wù)（RabbitMQ）

應(yīng)用場(chǎng)景

我們?cè)谑褂靡恍╅_(kāi)源調(diào)度系統(tǒng)（比如：elastic-job等）的時(shí)候，對(duì)于任務(wù)的執(zhí)行時(shí)間通常都是有規(guī)律性的，可能是每隔半小時(shí)執(zhí)行一次，或者每天凌晨一點(diǎn)執(zhí)行一次。然而實(shí)際業(yè)務(wù)中還存在另外一種定時(shí)任務(wù)，它可能需要一些觸發(fā)條件才開(kāi)始定時(shí)，比如：編寫(xiě)博文時(shí)候，設(shè)置2小時(shí)之后發(fā)送。對(duì)于這些開(kāi)始時(shí)間不確定的定時(shí)任務(wù)，我們也可以通過(guò)Spring Cloud Stream來(lái)很好的處理。

為了實(shí)現(xiàn)開(kāi)始時(shí)間不確定的定時(shí)任務(wù)觸發(fā)，我們將引入延遲消息的使用。RabbitMQ中提供了關(guān)于延遲消息的插件，所以本文就來(lái)具體介紹以下如何利用Spring Cloud Stream以及RabbitMQ輕松的處理上述問(wèn)題。

動(dòng)手試試

插件安裝

關(guān)于RabbitMQ延遲消息的插件介紹可以查看官方網(wǎng)站：https://www.rabbitmq.com/blog/2015/04/16/scheduling-messages-with-rabbitmq/

安裝方式很簡(jiǎn)單，只需要在這個(gè)頁(yè)面：http://www.rabbitmq.com/community-plugins.html 中找到rabbitmq_delayed_message_exchange插件，根據(jù)您使用的RabbitMQ版本選擇對(duì)應(yīng)的插件版本下載即可。

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

在下載好之后，解壓得到.ez結(jié)尾的插件包，將其復(fù)制到RabbitMQ安裝目錄下的plugins文件夾。

然后通過(guò)命令行啟用該插件：

rabbitmq-plugins enable rabbitmq_delayed_message_exchange

該插件在通過(guò)上述命令啟用后就可以直接使用，不需要重啟。

另外，如果您沒(méi)有啟用該插件，您可能為遇到類(lèi)似這樣的錯(cuò)誤：

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)

應(yīng)用編碼

下面通過(guò)編寫(xiě)一個(gè)簡(jiǎn)單的例子來(lái)具體體會(huì)一下這個(gè)屬性的用法：

@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;

        /**
         * 消息生產(chǎn)接口
         *
         * @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";
        }

    }

    /**
     * 消息消費(fèi)邏輯
     */
    @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();

    }

}

內(nèi)容很簡(jiǎn)單，既包含了消息的生產(chǎn)，也包含了消息消費(fèi)。在/sendMessage接口的定義中，發(fā)送了一條消息，一條消息的頭信息中包含了x-delay字段，該字段用來(lái)指定消息延遲的時(shí)間，單位為毫秒。所以上述代碼發(fā)送的消息會(huì)在5秒之后被消費(fèi)。在消息監(jiān)聽(tīng)類(lèi)TestListener中，對(duì)TestTopic.INPUT通道定義了@StreamListener，這里會(huì)對(duì)延遲消息做具體的邏輯。由于消息的消費(fèi)是延遲的，從而變相實(shí)現(xiàn)了從消息發(fā)送那一刻起開(kāi)始的定時(shí)任務(wù)。

在啟動(dòng)應(yīng)用之前，還要需要做一些必要的配置，下面分消息生產(chǎn)端和消費(fèi)端做說(shuō)明：

消息生產(chǎn)端

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

注意這里的一個(gè)新參數(shù)spring.cloud.stream.rabbit.bindings.example-topic-output.producer.delayed-exchange，用來(lái)開(kāi)啟延遲消息的功能，這樣在創(chuàng)建exchange的時(shí)候，會(huì)將其設(shè)置為具有延遲特性的exchange，也就是用到上面我們安裝的延遲消息插件的功能。

消息消費(fèi)端

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

在消費(fèi)端也一樣，需要設(shè)置spring.cloud.stream.rabbit.bindings.example-topic-output.producer.delayed-exchange=true。如果該參數(shù)不設(shè)置，將會(huì)出現(xiàn)類(lèi)似下面的錯(cuò)誤：

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)

完成了上面配置之后，就可以啟動(dòng)應(yīng)用，并嘗試訪問(wèn)localhost:8080/sendMessage?message=hello接口來(lái)發(fā)送一個(gè)消息到MQ中了。此時(shí)可以看到類(lèi)似下面的日志：

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://guest@127.0.0.1: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秒，符合我們上面編碼設(shè)置的延遲時(shí)間。

深入思考

在代碼層面已經(jīng)完成了定時(shí)任務(wù)，那么我們?nèi)绾尾榭囱舆t的消息數(shù)等信息呢？

此時(shí)，我們可以打開(kāi)RabbitMQ的Web控制臺(tái)，首先可以進(jìn)入Exchanges頁(yè)面，看看這個(gè)特殊exchange，具體如下：

image

可以看到，這個(gè)exchange的Type類(lèi)型是x-delayed-message。點(diǎn)擊該exchange的名稱，進(jìn)入詳細(xì)頁(yè)面，就可以看到更多具體信息了：

image

代碼示例

本文示例讀者可以通過(guò)查看下面?zhèn)}庫(kù)的中的stream-delayed-message項(xiàng)目：

如果您對(duì)這些感興趣，歡迎star、follow、收藏、轉(zhuǎn)發(fā)給予支持！

以下專題教程也許您會(huì)有興趣

本文首發(fā)于我的獨(dú)立博客：http://blog.didispace.com/spring-cloud-starter-finchley-7-7/

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書(shū)系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容