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

Copy
1<?php
2
3/**
4 * ゼロによる除算が発生する可能性がある関数
5 *
6 * @param int $numerator 分子
7 * @param int $denominator 分母
8 * @return float 除算の結果
9 * @throws DivisionByZeroError 分母が0の場合にスローされます
10 */
11function divide(int $numerator, int $denominator): float
12{
13    if ($denominator === 0) {
14        // 分母が0の場合、DivisionByZeroError をスロー
15        throw new DivisionByZeroError("ゼロで割ることはできません。");
16    }
17    return $numerator / $denominator;
18}
19
20/**
21 * 内部で divide 関数を呼び出し、発生した例外を新しい例外でラップする関数
22 *
23 * @param int $a 最初の数値
24 * @param int $b 2番目の数値
25 * @return float 計算結果
26 * @throws RuntimeException 内部で発生した例外をラップしてスローされます
27 */
28function performCalculation(int $a, int $b): float
29{
30    try {
31        // divide 関数を呼び出し
32        return divide($a, $b);
33    } catch (Throwable $e) {
34        // divide 関数内で発生した例外をキャッチし、
35        // その例外を「前の例外」（第3引数）として新しい RuntimeException をスロー
36        throw new RuntimeException("計算処理中に内部エラーが発生しました。", 0, $e);
37    }
38}
39
40// メインの処理
41try {
42    // 意図的にゼロ除算を引き起こす数値で performCalculation を呼び出す
43    $result = performCalculation(10, 0);
44    echo "結果: " . $result . PHP_EOL;
45} catch (Throwable $e) {
46    // performCalculation からスローされた例外をキャッチ
47    echo "--- 例外が発生しました ---" . PHP_EOL;
48    echo "現在の例外メッセージ: " . $e->getMessage() . PHP_EOL;
49    echo "現在の例外のクラス: " . get_class($e) . PHP_EOL;
50    echo "現在の例外が発生したファイル: " . $e->getFile() . PHP_EOL;
51    echo "現在の例外が発生した行: " . $e->getLine() . PHP_EOL;
52
53    // getPrevious() メソッドを使って、前の例外（原因となった例外）を取得
54    $previousException = $e->getPrevious();
55
56    if ($previousException !== null) {
57        // 前の例外が存在する場合、その情報を表示
58        echo PHP_EOL . "--- 前の例外（原因）の情報 ---" . PHP_EOL;
59        echo "前の例外メッセージ: " . $previousException->getMessage() . PHP_EOL;
60        echo "前の例外のクラス: " . get_class($previousException) . PHP_EOL;
61        echo "前の例外が発生したファイル: " . $previousException->getFile() . PHP_EOL;
62        echo "前の例外が発生した行: " . $previousException->getLine() . PHP_EOL;
63    } else {
64        echo PHP_EOL . "前の例外はありません。" . PHP_EOL;
65    }
66}

PHP 8のThrowable::getPrevious()メソッドは、ある例外が別の例外をラップしてスローされた際に、その「原因となった元の例外」を取得するために使用されます。システム開発では、複雑な処理の中で発生した下位層のエラーを、より上位層の分かりやすいエラーメッセージで包み直して報告する「例外のラッピング」がよく行われます。

このメソッドは引数を取りません。戻り値は?Throwable型で、前の例外が存在する場合はThrowableオブジェクトを、存在しない場合はnullを返します。

サンプルコードでは、まずdivide関数がゼロ除算でDivisionByZeroErrorをスローする可能性があります。performCalculation関数はこれをtry-catchで捕捉し、そのDivisionByZeroErrorをRuntimeExceptionのコンストラクタの第3引数として渡して、新しいRuntimeExceptionをスローしています。

メインの処理では、このRuntimeExceptionをキャッチした後、getPrevious()メソッドを呼び出すことで、内部で発生した元のDivisionByZeroErrorオブジェクトを取得し、その詳細情報を表示しています。これにより、ユーザーには「計算処理中に内部エラーが発生した」と伝えつつも、開発者は「その原因はゼロ除算だった」と正確な情報を追跡できるため、問題解決に非常に役立ちます。