API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) · Lesson

Circuit Breakers with Resilience4j

Integrate Resilience4j to implement circuit breaker patterns, preventing cascading failures in your microservices.

Circuit Breakers with Resilience4j is a free API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) lesson on CoddyKit — lesson 1 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 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) learning path, one of 4 lessons in the course, and your progress syncs across the web and the CoddyKit app.

Microservices & Resilience

In a microservices architecture, many small services work together. While powerful, this interconnectedness can be a weakness.

If one service becomes slow or unresponsive, requests can pile up, leading to other services waiting, which then slows them down too. This is called a cascading failure and can bring down your entire system!

What's a Circuit Breaker?

Think of an electrical circuit breaker in your home. If there's an overload, it 'trips' to prevent damage.

In software, a Circuit Breaker pattern does the same. It stops continuous calls to a failing service, giving that service time to recover and preventing the failure from spreading.

Instead of hammering a broken service, the circuit breaker 'fails fast' by immediately returning an error or a fallback response.

Introducing Resilience4j

Resilience4j is a lightweight, fault-tolerance library inspired by Netflix Hystrix. It's designed for functional programming and integrates seamlessly with Spring Boot.

It provides various resilience patterns, including Circuit Breaker, Rate Limiter, Retry, and Bulkhead, helping you build more robust microservices.

The Three States of a Circuit

A Circuit Breaker operates in three main states:

CLOSED: This is the normal state. Requests pass through to the protected service. If failures exceed a configured threshold, it transitions to OPEN.
OPEN: No requests are allowed through. All calls fail immediately. After a configured wait duration, it transitions to HALF_OPEN.
HALF_OPEN: A limited number of test requests are allowed. If these succeed, the circuit CLOSEs. If they fail, it re-OPENs.

Setting Up Resilience4j

To use Resilience4j with Spring Boot, you need to add the necessary dependencies to your pom.xml (for Maven) or build.gradle (for Gradle).

These dependencies provide the core Circuit Breaker functionality and Spring Boot integration.

<!-- Maven (pom.xml) -->
<dependency>
    <groupId>io.github.resilience4j</groupId>
    <artifactId>resilience4j-spring-boot2</artifactId>
    <version>1.7.1</version>
</dependency>
<dependency>
    <groupId>io.github.resilience4j</groupId>
    <artifactId>resilience4j-circuitbreaker</artifactId>
    <version>1.7.1</version>
</dependency>

Basic Circuit Breaker Config

You configure Circuit Breakers in your application.yml or application.properties. Here's a basic example:

failureRateThreshold: Percentage of failures to open the circuit.
waitDurationInOpenState: How long the circuit stays open.
slidingWindowSize: Number of calls to consider for failure rate.

resilience4j.circuitbreaker:
  instances:
    myBackendService:
      failureRateThreshold: 50
      waitDurationInOpenState: 5s
      slidingWindowType: COUNT_BASED
      slidingWindowSize: 10

Protecting a Service Call

With Spring Boot, you can easily apply a Circuit Breaker using the @CircuitBreaker annotation on the method you want to protect.

Specify the name of your configured circuit breaker instance and an optional fallbackMethod.

import io.github.resilience4j.circuitbreaker.annotation.CircuitBreaker;
import org.springframework.stereotype.Service;

@Service
public class MyExternalService {

    @CircuitBreaker(name = "myBackendService", fallbackMethod = "reliableFallback")
    public String callReliableApi() {
        // Simulate an API call that might fail
        if (Math.random() < 0.7) {
            throw new RuntimeException("API call failed!");
        }
        return "Data from API";
    }

    public String reliableFallback(Throwable t) {
        return "Fallback: Service is currently unavailable.";
    }
}

Hands-on with Resilience4j

Let's see a Circuit Breaker in action! This runnable example simulates calls to a service that frequently fails, demonstrating the state transitions.

Observe how the circuit opens after several failures and then tries to half-open after a delay.

import io.github.resilience4j.circuitbreaker.CircuitBreaker;
import io.github.resilience4j.circuitbreaker.CircuitBreakerConfig;
import io.vavr.CheckedFunction0;
import java.time.Duration;

public class Main {
    public static void main(String[] args) {
        CircuitBreakerConfig config = CircuitBreakerConfig.custom()
            .failureRateThreshold(50) // 50% failure rate to open
            .waitDurationInOpenState(Duration.ofSeconds(2))
            .slidingWindowSize(10)
            .slidingWindowType(CircuitBreakerConfig.SlidingWindowType.COUNT_BASED)
            .build();

        CircuitBreaker circuitBreaker = CircuitBreaker.of("myTestService", config);

        circuitBreaker.getEventPublisher()
            .onStateTransition(event -> System.out.println("\nCircuit Breaker State Transition: " + event.getOldState() + " -> " + event.getNewState() + "\n"));

        System.out.println("Simulating 20 service calls...");
        for (int i = 1; i <= 20; i++) {
            try {
                String result = circuitBreaker.executeCheckedSupplier(
                    (CheckedFunction0<String>) () -> {
                        if (Math.random() < 0.6) { // Simulate 60% failure
                            System.out.println("  Call " + i + ": Service failed!");
                            throw new RuntimeException("Simulated Service Error");
                        }
                        System.out.println("  Call " + i + ": Service succeeded.");
                        return "Data from Service";
                    });
                System.out.println("  -> Result: " + result);
            } catch (Throwable t) {
                System.out.println("  -> Result: Fallback/Circuit OPEN! Message: " + t.getMessage());
            }
            try {
                Thread.sleep(200); // Pause to observe behavior
            } catch (InterruptedException e) {
                Thread.currentThread().interrupt();
            }
        }
        System.out.println("\nSimulation complete. Final state: " + circuitBreaker.getState());
    }
}

Handling Fallbacks Gracefully

The fallbackMethod is crucial. When the protected method fails (either due to an exception or the circuit being OPEN), this method is invoked instead.

It allows you to provide a default response, cached data, or a simplified experience to the user, preventing a complete failure of the user's request.

Always ensure your fallback method has the same return type and accepts a Throwable as its last argument.

Key Configuration Parameters

Understanding these parameters helps you fine-tune your Circuit Breaker:

failureRateThreshold: The percentage of failures that will cause the circuit to open.
waitDurationInOpenState: The duration the circuit will stay in the OPEN state before transitioning to HALF_OPEN.
slidingWindowSize: The number of calls that are recorded and used to calculate the failure rate.
slidingWindowType: Can be COUNT_BASED (a fixed number of calls) or TIME_BASED (calls within a certain time window).

Quick Check: Circuit States

Which of the following conditions might cause a Circuit Breaker to transition from CLOSED to OPEN state in Resilience4j?

Recap: Guarding Your Services

You've learned that Circuit Breakers are an essential pattern for building resilient microservices. They prevent cascading failures by 'tripping' when a service is unhealthy, giving it time to recover.

Resilience4j provides a lightweight and powerful way to implement these patterns in your Spring Cloud Gateway or Spring Boot applications. You now understand its states, basic configuration, and how to apply it to protect your services.

Frequently asked questions

Is the “Circuit Breakers with Resilience4j” lesson free?

Yes — the full text of “Circuit Breakers with Resilience4j” is free to read here on the web, and the API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) 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 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) course, upgrade to CoddyKit PRO.

What will I learn in “Circuit Breakers with Resilience4j”?

Integrate Resilience4j to implement circuit breaker patterns, preventing cascading failures in your microservices. You practise API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) 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 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)?

No prior experience is required. API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) on CoddyKit is structured for beginners through advanced learners; this is — lesson 1 of 4, so you can start here or from the beginning and move at your own pace.

How long does the “Circuit Breakers with Resilience4j” 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 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) lesson?

Yes. Every API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) 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

Circuit Breakers with Resilience4j
Retries & Timeouts Configuration
Error Handling & Fallbacks
Bulkheads & Rate Limiting for Resilience

← Back to API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)