【PHP8.x】getPreviousメソッドの使い方

Copy
1<?php
2
3/**
4 * このクラスは、PHPの内部クラスであるRequestParseBodyExceptionを
5 * サンプルコード内で使用可能にするためのダミー定義です。
6 * 実際のPHP環境では、RequestParseBodyExceptionは内部で定義されており、
7 * ユーザーコードが再定義することはできません。
8 * この定義は、getPrevious()メソッドの動作をデモンストレーションするためだけに存在します。
9 */
10if (!class_exists('RequestParseBodyException')) {
11    class RequestParseBodyException extends RuntimeException
12    {
13    }
14}
15
16/**
17 * 例外チェーンにおけるgetPrevious()メソッドの動作をデモンストレーションします。
18 * RequestParseBodyExceptionもThrowableインターフェースを実装しており、
19 * 同様にgetPrevious()メソッドを使用して前の例外を取得できます。
20 */
21function demonstrateRequestParseBodyExceptionGetPrevious(): void
22{
23    try {
24        // シナリオ1: 最初に発生した下位レベルの例外。
25        // 例えば、予期しないデータ形式やバリデーションエラーなど。
26        throw new InvalidArgumentException("無効なJSONフォーマットです。");
27    } catch (InvalidArgumentException $e) {
28        // シナリオ2: 下位レベルの例外をキャッチし、それを原因として
29        // RequestParseBodyExceptionをスローする状況をシミュレートします。
30        // これは、リクエストボディ解析中に根本的な問題が発見された場合を想定しています。
31        throw new RequestParseBodyException(
32            "リクエストボディの解析に失敗しました。",
33            0, // エラーコード（オプション）
34            $e  // 発生した下位レベルの例外を「前の例外」として渡す
35        );
36    }
37}
38
39// メインの実行ブロック
40try {
41    demonstrateRequestParseBodyExceptionGetPrevious();
42} catch (Throwable $e) { // Throwableは全てのExceptionとErrorの基底インターフェース
43    echo "メインのtry-catchブロックで例外をキャッチしました。\n";
44    echo "--------------------------------------------------\n";
45    echo "現在の例外情報:\n";
46    echo "  メッセージ: " . $e->getMessage() . "\n";
47    echo "  クラス名: " . get_class($e) . "\n";
48    echo "  ファイル: " . $e->getFile() . " (行: " . $e->getLine() . ")\n";
49    echo "  スタックトレース:\n" . $e->getTraceAsString() . "\n\n";
50
51    // getPrevious()メソッドを使用して、この例外の前の例外を取得します。
52    // 戻り値は ?Throwable (Throwableオブジェクトまたはnull) です。
53    $previousException = $e->getPrevious();
54
55    if ($previousException !== null) {
56        echo "--------------------------------------------------\n";
57        echo "前の例外情報:\n";
58        echo "  メッセージ: " . $previousException->getMessage() . "\n";
59        echo "  クラス名: " . get_class($previousException) . "\n";
60        echo "  ファイル: " . $previousException->getFile() . " (行: " . $previousException->getLine() . ")\n";
61        echo "  スタックトレース:\n" . $previousException->getTraceAsString() . "\n";
62    } else {
63        echo "前の例外は見つかりませんでした。\n";
64    }
65    echo "--------------------------------------------------\n";
66}
67
68?>

このPHPサンプルコードは、例外が入れ子になっている状況（例外チェーン）で、現在の例外の「原因となった前の例外」を取得するgetPrevious()メソッドの動作を示しています。RequestParseBodyExceptionは、リクエストボディの解析に失敗した際に内部で発生する例外ですが、他の例外と同様にgetPrevious()メソッドを持っています。

サンプルコードでは、demonstrateRequestParseBodyExceptionGetPrevious関数内でまずInvalidArgumentExceptionが発生し、これがキャッチされた後、この例外を原因としてRequestParseBodyExceptionが新しくスローされます。この際、RequestParseBodyExceptionのコンストラクタの第3引数に元のInvalidArgumentExceptionを渡すことで、二つの例外が関連付けられます。

メインのtry-catchブロックでRequestParseBodyExceptionをキャッチすると、getPrevious()メソッドを使って、その根本原因であるInvalidArgumentExceptionを取得し、その詳細情報を表示できます。このメソッドは引数を取らず、戻り値は?Throwable型です。前の例外が存在しない場合はnullを返します。この機能は、複雑なエラー状況で問題の根本原因を特定し、より適切なエラーハンドリングを行うために非常に有効です。