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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 配列の要素にアクセスし、OutOfBoundsExceptionのスタックトレースを表示するサンプルクラス
7 */
8class ExceptionTraceExample
9{
10    /**
11     * @var array<int, string> サンプルデータ
12     */
13    private array $data = ['apple', 'banana', 'cherry'];
14
15    /**
16     * 指定されたインデックスのデータを取得しようと試みる
17     *
18     * @param int $index 取得するデータのインデックス
19     * @return string データ
20     * @throws OutOfBoundsException インデックスが範囲外の場合にスローされる
21     */
22    private function getDataByIndex(int $index): string
23    {
24        // 配列に指定されたインデックスが存在するかチェック
25        if (!isset($this->data[$index])) {
26            // 存在しない場合、OutOfBoundsExceptionを意図的にスローする
27            throw new OutOfBoundsException("インデックス {$index} は配列の範囲外です。");
28        }
29        return $this->data[$index];
30    }
31
32    /**
33     * このクラスのメイン処理を実行する
34     */
35    public function run(): void
36    {
37        try {
38            // 存在しないインデックス(例: 5)にアクセスし、例外を発生させる
39            echo "インデックス 5 の要素を取得しようとします..." . PHP_EOL;
40            $this->getDataByIndex(5);
41        } catch (OutOfBoundsException $e) {
42            // OutOfBoundsExceptionをキャッチする
43            echo "エラー: " . $e->getMessage() . PHP_EOL;
44            echo "----------------------------------------" . PHP_EOL;
45            echo "スタックトレース:" . PHP_EOL;
46
47            // getTraceAsString()メソッドで、例外発生地点までのコールスタックを文字列として取得し、出力する
48            // これにより、どのファイルの何行目で、どのメソッド呼び出しが原因で例外が発生したかを追跡できる
49            echo $e->getTraceAsString();
50
51            echo PHP_EOL . "----------------------------------------" . PHP_EOL;
52        }
53    }
54}
55
56// クラスのインスタンスを作成して実行
57$example = new ExceptionTraceExample();
58$example->run();

OutOfBoundsExceptionクラスのgetTraceAsString()メソッドは、例外が発生した時点までのプログラムの実行経路（スタックトレース）を、人間が読みやすい文字列として取得するためのものです。スタックトレースとは、エラーが発生するまでにどのような順番で関数やメソッドが呼び出されたかの履歴情報のことで、デバッグの際にエラーの原因を特定する上で非常に重要な手がかりとなります。

このメソッドは引数を取らず、戻り値としてスタックトレースを表す文字列（string）を返します。

サンプルコードでは、まず配列の範囲外のインデックスにアクセスすることで意図的にOutOfBoundsExceptionを発生させています。try...catch構文でこの例外を捕捉し、catchブロック内で、例外オブジェクト$eに対して$e->getTraceAsString()を呼び出しています。これにより、どのファイルの何行目からどのメソッドが呼び出され、最終的に例外が発生したか、という一連の呼び出し履歴が文字列として出力されます。この情報を確認することで、開発者はプログラムのどこに問題があるのかを迅速かつ正確に突き止めることができます。