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

Copy
1<?php
2
3/**
4 * 意図的にInvalidArgumentExceptionをスローする関数です。
5 * この例外が、後でRandom\RandomErrorにラップされる「元の例外」となります。
6 *
7 * @param int $value 処理対象の数値
8 * @throws InvalidArgumentException $value が負の場合
9 */
10function performRiskyOperation(int $value): void
11{
12    if ($value < 0) {
13        throw new InvalidArgumentException("負の数は許可されません。");
14    }
15    echo "処理が成功しました。値: " . $value . PHP_EOL;
16}
17
18/**
19 * performRiskyOperationを呼び出し、もし例外が発生したら
20 * それをRandom\RandomErrorでラップして再スローする関数です。
21 * これにより、例外の「連鎖」を作成します。
22 *
23 * @param int $input 処理対象の入力
24 * @throws Random\RandomError 何らかのランダム関連操作中に問題が発生した場合
25 */
26function executeRandomRelatedTask(int $input): void
27{
28    try {
29        performRiskyOperation($input);
30    } catch (InvalidArgumentException $e) {
31        // 元の例外 ($e) を新しい Random\RandomError でラップして再スローします。
32        // Random\RandomError は PHP 8.2 以降で利用可能です。
33        throw new Random\RandomError("ランダム操作中に予期せぬ問題が発生しました。", 0, $e);
34    }
35}
36
37// メイン処理の開始
38echo "--- 例外の連鎖テスト開始 ---" . PHP_EOL;
39
40try {
41    // 意図的にエラーが発生するような入力を与えます。
42    // これにより、performRiskyOperation -> executeRandomRelatedTask の順に例外が伝播します。
43    executeRandomRelatedTask(-5);
44} catch (Random\RandomError $e) {
45    // Random\RandomError をキャッチしました。
46    echo PHP_EOL . "--- Random\RandomError をキャッチしました ---" . PHP_EOL;
47    echo "メッセージ: " . $e->getMessage() . PHP_EOL;
48    echo "コード: " . $e->getCode() . PHP_EOL;
49    echo "発生ファイル: " . $e->getFile() . PHP_EOL;
50    echo "発生行: " . $e->getLine() . PHP_EOL;
51
52    // getPrevious() メソッドを使用して、この Random\RandomError がラップしている
53    // 「前の例外」（元の例外）を取得します。
54    $previousException = $e->getPrevious();
55
56    if ($previousException !== null) {
57        // 前の例外が存在する場合、その情報を出力します。
58        echo PHP_EOL . "--- getPrevious() で取得した前の例外情報 ---" . PHP_EOL;
59        echo "タイプ: " . get_class($previousException) . PHP_EOL;
60        echo "メッセージ: " . $previousException->getMessage() . PHP_EOL;
61        echo "発生ファイル: " . $previousException->getFile() . PHP_EOL;
62        echo "発生行: " . $previousException->getLine() . PHP_EOL;
63    } else {
64        echo PHP_EOL . "この Random\RandomError には前の例外がありません。" . PHP_EOL;
65    }
66} catch (Throwable $e) {
67    // 上記以外の、予期しないその他の例外をキャッチします。
68    echo PHP_EOL . "--- 予期せぬエラーが発生しました ---" . PHP_EOL;
69    echo "タイプ: " . get_class($e) . PHP_EOL;
70    echo "メッセージ: " . $e->getMessage() . PHP_EOL;
71}
72
73echo PHP_EOL . "--- 例外の連鎖テスト終了 ---" . PHP_EOL;
74?>

PHP 8で導入されたRandom\RandomErrorクラスのgetPrevious()メソッドは、例外の「連鎖」を扱う際に非常に役立ちます。このメソッドは、現在の例外が別の例外をラップしてスローされた場合に、その「元の例外」を取得するために使用されます。

サンプルコードでは、まずperformRiskyOperation関数が負の数を受け取るとInvalidArgumentExceptionをスローします。これが後のRandom\RandomErrorにラップされる「元の例外」となります。次に、executeRandomRelatedTask関数がperformRiskyOperationを呼び出し、もしInvalidArgumentExceptionが発生したら、それを捕捉し、その例外を引数として新しいRandom\RandomErrorインスタンスを作成して再スローしています。このRandom\RandomErrorは、PHP 8.2以降で利用可能です。

メインの処理では、executeRandomRelatedTaskを呼び出してRandom\RandomErrorを意図的に発生させています。catchブロックでRandom\RandomErrorを捕捉した後、$e->getPrevious()メソッドを呼び出すことで、ラップされた元のInvalidArgumentExceptionの情報を取得しています。このメソッドは引数を取りませんが、戻り値としてThrowableオブジェクト（元の例外）または、前の例外が存在しない場合はnullを返します。これにより、エラーの原因となった最初の例外まで遡って詳細を調査することが可能となり、デバッグやエラーハンドリングが容易になります。