Java Kafka實現延遲隊列的示例代碼

Posted on by

kafka作為一個使用廣泛的消息隊列，很多人都不會陌生，但當你在網上搜索“kafka 延遲隊列”，出現的都是一些講解時間輪或者隻是提供瞭一些思路，並沒有一份真實可用的代碼實現，今天我們就來打破這個現象，提供一份可運行的代碼，拋磚引玉，吸引更多的大神來分享。

基於kafka如何實現延遲隊列

想要解決一個問題，我們需要先分解問題。kafka作為一個高性能的消息隊列，隻要消費能力足夠，發出的消息都是會立刻收到的，因此我們需要想一個辦法，讓消息延遲發送出去。

網上已經有大神給出瞭如下方案：

  • 在發送延遲消息時不直接發送到目標topic，而是發送到一個用於處理延遲消息的topic，例如delay-minutes-1
  • 寫一段代碼拉取delay-minutes-1中的消息，將滿足條件的消息發送到真正的目標主題裡。

就像畫一匹馬一樣簡單。

方案是好的，但是我們還需要更多細節。

完善細節

問題出在哪裡？

問題出在延遲消息發出去之後，代碼程序就會立刻收到延遲消息，要如何處理才能讓延遲消息等待一段時間才發送到真正的topic裡面。

可能有同學會覺得很簡單嘛，在代碼程序收到消息之後判斷條件不滿足，就調用sleep方法，過瞭一段時間我再進行下一個循環拉取消息。

真的可行嗎?

一切好像都很美好，但這是不可行的。

這是因為在輪詢kafka拉取消息的時候，它會返回由max.poll.records配置指定的一批消息，但是當程序代碼不能在max.poll.interval.ms配置的期望時間內處理這些消息的話，kafka就會認為這個消費者已經掛瞭，會進行rebalance，同時你這個消費者就無法再拉取到任何消息瞭。

舉個例子：當你需要一個24小時的延遲消息隊列，在代碼裡面寫下瞭Thread.sleep(1000*60*60*24);，為瞭不發生rebalance，你把max.poll.interval.ms 也改成瞭1000*60*60*24，這個時候你或許會感覺到一絲絲的怪異，我是誰？我在哪？我為什麼要寫出來這樣的代碼？

其實我們可以更優雅的處理這個問題。

KafkaConsumer 提供瞭暫停和恢復的API函數，調用消費者的暫停方法後就無法再拉取到新的消息，同時長時間不消費kafka也不會認為這個消費者已經掛掉瞭。另外為瞭能夠更加優雅，我們會啟動一個定時器來替換sleep。，完整流程如下圖，當消費者發現消息不滿足條件時，我們就暫停消費者，並把偏移量seek到上一次消費的位置以便等待下一個周期再次消費這條消息。

Java代碼實現

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.kafka.clients.consumer.*;
import org.apache.kafka.clients.producer.KafkaProducer;
import org.apache.kafka.clients.producer.ProducerConfig;
import org.apache.kafka.clients.producer.ProducerRecord;
import org.apache.kafka.common.TopicPartition;
import org.apache.kafka.common.serialization.StringDeserializer;
import org.apache.kafka.common.serialization.StringSerializer;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

import java.time.Duration;
import java.util.*;
import java.util.concurrent.ExecutionException;

@SpringBootTest
public class DelayQueueTest {

    private KafkaConsumer<String, String> consumer;
    private KafkaProducer<String, String> producer;
    private volatile Boolean exit = false;
    private final Object lock = new Object();
    private final String servers = "";

    @BeforeEach
    void initConsumer() {
        Properties props = new Properties();
        props.put(ConsumerConfig.BOOTSTRAP_SERVERS_CONFIG, servers);
        props.put(ConsumerConfig.GROUP_ID_CONFIG, "d");
        props.put(ConsumerConfig.ENABLE_AUTO_COMMIT_CONFIG, "false");
        props.put(ConsumerConfig.AUTO_OFFSET_RESET_CONFIG, "earliest");
        props.put(ConsumerConfig.ISOLATION_LEVEL_CONFIG, "read_committed");
        props.put(ConsumerConfig.MAX_POLL_INTERVAL_MS_CONFIG, "5000");
        consumer = new KafkaConsumer<>(props, new StringDeserializer(), new StringDeserializer());
    }

    @BeforeEach
    void initProducer() {
        Properties props = new Properties();
        props.put(ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, servers);
        props.put(ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG, StringSerializer.class.getName());
        props.put(ProducerConfig.KEY_SERIALIZER_CLASS_CONFIG, StringSerializer.class.getName());
        producer = new KafkaProducer<>(props);
    }

    @Test
    void testDelayQueue() throws JsonProcessingException, InterruptedException {
        String topic = "delay-minutes-1";
        List<String> topics = Collections.singletonList(topic);
        consumer.subscribe(topics);

        Timer timer = new Timer();
        timer.schedule(new TimerTask() {
            @Override
            public void run() {
                synchronized (lock) {
                    consumer.resume(consumer.paused());
                    lock.notify();
                }
            }
        }, 0, 1000);

        do {

            synchronized (lock) {
                ConsumerRecords<String, String> consumerRecords = consumer.poll(Duration.ofMillis(200));

                if (consumerRecords.isEmpty()) {
                    lock.wait();
                    continue;
                }

                boolean timed = false;
                for (ConsumerRecord<String, String> consumerRecord : consumerRecords) {
                    long timestamp = consumerRecord.timestamp();
                    TopicPartition topicPartition = new TopicPartition(consumerRecord.topic(), consumerRecord.partition());
                    if (timestamp + 60 * 1000 < System.currentTimeMillis()) {

                        String value = consumerRecord.value();
                        ObjectMapper objectMapper = new ObjectMapper();
                        JsonNode jsonNode = objectMapper.readTree(value);
                        JsonNode jsonNodeTopic = jsonNode.get("topic");

                        String appTopic = null, appKey = null, appValue = null;

                        if (jsonNodeTopic != null) {
                            appTopic = jsonNodeTopic.asText();
                        }
                        if (appTopic == null) {
                            continue;
                        }
                        JsonNode jsonNodeKey = jsonNode.get("key");
                        if (jsonNodeKey != null) {
                            appKey = jsonNode.asText();
                        }

                        JsonNode jsonNodeValue = jsonNode.get("value");
                        if (jsonNodeValue != null) {
                            appValue = jsonNodeValue.asText();
                        }
                        // send to application topic
                        ProducerRecord<String, String> producerRecord = new ProducerRecord<>(appTopic, appKey, appValue);
                        try {
                            producer.send(producerRecord).get();
                            // success. commit message
                            OffsetAndMetadata offsetAndMetadata = new OffsetAndMetadata(consumerRecord.offset() + 1);
                            HashMap<TopicPartition, OffsetAndMetadata> metadataHashMap = new HashMap<>();
                            metadataHashMap.put(topicPartition, offsetAndMetadata);
                            consumer.commitSync(metadataHashMap);
                        } catch (ExecutionException e) {
                            consumer.pause(Collections.singletonList(topicPartition));
                            consumer.seek(topicPartition, consumerRecord.offset());
                            timed = true;
                            break;
                        }
                    } else {
                        consumer.pause(Collections.singletonList(topicPartition));
                        consumer.seek(topicPartition, consumerRecord.offset());
                        timed = true;
                        break;
                    }
                }

                if (timed) {
                    lock.wait();
                }
            }
        } while (!exit);

    }
}

這段程序是基於SpringBoot 2.4.4版本和 kafka-client 2.7.0版本編寫的一個單元測試，需要修改私有變量servers為kafka broker的地址。

在啟動程序後，向Topic delay-minutes-1 發送如以下格式的json字符串數據

{
    "topic": "target",
    "key": "key1",
    "value": "value1"
}

同時啟動一個消費者監聽topic target，在一分鐘後，將會收到一條 key="key1", value="value1"的數據。

源代碼地址

還需要做什麼

創建多個topic用於處理不同時間的延遲消息，例如delay-minutes-1 delay-minutes-5 delay-minutes-10 delay-minutes-15以提供指數級別的延遲時間，這樣比一個topic要好很多，畢竟在順序拉取消息的時候，有一條消息不滿足條件，後面的將全部進行排隊。

 到此這篇關於Java Kafka實現延遲隊列的示例代碼的文章就介紹到這瞭,更多相關Java Kafka延遲隊列內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：