@ControllerAdvice でグローバルに例外をどう処理するのか?

Question

IT Interview Practice · Accepted Answer

すべてのコントローラメソッドを try/catch で囲む代わりに、Spring では `@ControllerAdvice` (または `@RestControllerAdvice`) を付けた 1 つのクラスにエラー処理を集約できます。`@ExceptionHandler` を付けたメソッドが、コントローラのどこで投げられた例外もキャッチし、一貫した HTTP レスポンスに変換します。

## グローバルハンドラ

```java
@RestControllerAdvice // = @ControllerAdvice + @ResponseBody
public class GlobalExceptionHandler {

// Catches this exception from ANY controller and returns 404.
    @ExceptionHandler(EntityNotFoundException.class)
    @ResponseStatus(HttpStatus.NOT_FOUND)
    public ApiError notFound(EntityNotFoundException ex) {
        return new ApiError("NOT_FOUND", ex.getMessage());
    }

// Validation failures (@Valid) throw this — turn field errors into 400.
    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public ApiError invalid(MethodArgumentNotValidException ex) {
        String msg = ex.getBindingResult().getFieldErrors().stream()
            .map(e -> e.getField() + " " + e.getDefaultMessage())
            .collect(Collectors.joining(", "));
        return new ApiError("VALIDATION", msg);
    }
}
```

これで任意のコントローラは単に `throw new EntityNotFoundException(...)` すればよく、advice がレスポンスを形作ってくれると信頼できます。

## 現代的な選択肢: ProblemDetail

Spring 6 / Boot 3 は、標準化されたエラー本文である RFC 9457 の `ProblemDetail` を同梱しています:

```java
@ExceptionHandler(PaymentDeclinedException.class)
public ProblemDetail declined(PaymentDeclinedException ex) {
    var pd = ProblemDetail.forStatusAndDetail(HttpStatus.PAYMENT_REQUIRED, ex.getMessage());
    pd.setTitle("Payment declined");
    return pd; // serialized as application/problem+json
}
```

## なぜ重要なのか

一貫した機械可読なエラーレスポンスが、プロフェッショナルな API とスタックトレースを漏らす API を分けます。面接官は、処理を集約し (DRY)、例外を *正しい* ステータスコードにマッピングし、内部の詳細をクライアントに決して公開しないことを見たがっています。`ProblemDetail` に言及すれば、Boot 3 に精通していることを示せます。

グローバルハンドラ

現代的な選択肢: ProblemDetail

なぜ重要なのか

関連する質問