SpringCloud 2020.0.4 系列之 Stream 延遲訊息的實現

追風人聊Java發表於2021-11-15

SpringGCCloud

1. 概述

老話說的好：對待工作要有責任心，不僅要完成自己的部分，還要定期瞭解整體的進展。

言歸正傳，我們在開發產品時，常常會遇到一段時間後檢查狀態的場景，例如：使用者下單場景，如果訂單生成30分鐘後，使用者還沒有完成支付，則系統自動將訂單關閉。

在沒有訊息中介軟體之前，常常是啟動一個定時程式，固定間隔的去檢查，不僅耗費系統資源，還會有較大的時間誤差。

今天我們就來聊一下 RabbitMQ 的延遲訊息功能的使用。

RabbitMQ 映象模式叢集的搭建，可參見我的另一篇文章《RabbitMQ 3.9.7 映象模式叢集的搭建》（https://www.cnblogs.com/w84422/p/15356202.html）

在早期的 SpringCloud 版本中常使用 @Input、@Output、@EnableBinding 和 @StreamListener 註解開發生產者與消費者。

官方原文：Deprecated as of 3.1 in favor of functional programming model。

SpringCloud 2020.0.4 版本中，已經不推薦這麼開發了，因此這裡我們也使用新的寫法（函數語言程式設計方式）開發。

閒話不多說，直接上程式碼。

2. 延遲訊息外掛的安裝

2.1 下載外掛

可以到 RabbitMQ 的官網下載，選擇與安裝的 RabbitMQ 對應的版本

官網地址：https://www.rabbitmq.com/community-plugins.html

2.2 解壓外掛

將外掛 .ez 字尾名改為 .zip，然後使用 unzip 命令解壓。

2.3 拷貝外掛到 RabbitMQ 的 plugins 資料夾下

如果是用 rpm 包的方式安裝的 RabbitMQ，路徑為： /usr/lib/rabbitmq/lib/rabbitmq_server-3.9.7/plugins

如果是 Docker 安裝，則 Docker 容器內的路徑為：/plugins

2.4 啟用延遲訊息外掛

# rabbitmq-plugins enable rabbitmq_delayed_message_exchange

2.5 重啟 RabbitMQ

# /sbin/service rabbitmq-server stop

# /sbin/service rabbitmq-server start

3. 延遲訊息傳送DEMO

3.1 主要依賴

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- 健康檢查 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-stream-rabbit</artifactId>
        </dependency>

3.2 訊息實體類

@Setter
@Getter
public class MyMessage implements java.io.Serializable {

    // 訊息體
    private String payload;
}

3.3 生產者

    // 傳送延遲訊息
    @PostMapping("/delayed")
    public String sendDelayedMessage(@RequestParam("body") String body,
                                     @RequestParam("seconds") Integer seconds) {

        MyMessage myMessage = new MyMessage();
        myMessage.setPayload(body);

        // 生產訊息
        // 第一個引數是繫結名稱，格式為：自定義的繫結名稱-out-0，myDelayed是自定義的繫結名稱，out代表生產者，0是固定寫法
        // 自定義的繫結名稱必須與消費方法的方法名保持一致
        // 第二個引數是傳送的訊息實體
        streamBridge.send("myDelayed-out-0",
                MessageBuilder.withPayload(myMessage)
                    .setHeader("x-delay", seconds * 1000)
                    .build()
        );
        log.info("傳送延遲訊息成功");
        return "SUCCESS";
    }

3.4 消費者

    // 消費延遲訊息
    @Bean
    public Consumer<Message<MyMessage>> myDelayed() {  // 方法名必須與生產訊息時自定義的繫結名稱一致

        return message -> {
            log.info("接收延遲訊息：{}", message.getPayload().getPayload());
        };
    }

3.5 application.yml 配置

spring:
  application:
    name: my-stream-new
  rabbitmq:   # RabbitMQ 配置   
    addresses: 192.168.1.12:5672
    username: guest
    password: guest
    virtual-host: /
    connection-timeout: 16000
  cloud:
    function:
      # 定義消費者，多個用分號分隔，當存在大於1個的消費者時，不定義不會生效
      definition: myDelayed
    stream:
      bindings:
        # 延遲訊息
        myDelayed-in-0: # 消費者繫結名稱，myDelayed是自定義的繫結名稱，in代表消費者，0是固定寫法
          destination: my-delayed-topic   # 對應的真實的 RabbitMQ Exchange
        myDelayed-out-0: # 生產者繫結名稱，myDelayed是自定義的繫結名稱，out代表生產者，0是固定寫法
          destination: my-delayed-topic   # 對應的真實的 RabbitMQ Exchange

      rabbit:
        bindings:
          myDelayed-in-0:
            consumer:
              delayedExchange: true  # 開啟延遲功能
          myDelayed-out-0:
            producer:
              delayedExchange: true  # 開啟延遲功能