-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
GH-2226: Add RetryTopicConfigurationSupport
Resolves #2226 Add RetryTopicConfigurationSupport Add @EnableRetryTopic Add KafkaBackOffManagerConfigurationSupport
- Loading branch information
1 parent
0278465
commit e5b0cac
Showing
16 changed files
with
839 additions
and
73 deletions.
There are no files selected for viewing
87 changes: 87 additions & 0 deletions
87
spring-kafka/src/main/java/org/springframework/kafka/annotation/EnableRetryTopic.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| /* | ||
| * Copyright 2022 the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.springframework.kafka.annotation; | ||
|
|
||
| import java.lang.annotation.Documented; | ||
| import java.lang.annotation.ElementType; | ||
| import java.lang.annotation.Retention; | ||
| import java.lang.annotation.RetentionPolicy; | ||
| import java.lang.annotation.Target; | ||
|
|
||
| import org.springframework.context.annotation.Configuration; | ||
| import org.springframework.context.annotation.Import; | ||
| import org.springframework.kafka.config.KafkaBackOffManagerConfigurationSupport; | ||
| import org.springframework.kafka.config.RetryTopicConfigurationSupport; | ||
|
|
||
| /** | ||
| * Enables the non-blocking topic-based delayed retries feature. To be used in | ||
| * {@link Configuration Configuration} classes as follows: | ||
| * <pre class="code"> | ||
| * | ||
| * @EnableRetryTopic | ||
| * @Configuration | ||
| * public class AppConfig { | ||
| * | ||
| * @Bean | ||
| * public RetryTopicConfiguration myRetryTopicConfiguration(KafkaTemplate kafkaTemplate) { | ||
| * return RetryTopicConfigurationBuilder | ||
| * .newInstance() | ||
| * .maxAttempts(4) | ||
| * .create(kafkaTemplate); | ||
| * } | ||
| * // other @Bean definitions | ||
| * } | ||
| * </pre> | ||
| * | ||
| * To configure the feature's components, extend the {@link RetryTopicConfigurationSupport} | ||
| * class and override the appropriate methods. Then import the subclass using the | ||
| * {@link Import @Import} annotation on a {@link Configuration @Configuration} class, | ||
| * such as: | ||
| * | ||
| * <pre class="code"> | ||
| * | ||
| * @Configuration | ||
| * @EnableKafka | ||
| * @Import(MyRetryTopicConfigurationSupport.class) | ||
| * public class AppConfig { | ||
| * } | ||
| * | ||
| * public static class MyRetryTopicConfigurationSupport extends RetryTopicConfigurationSupport { | ||
| * | ||
| * @Override | ||
| * protected void configureBlockingRetries(BlockingRetriesConfigurer blockingRetries) { | ||
| * blockingRetries | ||
| * .retryOn(ShouldRetryOnlyBlockingException.class, ShouldRetryViaBothException.class) | ||
| * .backOff(new FixedBackOff(50, 3)); | ||
| * } | ||
| * | ||
| * @Override | ||
| * protected void configureNonBlockingRetries(NonBlockingRetriesConfigurer nonBlockingRetries) { | ||
| * nonBlockingRetries | ||
| * .addToFatalExceptions(ShouldSkipBothRetriesException.class); | ||
| * } | ||
| * </pre> | ||
| * | ||
| * @author Tomaz Fernandes | ||
| * @since 2.9 | ||
| */ | ||
| @Retention(RetentionPolicy.RUNTIME) | ||
| @Target(ElementType.TYPE) | ||
| @Documented | ||
| @Import({RetryTopicConfigurationSupport.class, KafkaBackOffManagerConfigurationSupport.class}) | ||
| public @interface EnableRetryTopic { | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
108 changes: 108 additions & 0 deletions
108
...c/main/java/org/springframework/kafka/config/KafkaBackOffManagerConfigurationSupport.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| /* | ||
| * Copyright 2022 the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.springframework.kafka.config; | ||
|
|
||
| import java.time.Clock; | ||
|
|
||
| import org.springframework.beans.BeansException; | ||
| import org.springframework.beans.factory.annotation.Qualifier; | ||
| import org.springframework.context.ApplicationContext; | ||
| import org.springframework.context.ApplicationContextAware; | ||
| import org.springframework.context.ApplicationListener; | ||
| import org.springframework.context.ConfigurableApplicationContext; | ||
| import org.springframework.context.annotation.Bean; | ||
| import org.springframework.context.event.ContextClosedEvent; | ||
| import org.springframework.core.task.TaskExecutor; | ||
| import org.springframework.kafka.listener.KafkaConsumerBackoffManager; | ||
| import org.springframework.kafka.listener.KafkaConsumerTimingAdjuster; | ||
| import org.springframework.kafka.listener.ListenerContainerRegistry; | ||
| import org.springframework.kafka.listener.PartitionPausingBackoffManager; | ||
| import org.springframework.kafka.listener.WakingKafkaConsumerTimingAdjuster; | ||
| import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor; | ||
| import org.springframework.util.Assert; | ||
|
|
||
| /** | ||
| * This class provides configuration support for a global | ||
| * {@link KafkaConsumerBackoffManager} instance. Consider overriding any of the | ||
| * protected methods for providing different components or configuration. | ||
| * This class is automatically imported by the | ||
| * {@link org.springframework.kafka.annotation.EnableRetryTopic @EnableRetryTopic} | ||
| * annotation. | ||
| * | ||
| * @author Tomaz Fernandes | ||
| * @since 2.9 | ||
| */ | ||
| public class KafkaBackOffManagerConfigurationSupport implements ApplicationContextAware { | ||
|
|
||
| private ConfigurableApplicationContext applicationContext; | ||
|
|
||
| /** | ||
| * Provides the {@link KafkaConsumerBackoffManager} instance. | ||
| * To customize it or any of the components, consider overriding | ||
| * one of the more fine graned methods: | ||
| * <ul> | ||
| * <li>{@link #backOffManagerClock}</li> | ||
| * <li>{@link #timingAdjuster}</li> | ||
| * <li>{@link #timingAdjusterTaskExecutor}</li> | ||
| * </ul> | ||
| * @param registry the global {@link ListenerContainerRegistry} instance. | ||
| * @return the instance. | ||
| */ | ||
| @Bean(name = KafkaListenerConfigUtils.KAFKA_CONSUMER_BACK_OFF_MANAGER_BEAN_NAME) | ||
| public KafkaConsumerBackoffManager kafkaConsumerBackoffManager(@Qualifier(KafkaListenerConfigUtils.KAFKA_LISTENER_ENDPOINT_REGISTRY_BEAN_NAME) | ||
| ListenerContainerRegistry registry) { | ||
| return new PartitionPausingBackoffManager(registry, timingAdjuster(timingAdjusterTaskExecutor()), backOffManagerClock()); | ||
| } | ||
|
|
||
| /** | ||
| * Override this method to provide a different {@link Clock} | ||
| * instance to be used with the {@link KafkaConsumerBackoffManager}. | ||
| * @return the instance. | ||
| */ | ||
| protected Clock backOffManagerClock() { | ||
| return Clock.systemUTC(); | ||
| } | ||
|
|
||
| /** | ||
| * Override this method to provide a different {@link KafkaConsumerTimingAdjuster} | ||
| * to be used with the {@link KafkaConsumerBackoffManager}. | ||
| * @param taskExecutor the task executor. | ||
| * @return the instance. | ||
| */ | ||
| protected KafkaConsumerTimingAdjuster timingAdjuster(TaskExecutor taskExecutor) { | ||
| return new WakingKafkaConsumerTimingAdjuster(taskExecutor); | ||
| } | ||
|
|
||
| /** | ||
| * Override this method to provide a different {@link TaskExecutor} | ||
| * to be used with the {@link KafkaConsumerTimingAdjuster}. | ||
| * @return the instance. | ||
| */ | ||
| protected TaskExecutor timingAdjusterTaskExecutor() { | ||
| ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor(); | ||
| executor.initialize(); | ||
| this.applicationContext | ||
| .addApplicationListener((ApplicationListener<ContextClosedEvent>) event -> executor.shutdown()); | ||
| return executor; | ||
| } | ||
|
|
||
| @Override | ||
| public void setApplicationContext(ApplicationContext applicationContext) throws BeansException { | ||
| Assert.isInstanceOf(ConfigurableApplicationContext.class, applicationContext); | ||
| this.applicationContext = (ConfigurableApplicationContext) applicationContext; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.