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

Copy
1<?php
2
3/**
4 * データベース接続をチェックする（この例では常に失敗します）
5 *
6 * @throws RuntimeException 接続失敗時に例外をスローします
7 */
8function checkConnection(): void
9{
10    // 意図的に実行時例外を発生させます
11    throw new RuntimeException("データベース接続に失敗しました。");
12}
13
14/**
15 * データを検証する関数
16 * この関数は内部で checkConnection() を呼び出します
17 */
18function validateData(array $data): void
19{
20    echo "データを検証中です...\n";
21    // 処理の前に接続をチェックします
22    checkConnection();
23    // ... 本来のデータ検証処理 ...
24}
25
26/**
27 * メインの処理を実行する関数
28 */
29function runApplication(): void
30{
31    try {
32        // メインの処理を開始します
33        $sampleData = ['id' => 1, 'name' => 'test'];
34        validateData($sampleData);
35    } catch (RuntimeException $e) {
36        // 例外をキャッチします
37        echo "エラーが発生しました: " . $e->getMessage() . "\n\n";
38
39        // getTraceAsString() を使って、例外発生箇所までの関数呼び出し履歴（スタックトレース）を
40        // 文字列として取得し、表示します。
41        // これにより、どの関数のどの行で問題が起きたかを追跡できます。
42        echo "--- スタックトレース ---\n";
43        echo $e->getTraceAsString();
44        echo "\n----------------------\n";
45    }
46}
47
48// アプリケーションを実行します
49runApplication();

このPHPサンプルコードは、例外処理におけるgetTraceAsString()メソッドの使い方を示しています。このメソッドは、例外オブジェクトから、エラー発生地点までの関数の呼び出し履歴（スタックトレース）を文字列として取得するために使用します。

コードは、runApplication、validateData、checkConnectionという3つの関数で構成されています。処理の流れは、runApplicationからvalidateDataが呼び出され、さらにcheckConnectionが呼び出されます。checkConnection関数内では、throw new RuntimeException(...)という記述により、意図的に実行時例外を発生させています。

発生した例外は、runApplication関数内のtry...catchブロックで捕捉されます。catchブロックでは、例外オブジェクトが変数$eに格納されます。ここで$e->getTraceAsString()を呼び出すと、このメソッドが例外発生に至るまでの詳細な経路を文字列として返します。このメソッドに引数は必要ありません。

最終的に、この戻り値である文字列を出力することで、どのファイルの何行目から、どの関数が呼び出されたのかを時系列で確認できます。これにより、プログラムのどこで問題が起きたのかを正確に特定でき、デバッグ作業を効率的に進めることが可能になります。