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

Copy
1<?php
2
3/**
4 * 安全な乱数生成を試みる関数。
5 * 最小値と最大値の指定が不正な場合、ValueErrorを捕捉し、
6 * Random\RandomExceptionでラップして再スローします。
7 *
8 * @param int $min 最小値
9 * @param int $max 最大値
10 * @return int 生成された乱数
11 * @throws Random\RandomException 乱数生成中にエラーが発生した場合
12 */
13function generateRandomNumberSafely(int $min, int $max): int
14{
15    try {
16        // Random\Randomizer を使用して乱数を生成します。
17        // PHP 8以降で推奨される新しい乱数生成方法です。
18        $randomizer = new Random\Randomizer();
19        return $randomizer->getInt($min, $max);
20    } catch (ValueError $e) {
21        // Random\Randomizer::getInt() は min > max の場合に ValueError をスローします。
22        // ここでは、この ValueError を原因（前の例外）として、
23        // Random\RandomException を作成し、元の例外をチェーン（連結）して再スローします。
24        // これが例外のチェインの一般的なユースケースです。
25        throw new Random\RandomException(
26            "安全な乱数生成中に無効な引数が指定されました。元のエラーを参照してください。",
27            0, // エラーコード（0または任意の特定コード）
28            $e  // ここで元の ValueError オブジェクトを前の例外として渡します。
29        );
30    }
31}
32
33// メインの実行ブロック
34try {
35    echo "--- 正常な乱数生成の試行 ---\n";
36    echo "乱数生成中 (min=1, max=10)...\n";
37    $randomNumber = generateRandomNumberSafely(1, 10);
38    echo "生成された乱数: " . $randomNumber . "\n\n";
39
40    echo "--- エラーを伴う乱数生成の試行 ---\n";
41    echo "乱数生成中 (意図的にエラーを発生: min=10, max=5)...\n";
42    // min > max のため generateRandomNumberSafely() 内で ValueError が発生し、
43    // それが Random\RandomException でラップされてスローされます。
44    generateRandomNumberSafely(10, 5);
45    echo "この行は、エラーが発生したため実行されません。\n";
46} catch (Random\RandomException $e) {
47    // generateRandomNumberSafely() からスローされた Random\RandomException を捕捉します。
48    echo "Random\RandomException が捕捉されました！\n";
49    echo "メッセージ: " . $e->getMessage() . "\n";
50    echo "ファイル: " . $e->getFile() . "\n";
51    echo "行: " . $e->getLine() . "\n";
52
53    // getPrevious() メソッドを使用して、チェインされた前の例外を取得します。
54    // この場合、元の ValueError オブジェクトが返されます。
55    $previousException = $e->getPrevious();
56
57    if ($previousException !== null) {
58        echo "\n--- 前の例外 (Previous Exception) 情報 ---\n";
59        echo "前の例外のタイプ: " . get_class($previousException) . "\n";
60        echo "前の例外のメッセージ: " . $previousException->getMessage() . "\n";
61        echo "前の例外のファイル: " . $previousException->getFile() . "\n";
62        echo "前の例外の行: " . $previousException->getLine() . "\n";
63        // デバッグのために、前の例外のスタックトレースも表示できます。
64        // echo "前の例外のトレース:\n" . $previousException->getTraceAsString() . "\n";
65    } else {
66        echo "前の例外は存在しません。\n";
67    }
68} catch (\Throwable $e) {
69    // その他の予期せぬエラーを捕捉します。
70    echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
71}
72
73?>

PHP 8のRandom\RandomException::getPrevious()メソッドは、ある例外が別の例外によって引き起こされた場合に、その元の原因となった例外を取得するために使用されます。このメソッドは引数を取らず、戻り値としてThrowableインターフェースを実装するオブジェクトを返します。前の例外が存在しない場合はnullが返されます。

サンプルコードでは、generateRandomNumberSafely関数が不正な引数で呼ばれた際に発生するValueErrorを捕捉し、このValueErrorを「前の例外」としてRandom\RandomExceptionを新しく生成し、再スローしています。これにより、関連する例外が鎖（チェイン）のように連結されます。

メインの実行ブロックでは、このRandom\RandomExceptionを捕捉した後、$e->getPrevious()を呼び出すことで、最初に発生したValueErrorのインスタンスを取得しています。そして、その取得したValueErrorのタイプやメッセージなどの詳細情報を表示しています。このようにgetPrevious()を用いることで、複雑な処理の中でエラーが発生した場合でも、根本的な原因となった例外まで遡って情報を確認でき、問題解決に役立ちます。