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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 意図的に例外チェーンを発生させるクラスの例
7 */
8class ServiceClass
9{
10    /**
11     * 内部でエラーが発生し、それを原因として BadMethodCallException をスローするメソッド
12     *
13     * @throws BadMethodCallException
14     */
15    public function executeAction(): void
16    {
17        try {
18            // 本来はここで何らかの処理を行う
19            // この例では、処理の前提条件が満たされず、例外が発生したと仮定する
20            throw new LogicException('前提条件が満たされていません。');
21        } catch (LogicException $e) {
22            // 捕捉した例外($e)を原因(previous)として、新しい例外をスローする
23            // これにより、なぜメソッド呼び出しが失敗したのか、根本原因を追跡できる
24            throw new BadMethodCallException(
25                'アクションの実行に失敗しました。', // メッセージ
26                1001,                         // エラーコード
27                $e                            // 原因となった前の例外
28            );
29        }
30    }
31}
32
33$service = new ServiceClass();
34
35try {
36    // 例外が発生する可能性のあるメソッドを呼び出す
37    $service->executeAction();
38} catch (BadMethodCallException $e) {
39    // スローされた BadMethodCallException を捕捉
40    echo "例外クラス: " . get_class($e) . PHP_EOL;
41    echo "メッセージ: " . $e->getMessage() . PHP_EOL;
42    echo "-----------------------------------" . PHP_EOL;
43
44    // getPrevious() メソッドで、この例外の原因となった「前の例外」を取得する
45    $previousException = $e->getPrevious();
46
47    // 前の例外が存在するかチェック (戻り値は ?Throwable なので null の可能性がある)
48    if ($previousException !== null) {
49        echo "原因となった例外クラス: " . get_class($previousException) . PHP_EOL;
50        echo "原因のメッセージ: " . $previousException->getMessage() . PHP_EOL;
51    } else {
52        echo "原因となった例外はありません。" . PHP_EOL;
53    }
54}

BadMethodCallExceptionクラスのgetPrevious()メソッドは、現在の例外がスローされる直接的な原因となった、一つ前の例外オブジェクトを取得するために使用します。このメソッドに引数はありません。戻り値は、原因となった前の例外オブジェクト（Throwable型）、または原因となる例外が存在しない場合はnullとなります。PHP 8の型表記では?Throwableと表現されます。

プログラムでは、ある処理の失敗がきっかけで別の問題が発生することがあります。このような場合に、最初に発生した例外を原因として関連付け、新しい例外をスローする手法を「例外チェーン」と呼びます。

このサンプルコードは例外チェーンを実演しています。まずServiceClassのメソッド内で意図的にLogicExceptionを発生させます。次にcatchブロックでその例外を捕捉し、それを原因として指定しながら新しいBadMethodCallExceptionをスローしています。最後のcatchブロックでは、getPrevious()メソッドを使ってBadMethodCallExceptionの根本原因であるLogicExceptionの情報を取得し、表示しています。このようにgetPrevious()を使うことで、エラーの背景にある根本原因を正確に追跡でき、デバッグ作業が効率的になります。