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

Copy
1<?php
2
3/**
4 * Throwable::getTrace() メソッドが返す配列を、
5 * 人間が読みやすいスタックトレース文字列に整形します。
6 *
7 * @param Throwable $exception 例外オブジェクト
8 * @return string 整形されたスタックトレース文字列
9 */
10function formatTraceAsString(Throwable $exception): string
11{
12    $trace = $exception->getTrace();
13    $formattedTrace = [];
14    $traceIndex = 0;
15
16    // 各スタックフレームの情報を整形して追加
17    foreach ($trace as $frame) {
18        $file = $frame['file'] ?? 'n/a';
19        $line = $frame['line'] ?? 'n/a';
20        $function = $frame['function'] ?? 'n/a';
21        $class = $frame['class'] ?? '';
22        $type = $frame['type'] ?? ''; // メソッドの種類 (例: '->' または '::')
23
24        // 引数を文字列に変換する内部ヘルパー関数
25        $formatArgs = function (array $args): string {
26            $stringArgs = [];
27            foreach ($args as $arg) {
28                if (is_object($arg)) {
29                    $stringArgs[] = 'object(' . get_class($arg) . ')';
30                } elseif (is_array($arg)) {
31                    $stringArgs[] = 'array'; // 配列の中身は省略して表示
32                } elseif (is_string($arg)) {
33                    $stringArgs[] = "'" . (strlen($arg) > 20 ? substr($arg, 0, 17) . '...' : $arg) . "'";
34                } elseif (is_null($arg)) {
35                    $stringArgs[] = 'NULL';
36                } elseif (is_bool($arg)) {
37                    $stringArgs[] = $arg ? 'true' : 'false';
38                } elseif (is_numeric($arg)) {
39                    $stringArgs[] = (string) $arg;
40                } else {
41                    $stringArgs[] = gettype($arg);
42                }
43            }
44            return implode(', ', $stringArgs);
45        };
46
47        $call = $class . $type . $function . '(' . $formatArgs($frame['args'] ?? []) . ')';
48
49        $formattedTrace[] = sprintf("#%d %s(%s): %s",
50            $traceIndex++,
51            $file,
52            $line,
53            $call
54        );
55    }
56
57    // 例外自身のファイル、行、メッセージはgetTrace()の結果には含まれないため、個別に追加
58    $formattedTrace[] = sprintf("#%d %s(%s): %s",
59        $traceIndex,
60        $exception->getFile(),
61        $exception->getLine(),
62        $exception->getMessage()
63    );
64
65    return implode("\n", $formattedTrace);
66}
67
68// --- サンプルコードの実行部分 ---
69
70// 例外を発生させるための関数群
71function performDivision(int $numerator, int $denominator): float
72{
73    if ($denominator === 0) {
74        // 0で割ろうとした場合に例外をスロー
75        throw new InvalidArgumentException("Division by zero is not allowed.");
76    }
77    return $numerator / $denominator;
78}
79
80function calculateAverage(int $total, int $count): float
81{
82    // さらに別の関数を呼び出す
83    return performDivision($total, $count);
84}
85
86function processData(array $data): string
87{
88    // ここで意図的にエラーを発生させるために0を渡す
89    $result = calculateAverage($data[0] ?? 0, $data[1] ?? 0);
90    return "Result: " . $result;
91}
92
93// メインの実行ブロック
94try {
95    echo processData([100, 0]); // 意図的にエラーが発生するデータで関数を呼び出す
96} catch (Throwable $e) {
97    // 捕捉した例外からスタックトレースを取得し、文字列として整形して表示
98    echo "--- 例外が発生しました ---\n";
99    echo "エラーメッセージ: " . $e->getMessage() . "\n";
100    echo "ファイル: " . $e->getFile() . "\n";
101    echo "行: " . $e->getLine() . "\n";
102    echo "\n--- スタックトレース (整形済み) ---\n";
103    echo formatTraceAsString($e) . "\n"; // ここで整形されたスタックトレースを出力
104    echo "-----------------------------------\n";
105}

PHP 8のThrowable::getTrace()メソッドは、例外が発生した際に、その例外がどの関数からどの関数へと伝わって発生したかという「呼び出し履歴」、いわゆるスタックトレースの情報を配列として取得します。この配列は、エラーの原因を特定するのに役立つファイル名、行番号、関数名などの詳細な情報を含んでいます。

サンプルコードのformatTraceAsString関数は、このgetTrace()メソッドが返す配列を、人間が読みやすい形式の一連の文字列（スタックトレース文字列）に整形するために作成されています。この関数は、引数として発生したThrowable型の例外オブジェクトを受け取ります。そして、戻り値として、整形されたスタックトレースの文字列を返します。 関数内部では、getTrace()から得られた各呼び出しフレーム（情報の塊）を一つずつ処理し、ファイル名、行番号、関数名、クラス名、引数などを結合して一行ずつの情報を作成しています。特に引数については、その型（オブジェクト、配列、文字列など）に応じて見やすく変換する工夫がされています。最後に、例外自体のメッセージや発生場所の情報も加えて、全体を改行でつないだ一つの文字列として完成させます。

実行例では、意図的にエラーを起こすことで例外を発生させ、try-catch文でそれを捕捉しています。捕捉した例外オブジェクトをformatTraceAsString関数に渡すことで、複雑な配列情報を読みやすいスタックトレース文字列として出力し、エラーの追跡に利用できることを示しています。