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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 複数のメソッド呼び出しを経て例外が発生する状況をシミュレートするクラス。
7 * これにより、スタックトレースの有用性を示します。
8 */
9class DataProcessor
10{
11    /**
12     * データの最終検証を行うメソッド。
13     *
14     * @param mixed $data 検証対象のデータ
15     * @throws InvalidArgumentException データが整数でない場合にスローされる
16     */
17    private function validate(mixed $data): void
18    {
19        // is_int()関数を使い、引数が整数であるかを確認します。
20        if (!is_int($data)) {
21            // 整数でない場合、InvalidArgumentExceptionをスローします。
22            // この例外は、関数の引数が不正な場合に用いられます。
23            throw new InvalidArgumentException('データは整数である必要があります。');
24        }
25        echo "データ ({$data}) の検証に成功しました。" . PHP_EOL;
26    }
27
28    /**
29     * データ処理の中間ステップ。
30     *
31     * @param mixed $data
32     */
33    private function handle(mixed $data): void
34    {
35        // さらに内部の検証メソッドを呼び出します。
36        $this->validate($data);
37    }
38
39    /**
40     * データ処理を開始するエントリーポイント。
41     *
42     * @param mixed $input
43     */
44    public function run(mixed $input): void
45    {
46        // 中間処理メソッドを呼び出します。
47        $this->handle($input);
48    }
49}
50
51try {
52    $processor = new DataProcessor();
53    // わざと不正な型の引数（文字列）を渡し、深い階層で例外を発生させます。
54    $processor->run('invalid-id-123');
55} catch (InvalidArgumentException $e) {
56    // スローされたInvalidArgumentExceptionを捕捉します。
57    echo "エラーを捕捉しました: " . $e->getMessage() . PHP_EOL . PHP_EOL;
58
59    // getTraceAsString() を使い、例外が発生するまでの処理の履歴（スタックトレース）を
60    // 文字列形式で取得します。
61    // これにより、どのファイルの何行目で、どのメソッド呼び出しが原因でエラーに至ったのかを
62    // 順番に追跡でき、デバッグに役立ちます。
63    echo "--- スタックトレース (getTraceAsStringによる出力) ---" . PHP_EOL;
64    echo $e->getTraceAsString();
65}

このPHPサンプルコードは、例外が発生した際に、その原因を突き止めるための「スタックトレース」を取得する方法を示しています。DataProcessorクラスは、run、handle、validateとメソッドを順に呼び出します。最後のvalidateメソッドで、引数が整数でない場合にInvalidArgumentExceptionという例外を発生させます。

プログラムはtry...catchブロックで囲まれており、発生した例外をcatchで捕捉します。ここで重要なのが$e->getTraceAsString()です。このメソッドは、捕捉した例外オブジェクト（$e）から、例外発生地点までのメソッド呼び出しの履歴（スタックトレース）を、人間が読みやすい文字列形式で取得します。このメソッドに引数は必要ありません。

戻り値として得られる文字列には、どのファイルの何行目で、どの関数やメソッドが呼び出されたかという情報が順番に含まれています。この情報を確認することで、エラーがどのような処理の流れで発生したのかを正確に追跡でき、プログラムのデバッグ作業を効率的に進めることができます。