Advanced Spring Boot 4: Event-Driven Architecture (Kafka) · Lesson

Retry Mechanisms with Spring Retry

Integrate Spring Retry to automatically re-attempt message processing upon transient failures, improving application robustness.

Retry Mechanisms with Spring Retry is a free Advanced Spring Boot 4: Event-Driven Architecture (Kafka) lesson on CoddyKit — lesson 2 of 4. You can read the complete lesson below for free — then practise it hands-on in the browser with a built-in code editor and a 24/7 AI tutor. It is part of the Advanced Spring Boot 4: Event-Driven Architecture (Kafka) learning path, one of 4 lessons in the course, and your progress syncs across the web and the CoddyKit app.

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 RetryTemplate for programmatic retry logic, demonstrating its core features.
Learned how to configure maxAttempts and different BackOffPolicy strategies (fixed and exponential).
Understood the role of @Retryable and @Recover annotations for declarative retries in a Spring context, particularly for @KafkaListener methods.

Next, we'll explore Dead Letter Topics (DLT) for handling messages that permanently fail after all retries, ensuring no data is lost.

Frequently asked questions

Is the “Retry Mechanisms with Spring Retry” lesson free?

Yes — the full text of “Retry Mechanisms with Spring Retry” is free to read here on the web, and the Advanced Spring Boot 4: Event-Driven Architecture (Kafka) course includes 4 lessons in total. To practise it interactively (a built-in code editor and a 24/7 AI tutor) and unlock the rest of the Advanced Spring Boot 4: Event-Driven Architecture (Kafka) course, upgrade to CoddyKit PRO.

What will I learn in “Retry Mechanisms with Spring Retry”?

Integrate Spring Retry to automatically re-attempt message processing upon transient failures, improving application robustness. You practise Advanced Spring Boot 4: Event-Driven Architecture (Kafka) with hands-on code you run directly in the browser, and a 24/7 AI tutor answers your questions as you work through the lesson.

Do I need any experience to start Advanced Spring Boot 4: Event-Driven Architecture (Kafka)?

No prior experience is required. Advanced Spring Boot 4: Event-Driven Architecture (Kafka) on CoddyKit is structured for beginners through advanced learners; this is — lesson 2 of 4, so you can start here or from the beginning and move at your own pace.

How long does the “Retry Mechanisms with Spring Retry” lesson take?

Most CoddyKit lessons take about 5–10 minutes. Each one is bite-sized and interactive, so you make steady progress and pick up exactly where you left off across the web and the app.

Can I write and run code in this Advanced Spring Boot 4: Event-Driven Architecture (Kafka) lesson?

Yes. Every Advanced Spring Boot 4: Event-Driven Architecture (Kafka) lesson includes a built-in code editor, so you write and run real code right in your browser and get instant AI feedback — no local setup required.

All lessons in this course

← Back to Advanced Spring Boot 4: Event-Driven Architecture (Kafka)