HandlerExceptionResolver

HandlerExceptionResolver Bean は、どの @ExceptionHandler メソッドも扱わないエラーを応答に変換します。ErrorResponse (ステータス、ヘッダー、ProblemDetail) を返すか、エラーを次に渡すために null を返します。

使う理由

ライブラリが、アプリケーションにアドバイスを書かせずに自身の例外を HTTP に対応付けるための方法です。たとえばデータスターターは、バージョンの競合に 500 ではなく 409 で応答します。アプリケーション自身の @ExceptionHandler メソッドが常に先に試されるので、アプリケーションはこれらのエラーのどれにでも独自の方法で応答できます。

ハンドラーメソッドより、コードとして書いたほうが簡単なルールのために、アプリケーションが使うこともできます。表で対応付ける例外の一群や、リクエストによって変わる対応付けなどです。

例

import 'package:spring_boot_starter_web/spring_boot_starter_web.dart';

class RoomTakenException implements Exception {}

class RoomClosedException implements Exception {
  RoomClosedException(this.until);

  final DateTime until;
}

// 部屋が埋まっていて失敗した予約には 409 で応答する。
@Component()
@Order(10)
class RoomTakenResolver implements HandlerExceptionResolver {
  @override
  ErrorResponse? resolveException(
    ServerHttpRequest request,
    Object error, {
    HandlerMethod? handler,
  }) => error is RoomTakenException
      ? ResponseStatusException(HttpStatus.conflict, 'The room is taken')
      : null;
}

// 閉鎖中の部屋: Retry-After 付きの 503。problem に日付を入れる。
@Component()
@Order(20)
class RoomClosedResolver implements HandlerExceptionResolver {
  @override
  Future<ErrorResponse?> resolveException(
    ServerHttpRequest request,
    Object error, {
    HandlerMethod? handler,
  }) async {
    if (error is! RoomClosedException) {
      return null;
    }
    return ErrorResponseException(
      HttpStatus.serviceUnavailable,
      headers: HttpHeaders()
        ..set(HttpHeaders.retryAfterHeader, HttpHeaders.formatDate(error.until)),
      body: ProblemDetail.forStatusAndDetail(
        HttpStatus.serviceUnavailable,
        'The room is closed',
      )..setProperty('until', error.until.toIso8601String()),
    );
  }
}

インターフェース

abstract interface class HandlerExceptionResolver {
  FutureOr<ErrorResponse?> resolveException(
    ServerHttpRequest request,
    Object error, {
    HandlerMethod? handler,
  });
}
パラメーター 型 意味
request ServerHttpRequest 失敗したリクエスト。
error Object エラー。
handler HandlerMethod? リクエストを処理していたコントローラーメソッド (description、beanName、annotation<A>())。メソッドが選ばれる前のエラーなら null。
戻り値 FutureOr<ErrorResponse?> 応答。このリゾルバーが扱わないエラーなら null。非同期でもよい。

ルール

ライブラリが登録するリゾルバー

データスターター: dataAccessExceptionResolver

spring_boot_starter_web と spring_boot_starter_data の両方に依存するアプリケーションは、自分で書かなくてもリゾルバーを得られます。どちらのスターターも互いに依存できないため、ジェネレーターが Bean dataAccessExceptionResolver をアプリケーションのモジュールに追加します (データベースドライバーを追加するのと同じ方法です)。

例外 ステータス 詳細
OptimisticLockingFailureException (@Version の競合) 409 The resource was changed by someone else
DuplicateKeyException 409 The resource already exists
EmptyResultDataAccessException 404 Not found
PropertyReferenceException 400 Invalid sort property
InvalidPagingRequestException 400 Invalid page or sort request
InvalidDataArgumentException 400 Invalid request value

Spring (Java) との対応

@Component
class RoomTakenResolver implements HandlerExceptionResolver {
  public ModelAndView resolveException(HttpServletRequest request,
      HttpServletResponse response, Object handler, Exception ex) {
    if (!(ex instanceof RoomTakenException)) return null;
    response.setStatus(HttpServletResponse.SC_CONFLICT);
    return new ModelAndView();
  }
}

重要な違い:

関連項目