はじめに
Webアプリケーションにおいて一時的なネットワーク障害や外部APIの応答遅延といったエラーが発生することがあります。
これらのエラーは再試行（リトライ）によって回避できる場合がありますが、手動でリトライロジックを実装するのはなかなか面倒です。
そこでSpringに備わっている機能のSpring Retryを使うことで、簡単にリトライ機能を実装することができます。
Spring Retryとは？
Spring Retryは、Springプロジェクトに含まれるライブラリで、例外発生時に処理を再試行するための簡単な方法を提供してくれます。
このライブラリを使うことで、以下のようなケースでリトライロジックを自動的に実装できます。
- ネットワークの一時的な障害
- 外部APIのタイムアウト
- 一時的なデータベースエラー
Spring Retryは、アノテーションベースで簡単に設定でき、リトライ間隔やリトライ回数、特定の例外に対してのみリトライを行う設定が可能です。
Spring Retryのセットアップ
まず、Spring Retryを使用するために依存関係を追加します。spring-retryライブラリとspring-aspectsライブラリが必要です。
Gradleの場合
implementation 'org.springframework.retry:spring-retry'
implementation 'org.springframework:spring-aspects'
Mavenの場合
<dependency>
<groupId>org.springframework.retry</groupId>
<artifactId>spring-retry</artifactId>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-aspects</artifactId>
</dependency>
基本的な使い方
Spring Retryでは、@Retryableアノテーションを使って簡単にリトライ機能を実装できます。以下は、ネットワークエラーに対してリトライを行う例です。
import org.springframework.retry.annotation.Backoff;
import org.springframework.retry.annotation.Retryable;
import org.springframework.stereotype.Service;
@Service
public class ApiService {
@Retryable(
value = { RuntimeException.class },
maxAttempts = 5,
backoff = @Backoff(delay = 2000)
)
public String callExternalApi() {
// 外部APIへのリクエスト処理
if (someTemporaryCondition()) {
throw new RuntimeException("Temporary error occurred");
}
return "Success";
}
}
説明
-
@Retryable: 指定された例外が発生した場合に、リトライ処理を行います。 -
value: リトライの対象となる例外を指定します。この場合、RuntimeExceptionが対象です。 -
maxAttempts: リトライの回数を指定します。例では最大5回リトライします。 -
backoff: リトライ間の待機時間を設定します。この例では2秒間（2000ms）の間隔を空けてリトライを行います。
リトライ後の処理
リトライが失敗した後に特定の処理を行いたい場合は、@Recoverアノテーションを使用します。以下は、全てのリトライが失敗した場合にフォールバック処理を行う例です。
import org.springframework.retry.annotation.Recover;
import org.springframework.stereotype.Service;
@Service
public class ApiService {
@Retryable(
value = { RuntimeException.class },
maxAttempts = 5,
backoff = @Backoff(delay = 2000)
)
public String callExternalApi() {
// 外部APIへのリクエスト処理
if (someTemporaryCondition()) {
throw new RuntimeException("Temporary error occurred");
}
return "Success";
}
@Recover
public String recover(RuntimeException e) {
// リトライがすべて失敗した後のフォールバック処理
return "Fallback response due to error: " + e.getMessage();
}
}
説明
-
@Recover: リトライが失敗した後に実行されるメソッドです。このメソッドは、リトライの対象となる例外をパラメータとして受け取ることができます。 - フォールバック処理: リトライが全て失敗した場合に代わりに返す応答などを定義できます。
リトライ設定の共通設定
Spring Retryでは、リトライの挙動を細かくカスタマイズすることが可能です。
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.retry.annotation.EnableRetry;
import org.springframework.retry.support.RetryTemplate;
@Configuration
@EnableRetry
public class RetryConfig {
@Bean
public RetryTemplate retryTemplate() {
RetryTemplate retryTemplate = new RetryTemplate();
retryTemplate.setRetryPolicy(new SimpleRetryPolicy(3)); // リトライの回数や条件を設定する
retryTemplate.setBackOffPolicy(new FixedBackOffPolicy() {{
setBackOffPeriod(1000); // リトライ間の待機時間を制御する
}});
return retryTemplate;
}
}
まとめ
Spring Retryを使用することで、一時的なエラーや障害に対して自動的にリトライ処理を実装でき、システムの信頼性を向上させることができます。
シンプルな@Retryableアノテーションから、RetryTemplateを使った高度なカスタマイズまで、さまざまなリトライロジックを手軽に導入できます。