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

Copy
1<?php
2
3/**
4 * 意図的にエラーを発生させる関数
5 *
6 * @param int $numerator 分子
7 * @param int $denominator 分母
8 * @return float 除算の結果
9 * @throws DivisionByZeroError 分母が0の場合にスローされる
10 */
11function performDivision(int $numerator, int $denominator): float
12{
13    // PHP 8では、0での除算はDivisionByZeroErrorをスローします。
14    // このエラーはErrorクラスを継承しており、Throwableインターフェースを実装しています。
15    return $numerator / $denominator;
16}
17
18/**
19 * エラーを捕捉し、スタックトレースを出力する処理
20 */
21function demonstrateErrorTracing(): void
22{
23    try {
24        echo "計算を実行します...\n";
25        // ここでDivisionByZeroErrorが発生します
26        $result = performDivision(10, 0);
27        echo "結果: " . $result . "\n";
28    } catch (Throwable $e) {
29        // Throwableは、ErrorとExceptionの両方を捕捉するための汎用インターフェースです。
30        echo "エラーが発生しました: " . $e->getMessage() . "\n";
31        echo "スタックトレース (getTraceAsString):\n";
32
33        // getTraceAsString() メソッドは、エラーや例外が発生した時点から
34        // 呼び出し元への経路（スタックトレース）を整形された文字列として返します。
35        // これにより、どこで問題が発生し、どのような呼び出し順序でその場所に到達したかがわかります。
36        echo $e->getTraceAsString() . "\n";
37    }
38}
39
40// エラーのトレースをデモンストレーションする関数を実行
41demonstrateErrorTracing();

このPHPサンプルコードは、プログラム実行中に発生したエラーを安全に捕捉し、その発生源を特定する方法をシステムエンジニアを目指す初心者の方にも分かりやすく解説しています。

performDivision関数では、分母に0を指定することで、意図的にDivisionByZeroErrorというエラーを発生させています。PHP 8では、このような0による除算はError系のエラーとして扱われます。

demonstrateErrorTracing関数内のtry-catchブロックは、プログラムの実行中に発生するエラーを捕捉するために使用されます。catch (Throwable $e)と記述することで、ErrorとExceptionの両方を統一的に捕捉できるため、汎用的なエラーハンドリングに役立ちます。

エラーが捕捉されると、$e->getMessage()でエラーの具体的な内容を取得できます。そして、$e->getTraceAsString()メソッドは、エラーが発生した時点から、そのエラーを呼び出すまでの関数やメソッドの実行経路（スタックトレース）を整形された文字列として返します。このメソッドは引数を取りません。

このスタックトレースは、プログラムのどの部分で問題が発生し、どのような順番でその場所に到達したのかを特定するのに非常に役立ち、デバッグ作業において原因究明のための貴重な情報源となります。