使用 Spring Retry 实现重试机制
集成 Spring Retry,在发生暂时性故障时自动再次尝试处理消息,从而提升应用的健壮性。
使用 Spring Retry 实现重试机制 是 CoddyKit 上的免费 Advanced Spring Boot 4: Event-Driven Architecture (Kafka) 课时。 这是第 2 节课,共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 Advanced Spring Boot 4: Event-Driven Architecture (Kafka) 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 Advanced Spring Boot 4: Event-Driven Architecture (Kafka) 课程共包含 4 节课。
本课时的部分内容尚未翻译,以英文显示。
Why Do We Need Retries?
In distributed systems like those using Kafka, operations can sometimes fail due to temporary issues. These are called transient failures.
- Network glitches
- Temporary service unavailability
- Database connection timeouts
Retries help overcome these by automatically re-attempting failed operations, improving system resilience and reducing manual intervention.
Meet Spring Retry
Spring Retry is a powerful framework that simplifies implementing retry logic in your applications. It provides both declarative (using annotations) and programmatic (using RetryTemplate) ways to handle transient errors.
It integrates seamlessly with Spring Boot to make your applications more robust, especially when interacting with external services like Kafka.
RetryTemplate Basics
The RetryTemplate is Spring Retry's programmatic core. It allows you to wrap any code that might fail and define how it should be retried. Let's see a basic example:
import org.springframework.retry.RetryCallback;
import org.springframework.retry.RetryContext;
import org.springframework.retry.support.RetryTemplate;
public class BasicRetryDemo {
private static int attemptCount = 0;
public static void main(String[] args) {
RetryTemplate retryTemplate = new RetryTemplate();
try {
String result = retryTemplate.execute(
new RetryCallback<String, RuntimeException>() {
@Override
public String doWithRetry(RetryContext context) {
System.out.println("Executing task. Attempt: " + (++attemptCount));
if (attemptCount < 3) {
throw new RuntimeException("Simulated service failure!");
}
return "Task completed successfully!";
}
});
System.out.println(result);
} catch (RuntimeException e) {
System.out.println("Final failure: " + e.getMessage());
}
}
}Limiting Retries: Max Attempts
By default, RetryTemplate retries 3 times (1 initial attempt + 2 retries). You can configure this using a SimpleRetryPolicy. Let's set it to 4 attempts:
import org.springframework.retry.RetryCallback;
import org.springframework.retry.RetryContext;
import org.springframework.retry.support.RetryTemplate;
import org.springframework.retry.policy.SimpleRetryPolicy;
import java.util.Collections;
public class MaxAttemptsDemo {
private static int attemptCount = 0;
public static void main(String[] args) {
RetryTemplate retryTemplate = new RetryTemplate();
// Configure max attempts (1 initial + 3 retries)
SimpleRetryPolicy retryPolicy = new SimpleRetryPolicy(
4, Collections.singletonMap(RuntimeException.class, true));
retryTemplate.setRetryPolicy(retryPolicy);
try {
String result = retryTemplate.execute(
new RetryCallback<String, RuntimeException>() {
@Override
public String doWithRetry(RetryContext context) {
System.out.println("Executing task. Attempt: " + (++attemptCount));
if (attemptCount < 4) { // Fails first 3 times
throw new RuntimeException("Transient error!");
}
return "Task completed!";
}
});
System.out.println(result);
} catch (RuntimeException e) {
System.out.println("Final failure: " + e.getMessage());
}
}
}Smart Delays: Fixed Backoff
Retrying immediately might overwhelm a temporarily struggling service. A backoff policy introduces a delay between retries. FixedBackOffPolicy waits a set amount of time.
import org.springframework.retry.RetryCallback;
import org.springframework.retry.RetryContext;
import org.springframework.retry.support.RetryTemplate;
import org.springframework.retry.policy.SimpleRetryPolicy;
import org.springframework.retry.backoff.FixedBackOffPolicy;
import java.util.Collections;
public class FixedBackoffDemo {
private static int attemptCount = 0;
public static void main(String[] args) {
RetryTemplate retryTemplate = new RetryTemplate();
retryTemplate.setRetryPolicy(
new SimpleRetryPolicy(3, Collections.singletonMap(RuntimeException.class, true)));
// Configure fixed delay of 1000ms (1 second)
retryTemplate.setBackOffPolicy(new FixedBackOffPolicy(1000L));
try {
String result = retryTemplate.execute(
new RetryCallback<String, RuntimeException>() {
@Override
public String doWithRetry(RetryContext context) {
System.out.println("Attempt: " + (++attemptCount));
if (attemptCount < 3) {
throw new RuntimeException("Service busy!");
}
return "Success after retries!";
}
});
System.out.println(result);
} catch (RuntimeException e) {
System.out.println("Final failure: " + e.getMessage());
}
}
}Exponential Backoff
For services that need more time to recover, exponential backoff increases the delay after each retry. This is often more effective than a fixed delay.
ExponentialBackOffPolicy lets you set initial delay, multiplier, and max delay.
import org.springframework.retry.RetryCallback;
import org.springframework.retry.RetryContext;
import org.springframework.retry.support.RetryTemplate;
import org.springframework.retry.policy.SimpleRetryPolicy;
import org.springframework.retry.backoff.ExponentialBackOffPolicy;
import java.util.Collections;
public class ExponentialBackoffDemo {
private static int attemptCount = 0;
public static void main(String[] args) {
RetryTemplate retryTemplate = new RetryTemplate();
retryTemplate.setRetryPolicy(
new SimpleRetryPolicy(4, Collections.singletonMap(RuntimeException.class, true)));
// Configure exponential backoff
ExponentialBackOffPolicy backOffPolicy = new ExponentialBackOffPolicy();
backOffPolicy.setInitialInterval(100L); // 100ms
backOffPolicy.setMultiplier(2.0); // Doubles each time
backOffPolicy.setMaxInterval(2000L); // Max 2 seconds
retryTemplate.setBackOffPolicy(backOffPolicy);
try {
String result = retryTemplate.execute(
new RetryCallback<String, RuntimeException>() {
@Override
public String doWithRetry(RetryContext context) {
System.out.println("Attempt: " + (++attemptCount));
if (attemptCount < 4) {
throw new RuntimeException("Resource contention!");
}
return "Success after exponential backoff!";
}
});
System.out.println(result);
} catch (RuntimeException e) {
System.out.println("Final failure: " + e.getMessage());
}
}
}Retry on Specific Errors
You might only want to retry on certain types of exceptions, not all. SimpleRetryPolicy allows you to specify which exceptions should trigger a retry.
Exceptions not in the list will cause immediate failure.
import org.springframework.retry.RetryCallback;
import org.springframework.retry.RetryContext;
import org.springframework.retry.support.RetryTemplate;
import org.springframework.retry.policy.SimpleRetryPolicy;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
public class SpecificExceptionDemo {
private static int attemptCount = 0;
public static void main(String[] args) {
RetryTemplate retryTemplate = new RetryTemplate();
Map<Class<? extends Throwable>, Boolean> retryableExceptions = new HashMap<>();
retryableExceptions.put(IOException.class, true); // Only retry IOException
retryableExceptions.put(MyCustomTransientException.class, true);
SimpleRetryPolicy retryPolicy = new SimpleRetryPolicy(3, retryableExceptions);
retryTemplate.setRetryPolicy(retryPolicy);
try {
String result = retryTemplate.execute(
new RetryCallback<String, Exception>() { // Note: now throws Exception
@Override
public String doWithRetry(RetryContext context) throws Exception {
System.out.println("Attempt: " + (++attemptCount));
if (attemptCount == 1) {
throw new IOException("Network issue!"); // Will retry
} else if (attemptCount == 2) {
throw new MyCustomTransientException("DB lock!"); // Will retry
} else if (attemptCount == 3) {
throw new IllegalArgumentException("Bad data!"); // Will NOT retry
}
return "Success!";
}
});
System.out.println(result);
} catch (Exception e) {
System.out.println("Final failure: " + e.getClass().getSimpleName() + " - " + e.getMessage());
}
}
static class MyCustomTransientException extends RuntimeException {
public MyCustomTransientException(String message) { super(message); }
}
}Handling Final Failures: @Recover
What happens if all retries are exhausted and the operation still fails? You need a fallback!
In a Spring context, the @Recover annotation marks a method to be called when a @Retryable method permanently fails. It lets you provide alternative logic or gracefully log the error.
For RetryTemplate, you can provide a RecoveryCallback to achieve similar fallback behavior.
Spring Kafka Listener Retries
For Spring Boot Kafka consumers, you can apply the @Retryable annotation directly to your @KafkaListener methods. This ensures that if message processing fails, the listener will retry before the message is potentially sent to a Dead Letter Topic (DLT).
Remember to enable Spring Retry with @EnableRetry on your application class!
import org.springframework.kafka.annotation.KafkaListener;
import org.springframework.retry.annotation.Retryable;
import org.springframework.stereotype.Component;
import org.springframework.retry.backoff.Backoff;
// This is a conceptual example for a Kafka Listener.
// It requires a running Kafka broker and Spring Boot app.
@Component
public class MyKafkaListener {
private int processAttempts = 0;
@KafkaListener(topics = "myTopic", groupId = "myGroup")
@Retryable(
value = {RuntimeException.class}, // Retry on RuntimeException
maxAttempts = 5,
backoff = @Backoff(delay = 1000) // Initial 1s delay
)
public void listen(String message) {
processAttempts++;
System.out.println("Processing message: '" + message + "' (Attempt " + processAttempts + ")");
if (processAttempts < 3) { // Simulate failure for first 2 processing attempts
throw new RuntimeException("Failed to process: " + message);
}
processAttempts = 0; // Reset for next message
System.out.println("Successfully processed: " + message);
}
}
public class Main {
public static void main(String[] args) {
System.out.println("This code demonstrates @Retryable on a @KafkaListener method.");
System.out.println("It would run within a Spring Boot application connected to Kafka.");
}
}Retry Configuration Check
You are building a Kafka consumer that processes orders. Sometimes, the external payment service is temporarily unavailable. You want to retry processing an order up to 5 times, with an initial delay of 500ms, doubling each time, but not exceeding 5 seconds. Which configuration for @Retryable is correct?
Recap: Spring Retry
In this lesson, you learned how to make your Kafka consumers more resilient using Spring Retry:
- Understood the need for retries for transient failures in distributed systems.
- Explored
RetryTemplatefor programmatic retry logic, demonstrating its core features. - Learned how to configure
maxAttemptsand differentBackOffPolicystrategies (fixed and exponential). - Understood the role of
@Retryableand@Recoverannotations for declarative retries in a Spring context, particularly for@KafkaListenermethods.
Next, we'll explore Dead Letter Topics (DLT) for handling messages that permanently fail after all retries, ensuring no data is lost.
常见问题解答
「使用 Spring Retry 实现重试机制」课时是免费的吗?
是的 — 「使用 Spring Retry 实现重试机制」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 Advanced Spring Boot 4: Event-Driven Architecture (Kafka) 课程的其余内容,请升级到 CoddyKit PRO。 Advanced Spring Boot 4: Event-Driven Architecture (Kafka) 课程共包含 4 节课。
「使用 Spring Retry 实现重试机制」这节课中我会学到什么?
集成 Spring Retry,在发生暂时性故障时自动再次尝试处理消息,从而提升应用的健壮性。 你通过在浏览器中直接运行的动手代码来练习 Advanced Spring Boot 4: Event-Driven Architecture (Kafka),全天候 AI 导师会在你学习这节课的过程中回答你的问题。
学习 Advanced Spring Boot 4: Event-Driven Architecture (Kafka) 需要有经验吗?
无需任何先前经验。CoddyKit 上的 Advanced Spring Boot 4: Event-Driven Architecture (Kafka) 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 2 节课,共 4 节。
「使用 Spring Retry 实现重试机制」课时需要多长时间?
大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。
我能在这节 Advanced Spring Boot 4: Event-Driven Architecture (Kafka) 课中编写并运行代码吗?
能。每节 Advanced Spring Boot 4: Event-Driven Architecture (Kafka) 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。
此课程中的所有课时
- 处理消费者异常
- 使用 Spring Retry 实现重试机制
- 实现死信主题(DLT)
- 使用重试主题实现非阻塞重试