API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) · レッスン

Resilience4jによるサーキットブレーカー

Resilience4jを統合してサーキットブレーカーパターンを実装し、マイクロサービスでの障害の連鎖を防ぎます。

「Resilience4jによるサーキットブレーカー」はCoddyKit上の無料API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)レッスンです。これはレッスン1/4です。下記で完全なレッスンを無料で読むことができます。その後、ブラウザ内の組み込みコードエディタと24時間対応のAIチューターでハンズオン演習できます。これはAPI Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)学習パスの一部であり、ウェブとCoddyKitアプリ全体で進捗が同期されます。 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)コースには全4レッスンが含まれています。

このレッスンの一部はまだ翻訳されておらず、英語で表示されています。

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.

よくある質問

「Resilience4jによるサーキットブレーカー」レッスンは無料ですか？

はい。「Resilience4jによるサーキットブレーカー」の完全なテキストはこのウェブで無料で読めます。インタラクティブに演習し（組み込みコードエディタと24時間対応のAIチューター）、API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)コースの残りをアンロックするには、CoddyKit PROにアップグレードしてください。 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)コースには全4レッスンが含まれています。

「Resilience4jによるサーキットブレーカー」で何を学びますか？

Resilience4jを統合してサーキットブレーカーパターンを実装し、マイクロサービスでの障害の連鎖を防ぎます。ブラウザで直接実行するハンズオンコードでAPI Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)を演習し、24時間対応のAIチューターがレッスンを進める中での質問に答えます。

API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)を始めるのに経験は必要ですか？

事前経験は必要ありません。CoddyKitのAPI Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)は初級者から上級者向けに構成されているため、ここから始めるか最初から始めて、自分のペースで進むことができます。これはレッスン1/4です。

「Resilience4jによるサーキットブレーカー」レッスンにはどのくらい時間がかかりますか？

ほとんどのCoddyKitレッスンは約5～10分かかります。各レッスンはコンパクトでインタラクティブなので、着実に進歩し、ウェブとアプリ全体で正確に前回の場所から再開できます。

このAPI Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)レッスンでコードを書いて実行できますか？

はい。すべてのAPI Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)レッスンに組み込みコードエディタが含まれているため、ブラウザでリアルコードを書いて実行し、即座のAIフィードバックを取得できます。ローカル設定は不要です。

このコースのすべてのレッスン

← API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)に戻る