【PHP8.x】AssertionError::getPrevious()メソッドの使い方

Copy
1<?php
2
3/**
4 * AssertionError の getPrevious() メソッドの使用例を示します。
5 *
6 * PHPのassert()関数は、設定によってはAssertionErrorをスローします。
7 * このAssertionErrorは、場合によっては内部的な前の例外を持っていることがあります。
8 * getPrevious()メソッドは、その前の例外（またはnull）を返します。
9 *
10 * このスクリプトを実行する前に、php.ini または実行時に `assert.exception = 1` を設定し、
11 * assert() が例外をスローするようにする必要があります。
12 *
13 * 例: `php -d assert.exception=1 your_script.php`
14 */
15
16// assert() 関数が失敗した際に AssertionError をスローするように設定
17ini_set('assert.exception', '1');
18
19try {
20    // 意図的に例外を発生させるための関数
21    function someOperationThatMightFail(): void
22    {
23        // ここで通常の例外をスローする
24        throw new LogicException("これは内部で発生した論理エラーです。");
25    }
26
27    // assert() の第二引数に Throwable オブジェクトを渡すことで、
28    // AssertionError の getPrevious() で取得できる例外を設定できます。
29    // PHP 8 では、アサーションメッセージとしてオブジェクトも渡せます。
30    // しかし、通常は assert(false) のように、単純なアサーションが失敗するとAssertionErrorが直接スローされます。
31    // getPrevious() は、AssertionErrorが他の例外をラップしている場合に有用です。
32    // PHP 8 の assert() は、以前のバージョンと異なり、第二引数に文字列でないメッセージを渡すと
33    // エラーとして扱われる場合があります。
34    // ここでは、一般的な失敗ケースと、getPrevious() が null になるケースを示します。
35
36    // シナリオ1: assert() がメッセージのみで失敗し、getPrevious() が null になるケース
37    echo "--- シナリオ1: assert() が単純に失敗 ---" . PHP_EOL;
38    assert(false, "このアサーションは失敗しました！");
39
40} catch (AssertionError $e) {
41    echo "AssertionError をキャッチしました: " . $e->getMessage() . PHP_EOL;
42    echo "コード: " . $e->getCode() . PHP_EOL;
43    echo "ファイル: " . $e->getFile() . " (ライン: " . $e->getLine() . ")" . PHP_EOL;
44
45    // getPrevious() メソッドを使用して、このAssertionErrorの前の例外を取得
46    $previousException = $e->getPrevious();
47
48    if ($previousException !== null) {
49        echo "前の例外が見つかりました (getPrevious()):" . PHP_EOL;
50        echo "  - タイプ: " . get_class($previousException) . PHP_EOL;
51        echo "  - メッセージ: " . $previousException->getMessage() . PHP_EOL;
52        echo "  - コード: " . $previousException->getCode() . PHP_EOL;
53    } else {
54        echo "前の例外は見つかりませんでした (getPrevious() は null を返しました)。" . PHP_EOL;
55    }
56
57} catch (Throwable $e) {
58    // AssertionError 以外の予期せぬエラーをキャッチ
59    echo "予期せぬエラーが発生しました: " . $e->getMessage() . PHP_EOL;
60}
61
62echo PHP_EOL . "--- シナリオ2: assert() が内部例外をラップするケース (より複雑な設定またはカスタムハンドラが必要) ---" . PHP_EOL;
63// PHPのデフォルトのassert()関数は、通常、第二引数にThrowableオブジェクトを直接受け取りません。
64// しかし、カスタムのアサーションハンドラを設定したり、より複雑なロジックでAssertionErrorが
65// 他の例外をラップしてスローされる場合（例えば、ライブラリ内部で検証エラーを変換する際など）に
66// getPrevious() は役立ちます。
67// ここでは、概念的な動作を示すために、手動でAssertionErrorをスローしてgetPrevious()に値を設定します。
68
69try {
70    // 内部で発生したかのような例外を作成
71    $innerException = new InvalidArgumentException("無効な引数が検出されました。");
72
73    // その内部例外をラップする形で AssertionError をスロー
74    // 注: PHPのassert()関数は直接このような形でラップしませんが、
75    // これは `getPrevious()` の動作を示すためのデモンストレーションです。
76    // 実際のアプリケーションでは、AssertionErrorは assert() の失敗によって直接スローされることがほとんどです。
77    throw new AssertionError("手動で発生させたアサーション失敗エラー。", 0, $innerException);
78
79} catch (AssertionError $e) {
80    echo "AssertionError をキャッチしました: " . $e->getMessage() . PHP_EOL;
81    $previousException = $e->getPrevious();
82
83    if ($previousException !== null) {
84        echo "前の例外が見つかりました (getPrevious()):" . PHP_EOL;
85        echo "  - タイプ: " . get_class($previousException) . PHP_EOL;
86        echo "  - メッセージ: " . $previousException->getMessage() . PHP_EOL;
87        echo "  - コード: " . $previousException->getCode() . PHP_EOL;
88    } else {
89        echo "前の例外は見つかりませんでした (getPrevious() は null を返しました)。" . PHP_EOL;
90    }
91}

PHP 8のAssertionError::getPrevious()メソッドは、プログラムのアサーションが失敗した際に発生するAssertionErrorが、もし内部的に別の例外を含んでいる場合に、その元の例外（Throwableオブジェクト）を取得するために使用されます。このメソッドは引数を取らず、戻り値として、前の例外が存在すればそのThrowableオブジェクトを、存在しなければnullを返します。

通常、PHPのassert()関数が失敗してAssertionErrorがスローされた場合、getPrevious()はnullを返します。これは、assert()関数が直接AssertionErrorを生成するため、多くの場合、特別な「前の例外」を伴わないためです。しかし、アプリケーションがカスタムのアサーションハンドラを設定している場合や、特定のライブラリが他の例外をAssertionErrorにラップして再スローするような特殊なケースでは、getPrevious()を使って、エラーの根本原因となった内部例外の詳細を調査し、デバッグやエラーハンドリングに役立てることができます。