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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 年齢を検証し、無効な場合はDomainExceptionをスローする関数。
7 *
8 * @param int $age 検証する年齢
9 * @throws DomainException 年齢が0未満の場合
10 */
11function validateAge(int $age): void
12{
13    // 年齢が、期待される値の範囲（ドメイン）である0以上かを確認します。
14    if ($age < 0) {
15        // 範囲外の場合、DomainExceptionをスローします。
16        throw new DomainException('年齢は0以上の値でなければなりません。');
17    }
18    echo "年齢 {$age}歳 は有効です。" . PHP_EOL;
19}
20
21/**
22 * ユーザーデータを処理する過程で、年齢の検証を行う関数。
23 *
24 * @param int $userAge ユーザーの年齢
25 */
26function processUserData(int $userAge): void
27{
28    echo "ユーザーデータの処理を開始します..." . PHP_EOL;
29    validateAge($userAge);
30    echo "ユーザーデータの処理が完了しました。" . PHP_EOL;
31}
32
33// --- メインの実行部分 ---
34
35try {
36    // 例外が発生する可能性のあるコードをtryブロックで囲みます。
37    // ここでは意図的に無効な値（-5）を渡し、例外を発生させます。
38    processUserData(-5);
39} catch (DomainException $e) {
40    // スローされたDomainExceptionをcatchブロックで捕捉します。
41    echo PHP_EOL;
42    echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
43    echo "--- スタックトレース情報 ---" . PHP_EOL;
44
45    // getTraceAsString()メソッドを呼び出します。
46    // これにより、例外が発生した地点までの関数の呼び出し履歴（スタックトレース）が
47    // 整形された文字列として返され、デバッグに役立ちます。
48    echo $e->getTraceAsString();
49}
50

このPHPサンプルコードは、例外処理におけるDomainExceptionクラスのgetTraceAsStringメソッドの使用例を示しています。このメソッドは、プログラムでエラー（例外）が発生した際に、その原因を調査するために役立ちます。

コードでは、まずvalidateAge関数が年齢を検証します。年齢が0未満の場合、その値は期待されるデータの範囲（ドメイン）から外れているため、DomainExceptionという種類の例外を発生させます。メインの処理ではtry...catch構文を使い、意図的に-5という不正な値を渡して例外を発生させています。発生した例外はcatchブロックで捕捉され、例外オブジェクトが変数$eに代入されます。

ここで重要なのが$e->getTraceAsString()です。このメソッドは引数を必要とせず、例外が発生した地点に至るまでの関数の呼び出し履歴（スタックトレース）を、整形された一つの文字列として返します。この文字列には、どのファイルの何行目が、どの順番で実行されてエラーに至ったかの詳細な情報が含まれています。これにより、開発者はエラーの原因を迅速かつ正確に特定でき、デバッグ作業を効率的に進めることが可能になります。