【PHP8.x】getTraceAsStringメソッドの使い方

Copy
1<?php
2
3/**
4 * FiberError::getTraceAsString() メソッドの動作を示すサンプルコードです。
5 *
6 * PHP 8.1 以降で動作します。
7 * FiberError は、Fiber が不正に操作された場合に発生するエラーです。
8 * ここでは、既に完了した Fiber を再開しようとすることで発生させています。
9 */
10function demonstrateFiberErrorGetTraceAsString(): void
11{
12    echo "--- FiberError::getTraceAsString() のデモンストレーション ---\n\n";
13
14    // Fiber を作成します。この Fiber は yield を使わずに最後まで実行されます。
15    $fiber = new Fiber(function (): void {
16        echo "ファイバーが開始しました。\n";
17        // 何も yield せずに、そのまま実行を終えます。
18        echo "ファイバーが終了しました。\n";
19    });
20
21    try {
22        // ファイバーを開始し、完了させます。
23        $fiber->start();
24        echo "ファイバーは実行され、完了しました。\n\n";
25
26        // 完了した Fiber に対して resume() を呼び出すと FiberError が発生します。
27        echo "完了したファイバーを再開しようとします...\n";
28        $fiber->resume();
29
30    } catch (FiberError $e) {
31        // FiberError を捕捉し、その詳細を表示します。
32        echo "FiberError を捕捉しました！\n\n";
33        echo "エラーメッセージ: " . $e->getMessage() . "\n\n";
34        
35        echo "--- スタックトレース (getTraceAsString) ---\n";
36        // getTraceAsString() を呼び出し、スタックトレースを文字列として取得します。
37        echo $e->getTraceAsString();
38        echo "--------------------------------------------\n";
39    } catch (Throwable $e) {
40        // その他の予期しない例外を捕捉する場合
41        echo "予期しないエラーを捕捉しました: " . $e->getMessage() . "\n";
42        echo $e->getTraceAsString();
43    }
44}
45
46// 関数を実行します。
47demonstrateFiberErrorGetTraceAsString();

PHPのFiberErrorクラスに属するgetTraceAsString()メソッドは、プログラム実行中に発生したエラーや例外の呼び出し履歴（スタックトレース）を文字列として取得する際に使用します。このメソッドは引数を取らず、エラーが発生した場所からさかのぼって、どの関数がどのような順序で呼び出されたかを示す詳細な情報を文字列形式で返します。

サンプルコードでは、PHP 8.1以降で導入されたFiber（ファイバー）という軽量な並行処理の仕組みを利用し、意図的にFiberErrorを発生させています。具体的には、一度処理を完了したファイバーに対して、再度処理を再開しようとすることでこのエラーを引き起こしています。try-catchブロックでFiberErrorを捕捉した後、捕捉したエラーオブジェクトに対してgetTraceAsString()メソッドを呼び出しています。その戻り値であるスタックトレースを表示することで、エラーがプログラムのどの部分で、どのような関数の流れの中で発生したかを具体的に把握でき、エラーの原因を調査する際に役立つ情報を提供します。この情報は、デバッグ作業を進める上で重要な手がかりとなります。