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

Copy
1<?php
2
3/**
4 * MyCustomException クラス
5 *
6 * PHPの標準Exceptionクラスを継承し、getMessage()メソッドをオーバーライドする例です。
7 * プログラミング言語リファレンス情報にあるCompileErrorクラスもgetMessage()メソッドを持ちますが、
8 * これはPHP内部のコンパイルエラー用であり、開発者が直接インスタンス化したり、getMessageを
9 * オーバーライドしたりすることは稀です。
10 * 本コードは、「php exception override getmessage」というキーワードに基づき、
11 * 一般的なアプリケーションでカスタム例外を作成し、そのgetMessage()メソッドをカスタマイズする方法を示します。
12 */
13class MyCustomException extends Exception
14{
15    // 例外に追加する独自のデータ（例: エラーが発生した具体的な原因）
16    private string $contextData;
17
18    /**
19     * コンストラクタ
20     *
21     * @param string $message 例外の基本メッセージ
22     * @param int $code 例外コード
23     * @param string $contextData 例外に関する追加のコンテキストデータ
24     * @param Throwable|null $previous 前の例外 (例外チェイン用、PHP 7.0以降)
25     */
26    public function __construct(string $message = "", int $code = 0, string $contextData = "", Throwable $previous = null)
27    {
28        // 親クラス(Exception)のコンストラクタを呼び出し、基本メッセージなどを設定
29        parent::__construct($message, $code, $previous);
30        // カスタムプロパティにデータを設定
31        $this->contextData = $contextData;
32    }
33
34    /**
35     * getMessage()メソッドのオーバーライド
36     *
37     * このメソッドを再定義することで、例外オブジェクトが持つ情報を基に、
38     * より詳細で分かりやすいエラーメッセージを生成できます。
39     * ここでは、親クラスのメッセージに、このカスタム例外が持つ追加データを組み合わせて返します。
40     *
41     * @return string カスタムされた例外メッセージ
42     */
43    public function getMessage(): string
44    {
45        return "カスタムエラー発生: " . parent::getMessage() . " [詳細: " . $this->contextData . "]";
46    }
47
48    /**
49     * 例外が持つ追加データを取得するカスタムメソッド
50     *
51     * @return string
52     */
53    public function getContextData(): string
54    {
55        return $this->contextData;
56    }
57}
58
59// --- カスタム例外の使用例 ---
60
61try {
62    // MyCustomExceptionをスローします。
63    // 基本メッセージと、例外に関する追加のコンテキストデータを渡します。
64    throw new MyCustomException("設定ファイルの読み込みに失敗しました", 1001, "ファイル 'config.ini' が見つかりません");
65} catch (MyCustomException $e) {
66    // MyCustomExceptionを捕捉した場合の処理
67    echo "--- カスタム例外が捕捉されました ---\n";
68    // オーバーライドされたgetMessage()メソッドの結果を表示
69    echo "メッセージ: " . $e->getMessage() . "\n";
70    echo "コード: " . $e->getCode() . "\n";
71    echo "発生ファイル: " . $e->getFile() . "\n";
72    echo "発生行: " . $e->getLine() . "\n";
73    // カスタムメソッドで追加データを取得
74    echo "捕捉された追加データ (getContextData()より): " . $e->getContextData() . "\n";
75
76} catch (Exception $e) {
77    // その他の一般的なExceptionを捕捉した場合の処理（この例では発生しません）
78    echo "--- 一般的な例外が捕捉されました ---\n";
79    echo "メッセージ: " . $e->getMessage() . "\n";
80} finally {
81    // try-catchブロックの後に必ず実行される処理
82    echo "--- 例外処理ブロックが終了しました ---\n";
83}
84

PHPのCompileError::getMessageは、PHP内部のコンパイルエラーに関するメッセージを取得するメソッドで、通常、開発者が直接操作することは稀です。このサンプルコードは、一般的なアプリケーション開発において、独自の例外クラスを作成し、そのエラーメッセージをカスタマイズする方法を示しています。

ここでは、標準のExceptionクラスを継承してMyCustomExceptionというカスタム例外クラスを作成しています。このクラスでは、親クラスが持つgetMessage()メソッドをオーバーライド（再定義）しています。オーバーライドされたgetMessage()メソッドは、引数なしで呼び出され、このカスタム例外クラスが独自に持つ$contextDataプロパティの情報を、親クラスのメッセージと組み合わせて、より詳細で分かりやすいエラーメッセージ（string型）を返します。

try-catchブロックでは、このMyCustomExceptionをスローし、捕捉しています。例外が捕捉された後、$e->getMessage()を呼び出すと、オーバーライドされたメソッドが実行され、定義したカスタム形式のメッセージ（例：「カスタムエラー発生: ... [詳細: ...]」）が表示されます。これにより、例外発生時の状況をより具体的に伝えるメッセージを柔軟に生成し、デバッグやエラーハンドリングを効率的に行えるようになります。

Copy
1<?php
2
3/**
4 * PHPのCompileError::getMessage() メソッドの動作と、
5 * 長いエラーメッセージを切り詰める処理を示すサンプルコードです。
6 *
7 * CompileError は PHP エンジンのコンパイル時に発生する特殊なエラーで、
8 * ユーザーコードから直接生成したり意図的に発生させたりすることは通常困難です。
9 * しかし、CompileError も Throwable インターフェースを実装しているため、
10 * getMessage() メソッドの動作は本例で示している Error の場合と同様に機能します。
11 *
12 * この関数では、長いエラーメッセージを持つ Error を意図的に発生させ、
13 * getMessage() でメッセージを取得後、特定の長さに切り詰める方法を示します。
14 */
15function demonstrateErrorMessageTruncation(): void
16{
17    // 非常に長く、表示領域によっては切り詰めが必要になる可能性のあるエラーメッセージを準備します。
18    $longMessage = "これは、詳細な情報を含む非常に長いエラーメッセージの例です。" .
19                   "多くのシステムでは、エラーログやUI表示の都合上、メッセージが長すぎると" .
20                   "表示が困難になったり、視認性が低下したりする問題が発生します。" .
21                   "したがって、エラーメッセージを特定の長さに切り詰める処理が必要になることがあります。" .
22                   "このメッセージの後半部分には、デバッグに役立つと思われる追加情報やコンテキストデータが" .
23                   "含まれていることを想定していますが、例示のため繰り返しテキストを使用しています。";
24
25    try {
26        // 意図的に Error をスローし、上記の長いメッセージを含めます。
27        // CompileError も Throwable を実装しており、getMessage() は同様に動作します。
28        throw new Error($longMessage);
29    } catch (Error $e) {
30        // getMessage() メソッドでエラーオブジェクトからメッセージを取得します。
31        $originalMessage = $e->getMessage();
32
33        echo "--- オリジナルのエラーメッセージ ---" . PHP_EOL;
34        echo $originalMessage . PHP_EOL;
35        echo "メッセージの長さ: " . mb_strlen($originalMessage) . " 文字" . PHP_EOL;
36        echo PHP_EOL;
37
38        // メッセージを切り詰める最大長を定義します (例: 100文字)。
39        $maxLength = 100;
40        $truncatedMessage = $originalMessage; // まずはオリジナルで初期化
41
42        // 元のメッセージが最大長を超える場合のみ切り詰めます。
43        if (mb_strlen($originalMessage) > $maxLength) {
44            // mb_substr() を使用してマルチバイト文字にも対応しながらメッセージを切り詰めます。
45            $truncatedMessage = mb_substr($originalMessage, 0, $maxLength);
46            // 切り詰められたことを示すために "..." を追加します。
47            $truncatedMessage .= "...";
48        }
49
50        echo "--- 切り詰められたエラーメッセージ (最大 {$maxLength} 文字) ---" . PHP_EOL;
51        echo $truncatedMessage . PHP_EOL;
52        echo "切り詰められたメッセージの長さ: " . mb_strlen($truncatedMessage) . " 文字" . PHP_EOL;
53    }
54}
55
56// 関数を実行し、エラーメッセージの取得と切り詰め処理を実演します。
57demonstrateErrorMessageTruncation();

PHPのCompileError::getMessage()メソッドは、プログラムのコンパイル時に発生するエラーオブジェクトから、その詳細なエラーメッセージを取得するために使用されます。このメソッドは引数を必要とせず、エラーに関する情報を含む文字列を返します。CompileErrorはPHPエンジン内部で発生する特殊なエラーですが、他のErrorやExceptionと同様にThrowableインターフェースを実装しているため、getMessage()メソッドの動作は共通です。

提供されたサンプルコードでは、直接CompileErrorを発生させる代わりに、同様にThrowableを実装するErrorオブジェクトを用いて、getMessage()の動作とエラーメッセージの処理方法を実演しています。特に、非常に長いエラーメッセージを取得した後、それを特定の文字数（例：100文字）に切り詰める処理を示しています。これは、エラーログの可読性を高めたり、ユーザーインターフェースでの表示領域に合わせたりするために重要となることがあります。mb_substr()関数を使用することで、日本語のようなマルチバイト文字を含むメッセージも正確に切り詰めることが可能です。このように、getMessage()で取得した情報は、システム運用において適切に整形して利用されることが一般的です。