【PHP8.x】traceプロパティの使い方

Copy
1<?php
2
3/**
4 * Executes a division operation that might trigger an Error.
5 * In PHP 8, division by zero results in a DivisionByZeroError,
6 * which is a subclass of the built-in Error class.
7 *
8 * @param int $denominator The number to divide by.
9 * @return float The result of the division.
10 * @throws DivisionByZeroError If the denominator is zero.
11 */
12function performRiskyOperation(int $denominator): float
13{
14    return 10 / $denominator;
15}
16
17/**
18 * Logs the stack trace of a given Throwable object (Error or Exception).
19 * This function demonstrates how to access the 'trace' information
20 * from an Error object, which is described as a property returning an array
21 * in the reference. In practice, this is achieved using the getTrace() method.
22 *
23 * @param Throwable $e The Throwable object (Error or Exception) whose trace needs to be logged.
24 */
25function logErrorTrace(Throwable $e): void
26{
27    // For Error objects (and Exception objects) in PHP, the stack trace
28    // is obtained using the getTrace() method. This method returns an array
29    // containing information about each frame in the call stack.
30    $trace = $e->getTrace();
31
32    $logMessage = "--- PHP Error Trace Log ---\n";
33    $logMessage .= "Error Type: " . get_class($e) . "\n";
34    $logMessage .= "Message: " . $e->getMessage() . "\n";
35    $logMessage .= "Location: " . $e->getFile() . " (Line: " . $e->getLine() . ")\n";
36    $logMessage .= "Stack Trace:\n";
37
38    // Iterate through each frame in the stack trace array.
39    // Each frame is an associative array with details like file, line, function, class, etc.
40    foreach ($trace as $i => $frame) {
41        $logMessage .= "  #" . $i . " ";
42        // Display file and line number if available for the current frame
43        if (isset($frame['file'])) {
44            $logMessage .= $frame['file'] . "(" . $frame['line'] . "): ";
45        }
46        // Display class, type (-> for object methods, :: for static methods), and function name
47        if (isset($frame['class'])) {
48            $logMessage .= $frame['class'] . $frame['type'];
49        }
50        if (isset($frame['function'])) {
51            $logMessage .= $frame['function'] . "()";
52        }
53        $logMessage .= "\n";
54    }
55    $logMessage .= "---------------------------\n";
56
57    // In a real system, error_log() is the standard way to write messages
58    // to the web server's error log, syslog, or a specified file.
59    error_log($logMessage);
60
61    // For immediate demonstration, also output to standard output.
62    echo $logMessage;
63}
64
65// --- Main execution block to demonstrate error logging ---
66try {
67    echo "Attempting a risky division operation...\n";
68    // Calling performRiskyOperation with 0 will cause a DivisionByZeroError in PHP 8.
69    performRiskyOperation(0);
70    // This line will not be reached because an error will be thrown.
71    echo "Operation completed successfully.\n";
72} catch (Throwable $e) {
73    // Catch any Throwable (which is the base interface for both Error and Exception).
74    // This allows us to gracefully handle and log the DivisionByZeroError.
75    logErrorTrace($e);
76    echo "\nAn error was caught and its trace has been logged.\n";
77}
78
79echo "\nScript continues after error handling.\n";
80
81?>

PHP 8では、プログラム実行中に予期せぬ問題が発生した場合に、組み込みのErrorクラス、またはそのサブクラスがスローされます。このErrorクラスには、エラーが発生するまでの関数の呼び出し履歴、通称「スタックトレース」に関する情報が含まれています。リファレンスではtraceというプロパティとして示されていますが、実際にはgetTrace()メソッドを呼び出すことで、この履歴情報を配列として取得します。

getTrace()メソッドは引数を取りません。戻り値は配列で、この配列の各要素は、エラー発生に至るまでの各関数呼び出し（フレーム）の詳細を格納しています。具体的には、どのファイル、どの行で、どのクラスのどの関数が呼び出されたかといった情報が含まれており、これによってエラーの発生源やその経路を特定することが可能です。

提供されたサンプルコードは、数値のゼロによる除算によって発生するDivisionByZeroError（Errorクラスのサブクラス）を例に、このスタックトレース情報の取得とログ出力の方法を示しています。try-catchブロックでエラーを捕捉した後、logErrorTrace関数内で$e->getTrace()を使用してスタックトレースの配列を取得し、その内容を整形して標準出力とエラーログに出力しています。このようにエラー発生時の呼び出し履歴を記録することは、本番環境での問題解析やデバッグ作業において非常に重要であり、エラーの原因を迅速に突き止めるために不可欠な機能です。

Copy
1<?php
2
3/**
4 * エラーを発生させるための関数C
5 * functionA -> functionB -> functionC の順に呼び出され、ここでエラーが発生する想定です。
6 */
7function functionC(): void
8{
9    // 意図的に DivisionByZeroError (Errorクラスのサブクラス) を発生させます。
10    // PHP 8 では、ゼロ除算は Error オブジェクトをスローします。
11    $numerator = 10;
12    $denominator = 0;
13    echo $numerator / $denominator; // ここでエラーが発生します
14}
15
16/**
17 * functionC を呼び出す関数B
18 */
19function functionB(): void
20{
21    functionC();
22}
23
24/**
25 * functionB を呼び出す関数A
26 */
27function functionA(): void
28{
29    functionB();
30}
31
32// try-catch ブロックを使ってエラーを捕捉し、そのスタックトレースを表示します。
33try {
34    echo "エラーを発生させるために functionA を呼び出します...\n";
35    functionA();
36    echo "エラーは発生しませんでした (この行は通常実行されません)。\n";
37} catch (Error $e) {
38    // Error オブジェクトが捕捉された場合
39    echo "--- エラー情報 ---\n";
40    echo "メッセージ: " . $e->getMessage() . "\n";
41    echo "ファイル: " . $e->getFile() . "\n";
42    echo "行: " . $e->getLine() . "\n\n";
43
44    echo "--- スタックトレース (Error::trace プロパティ) ---\n";
45    // Error オブジェクトの 'trace' プロパティは、エラー発生時のコールスタックを配列として提供します。
46    // この配列は、エラーに至るまでの関数呼び出しの経路（トレース）を示し、
47    // 各呼び出し元（ファイル、行、関数、クラスなど）の情報を含みます。
48    print_r($e->trace);
49}
50
51?>

Error::traceプロパティは、PHP 8から提供されているエラー処理のための重要な機能です。このプロパティは、プログラムの実行中にエラーが発生した際、そのエラーが起きるまでにどのような関数やメソッドが、どのような順序で呼び出されたかという詳細な履歴（コールスタック）を捕捉し、提供します。

具体的には、try-catchブロックでエラーを捕捉したErrorオブジェクトからtraceプロパティにアクセスすると、エラー発生時の呼び出し元情報が配列として返されます。この戻り値である配列には、各呼び出し元の関数名、ファイル名、行番号、所属クラスなどの詳細な情報が含まれています。これにより、エラーが最終的に発生した箇所だけでなく、そこに至るまでのプログラムの経路を明確に把握できます。

サンプルコードでは、functionAからfunctionB、functionCへと関数を順に呼び出し、functionC内で意図的にゼロ除算エラーを発生させています。このエラーをcatchブロックで捕捉し、$e->traceを利用してエラーに至るまでの呼び出し履歴を表示しています。この履歴を参照することで、システムエンジニアを目指す方がエラーの原因を特定したり、プログラムの不具合を修正したりする際に、問題の発生源とその影響範囲を迅速に理解するための大きな手助けとなります。