主题命名

重试主题和 DLT 通过在主主题后面添加提供的或默认值,并在其后附加延迟或索引来命名。

示例

"my-topic" → "my-topic-retry-0", "my-topic-retry-1", …​, "my-topic-dlt"

"my-other-topic" → "my-topic-myRetrySuffix-1000", "my-topic-myRetrySuffix-2000", …​, "my-topic-myDltSuffix"

默认行为是为每次尝试创建单独的重试主题,并附加索引值:retry-0, retry-1, …​, retry-n。因此,默认情况下,重试主题的数量是配置的 maxAttempts 减 1。

您可以 配置后缀,选择是否附加 尝试索引或延迟,使用 单个重试主题时使用固定回退,以及使用 单个重试主题用于具有 maxInterval 的尝试 时使用指数回退。

重试主题和 DLT 后缀

您可以指定重试主题和 DLT 主题将使用的后缀。

@RetryableTopic(retryTopicSuffix = "-my-retry-suffix", dltTopicSuffix = "-my-dlt-suffix")
@KafkaListener(topics = "my-annotated-topic")
public void processMessage(MyPojo message) {
    // ... message processing
}
@Bean
public RetryTopicConfiguration myRetryTopic(KafkaTemplate<String, MyOtherPojo> template) {
    return RetryTopicConfigurationBuilder
            .newInstance()
            .retryTopicSuffix("-my-retry-suffix")
            .dltTopicSuffix("-my-dlt-suffix")
            .create(template);
}
默认后缀分别为“-retry”和“-dlt”,用于重试主题和 DLT。

追加主题索引或延迟

您可以在后缀之后追加主题的索引或延迟值。

@RetryableTopic(topicSuffixingStrategy = TopicSuffixingStrategy.SUFFIX_WITH_INDEX_VALUE)
@KafkaListener(topics = "my-annotated-topic")
public void processMessage(MyPojo message) {
    // ... message processing
}
@Bean
public RetryTopicConfiguration myRetryTopic(KafkaTemplate<String, MyPojo> template) {
    return RetryTopicConfigurationBuilder
            .newInstance()
            .suffixTopicsWithIndexValues()
            .create(template);
    }
默认行为是在后缀中添加延迟值,但对于具有多个主题的固定延迟配置除外,在这种情况下,主题将以主题索引为后缀。

固定延迟重试的单个主题

如果您使用固定延迟策略,例如 FixedBackOffPolicyNoBackOffPolicy,则可以使用单个主题来完成非阻塞重试。此主题将以提供的或默认后缀为后缀,并且不会追加索引或延迟值。

之前的 FixedDelayStrategy 现已弃用,可以替换为 SameIntervalTopicReuseStrategy
@RetryableTopic(backoff = @Backoff(2_000), fixedDelayTopicStrategy = FixedDelayStrategy.SINGLE_TOPIC)
@KafkaListener(topics = "my-annotated-topic")
public void processMessage(MyPojo message) {
    // ... message processing
}
@Bean
public RetryTopicConfiguration myRetryTopic(KafkaTemplate<String, MyPojo> template) {
    return RetryTopicConfigurationBuilder
            .newInstance()
            .fixedBackOff(3_000)
            .maxAttempts(5)
            .useSingleTopicForFixedDelays()
            .create(template);
}
默认行为是为每次尝试创建单独的重试主题,并以其索引值作为后缀:retry-0、retry-1、…​

最大间隔指数延迟的单个主题

如果您使用指数退避策略 (ExponentialBackOffPolicy),则可以使用单个重试主题来完成延迟为配置的 maxInterval 的尝试的非阻塞重试。

此“最终”重试主题将以提供的或默认后缀为后缀,并将追加索引或 maxInterval 值。

通过选择对具有 maxInterval 延迟的重试使用单个主题,配置长时间重试的指数重试策略可能会变得更加可行,因为在这种方法中,您不需要大量的主题。

从 3.2 开始,默认行为是使用指数退避时,对相同间隔重用重试主题,重试主题以延迟值为后缀,最后一个重试主题对相同间隔(对应于 maxInterval 延迟)进行重用。

例如,当使用 initialInterval=1_000multiplier=2maxInterval=16_000 配置指数退避时,为了持续尝试一个小时,需要将 maxAttempts 配置为 229,默认情况下,需要的重试主题将是

  • -retry-1000

  • -retry-2000

  • -retry-4000

  • -retry-8000

  • -retry-16000

当使用与重试主题数量等于配置的maxAttempts减 1 的策略时,最后一个重试主题(对应于maxInterval延迟)将以附加索引作为后缀

  • -retry-1000

  • -retry-2000

  • -retry-4000

  • -retry-8000

  • -retry-16000-0

  • -retry-16000-1

  • -retry-16000-2

  • …​

  • -retry-16000-224

如果需要多个主题,则可以使用以下配置。

@RetryableTopic(attempts = 230,
    backoff = @Backoff(delay = 1_000, multiplier = 2, maxDelay = 16_000),
    sameIntervalTopicReuseStrategy = SameIntervalTopicReuseStrategy.MULTIPLE_TOPICS)
@KafkaListener(topics = "my-annotated-topic")
public void processMessage(MyPojo message) {
    // ... message processing
}
@Bean
public RetryTopicConfiguration myRetryTopic(KafkaTemplate<String, MyPojo> template) {
    return RetryTopicConfigurationBuilder
            .newInstance()
            .exponentialBackoff(1_000, 2, 16_000)
            .maxAttempts(230)
            .useSingleTopicForSameIntervals()
            .create(template);
}

自定义命名策略

可以通过注册实现RetryTopicNamesProviderFactory的 bean 来实现更复杂的命名策略。默认实现是SuffixingRetryTopicNamesProviderFactory,可以通过以下方式注册不同的实现

@Override
protected RetryTopicComponentFactory createComponentFactory() {
    return new RetryTopicComponentFactory() {
        @Override
        public RetryTopicNamesProviderFactory retryTopicNamesProviderFactory() {
            return new CustomRetryTopicNamesProviderFactory();
        }
    };
}

例如,以下实现除了标准后缀之外,还为重试/dlt 主题名称添加了前缀

public class CustomRetryTopicNamesProviderFactory implements RetryTopicNamesProviderFactory {

    @Override
    public RetryTopicNamesProvider createRetryTopicNamesProvider(
                DestinationTopic.Properties properties) {

        if (properties.isMainEndpoint()) {
            return new SuffixingRetryTopicNamesProvider(properties);
        }
        else {
            return new SuffixingRetryTopicNamesProvider(properties) {

                @Override
                public String getTopicName(String topic) {
                    return "my-prefix-" + super.getTopicName(topic);
                }

            };
        }
    }

}