@Async とエラー

スターターは Spring Boot の applicationTaskExecutor の Bean (別名 taskExecutor) を登録します。これは @EventListener メソッドの @Async を有効にします。そうしたリスナーは、イベントを発行した呼び出しの中ではなく、後で実行されます。スケジュールされた実行のエラーはログに出され、ErrorHandler の Bean がそれを受け取らない限り、タスクはスケジュールを保ちます。

使う理由

イベントへの反応の中には、それを発行したコードを遅くすべきでないものがあります。注文の後の確認メールの送信、監査のエントリーの書き込みなどです。そして、一度失敗した (サーバーが一時的にダウンした) スケジュールされたタスクは、永久に止まるべきでも、黙って失敗すべきでもありません。

例

@Component()
class Mailer {
  // 発行者がメールを待たずに注文は確定する。
  @EventListener()
  @Async() // 別の TaskExecutor の Bean には @Async('mailExecutor')
  Future<void> onPlaced(OrderPlaced order) => sendConfirmation(order);
}

// 失敗したすべての実行が報告され、タスクは実行され続ける。
@Component()
class ReportErrors implements ErrorHandler {
  @override
  void handleError(Object error, StackTrace stackTrace) =>
      crashReporter.record(error, stackTrace);
}

TaskExecutor

リスナー側については @Async を参照してください。

スケジュールされた実行のエラー

実行の例外 (投げられたもの、または返された Future からのもの) は、タスクの名前とともに spring.scheduling ロガーに error レベルでログに出され、タスクはスケジュールを保ちます。リトライやアラートが必要ならメソッドの中でエラーを処理するか、ErrorHandler の Bean を宣言してください。その場合、ログの代わりにそれがすべてのエラーを受け取ります。

Spring (Java) との対応

@EnableAsync
@Configuration
class AsyncConfig {}

@Async
@EventListener
public void onPlaced(OrderPlaced order) { ... }

@EnableAsync はありません。TaskExecutor の Bean がそれを有効にします。他の Bean のメソッドの @Async には対応していません。Spring は ErrorHandler をその ThreadPoolTaskScheduler に設定します。ここでは Bean が型で見つけられます。

関連項目