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

Copy
1<?php
2
3/**
4 * MyCustomException クラスは標準の Exception クラスを継承し、
5 * 独自の例外タイプを定義します。
6 * このクラスを拡張することで、特定のアプリケーションエラーに
7 * 特化した情報や挙動を持たせることができます。
8 */
9class MyCustomException extends Exception
10{
11    /**
12     * コンストラクタをオーバーライドし、カスタムメッセージ、コード、前の例外を
13     * 親クラス (Exception) に渡します。これにより、基盤となる例外の機能が
14     * 適切に初期化されます。
15     *
16     * @param string $message  例外のユーザーフレンドリーな説明
17     * @param int    $code     例外を識別するための数値コード
18     * @param ?Throwable $previous オプションで、この例外を引き起こした前の例外
19     */
20    public function __construct(string $message = "不明なカスタムエラー", int $code = 0, ?Throwable $previous = null)
21    {
22        // 親クラスのコンストラクタを呼び出し、基盤となる例外機能を初期化します。
23        parent::__construct($message, $code, $previous);
24    }
25
26    /**
27     * Exception::getMessage() メソッドをオーバーライドし、
28     * カスタム形式の例外メッセージを返します。
29     *
30     * このメソッドをオーバーライドすることで、例外がキャッチされた際に表示される
31     * メッセージの形式を自由にカスタマイズできます。例えば、より詳細な情報や
32     * 開発者向けのデバッグ情報を追加することができます。
33     *
34     * @return string カスタム形式の例外メッセージ
35     */
36    public function getMessage(): string
37    {
38        // 親クラスの getMessage() を呼び出して元のメッセージを取得し、
39        // それに追加情報を組み込む形でメッセージを構築します。
40        // これにより、元のエラー原因も保持しつつ、カスタムな情報を提供できます。
41        $originalMessage = parent::getMessage();
42
43        return "【カスタムエラー報告】 " . $originalMessage .
44               " (発生ファイル: " . $this->getFile() .
45               " 行: " . $this->getLine() .
46               " | エラーコード: " . $this->getCode() . " )";
47    }
48
49    /**
50     * 必要に応じて、このカスタム例外に固有の追加メソッドを追加できます。
51     * 例えば、特定のデバッグ情報を提供するメソッドなどです。
52     *
53     * @return string このカスタム例外の特別な情報
54     */
55    public function getCustomDebugInfo(): string
56    {
57        return "デバッグヒント: このエラーはデータ検証の失敗に関連しています。";
58    }
59}
60
61// --------------------------------------------------------------------------
62// MyCustomException クラスの動作を示すデモンストレーション
63// --------------------------------------------------------------------------
64
65// try-catch ブロックを使用して、例外の発生と捕捉を試みます。
66try {
67    echo "処理を開始します。\n";
68
69    // MyCustomException をスローします。
70    // コンストラクタに渡したメッセージが、parent::getMessage() で取得され、
71    // オーバーライドされた getMessage() によって整形されます。
72    throw new MyCustomException("ユーザー入力データが無効です", 5001);
73
74    echo "この行は例外がスローされたため実行されません。\n";
75
76} catch (MyCustomException $e) {
77    // MyCustomException がスローされた場合、このブロックで捕捉されます。
78    echo "\n--- カスタム例外がキャッチされました ---\n";
79
80    // オーバーライドされた MyCustomException::getMessage() メソッドが
81    // 自動的に呼び出され、カスタム形式のメッセージが表示されます。
82    echo "エラーメッセージ: " . $e->getMessage() . "\n";
83
84    // getCustomDebugInfo() メソッドで追加のカスタム情報を取得できます。
85    echo "追加情報: " . $e->getCustomDebugInfo() . "\n";
86
87    // 例外のスタックトレースも表示できます (開発者向けのデバッグ情報)。
88    echo "スタックトレース:\n" . $e->getTraceAsString() . "\n";
89
90} catch (Exception $e) {
91    // その他の標準例外がスローされた場合のフォールバックです。
92    // MyCustomException ではない例外がスローされた場合に捕捉されます。
93    echo "\n--- 標準例外がキャッチされました ---\n";
94    echo "エラーメッセージ: " . $e->getMessage() . "\n";
95    echo "エラーコード: " . $e->getCode() . "\n";
96} finally {
97    // try-catch-finally ブロックが終了した後、必ず実行されるコードです。
98    echo "\n例外処理のデモンストレーションが完了しました。\n";
99}
100
101echo "プログラムは通常通り続行されます。\n";
102
103?>

PHPでは、プログラム実行中に問題が発生した際に「例外」として扱い、その状況を把握するための仕組みが提供されています。この例外の基本となるのがExceptionクラスです。

Exceptionクラスに用意されているgetMessage()メソッドは、例外が発生した際にその原因や詳細を説明するエラーメッセージを取得するために使われます。このメソッドは引数を必要とせず、例外に関する情報を含む文字列を戻り値として返します。

サンプルコードでは、標準のExceptionクラスを継承してMyCustomExceptionという独自の例外クラスを定義し、getMessage()メソッドをオーバーライドしています。これにより、単にエラーメッセージを返すだけでなく、エラーが発生したファイル名や行番号、エラーコードといった追加情報を自動的に付加した、より詳細なカスタムメッセージを生成できるようになります。

このようにgetMessage()をオーバーライドすることで、開発者は例外が捕捉された際に、デバッグや問題解決に役立つ形式のメッセージをユーザーやシステムログに出力できます。try-catchブロックでMyCustomExceptionを捕捉すると、このカスタム形式のメッセージが自動的に表示され、エラー発生時の状況把握と原因特定を効率的に進めることが可能になるため、堅牢なシステム開発において非常に有効な手段です。

Copy
1<?php
2
3/**
4 * 入力データの長さをチェックし、長すぎる場合は例外をスローする関数。
5 * Exception::getMessage() メソッドの動作をデモンストレーションします。
6 *
7 * @param string $data 処理するデータ
8 * @throws Exception データが長すぎる場合
9 */
10function processDataWithLengthCheck(string $data): void
11{
12    // 意図的に長いメッセージを持つ例外を生成する条件
13    if (strlen($data) > 100) {
14        // Exception::getMessage() が取得するメッセージは、ここで設定されます。
15        // このメッセージは長く、キーワード "truncated" (切り詰められる) に関連付けています。
16        throw new Exception(
17            "入力データが長すぎます。許容される最大長は100文字ですが、現在の長さは " . strlen($data) . " 文字です。" .
18            "Exception::getMessage() はこの完全なメッセージを返します。" .
19            "ただし、このメッセージをログファイルや画面に表示する際に、" .
20            "出力先の制限によってメッセージの一部が切り詰められる (truncated) 可能性があります。"
21        );
22    }
23    echo "データ処理成功: " . $data . "\n";
24}
25
26// ----- メイン処理 -----
27try {
28    echo "--- 短いデータを処理するケース (成功) ---\n";
29    processDataWithLengthCheck("短いデータです。");
30
31    echo "\n--- 長いデータを処理するケース (例外発生) ---\n";
32    // 150文字の長い文字列を生成し、例外を発生させる
33    $longString = str_repeat("X", 150);
34    processDataWithLengthCheck($longString);
35
36} catch (Exception $e) {
37    // 例外を捕捉し、getMessage() メソッドで例外メッセージを取得します。
38    echo "\n--- 例外を捕捉しました ---\n";
39    echo "エラーメッセージ: " . $e->getMessage() . "\n";
40    echo "ファイル: " . $e->getFile() . " (行: " . $e->getLine() . ")\n";
41
42    // 補足:
43    // Exception::getMessage() メソッドは常に例外オブジェクトに設定された完全なメッセージを返します。
44    // メッセージが「切り詰められる (truncated)」可能性は、取得したメッセージを
45    // コンソール、ログファイル、データベースなどに出力する際の表示制限によるものであり、
46    // getMessage() メソッド自体の動作ではありません。
47}

PHPのException::getMessage()メソッドは、プログラム実行中に発生した例外（エラー）に関する詳細なメッセージを取得するために使用されます。このメソッドはExceptionクラスに属しており、例外オブジェクトが作成される際に設定されたエラーメッセージを返します。

getMessage()メソッドは引数を必要とせず、呼び出すと例外オブジェクトに格納されているエラーメッセージを文字列（string）として返します。

提供されたサンプルコードでは、processDataWithLengthCheck関数が入力データの長さが100文字を超えた場合に例外をスローします。この際、例外オブジェクトには「入力データが長すぎます...」という詳細なメッセージが設定されています。

メイン処理では、try-catchブロックを使って例外を捕捉しています。データが長すぎて例外が発生した場合、catchブロック内で$e->getMessage()を呼び出すことで、先ほど設定された完全なエラーメッセージを取り出し、画面に表示しています。

ここで重要なのは、Exception::getMessage()メソッド自体がメッセージを「切り詰める（truncated）」ことはないという点です。このメソッドは常に例外オブジェクトに設定された元の完全なメッセージを返します。メッセージが切り詰められる可能性があるというのは、取得したメッセージをコンソール、ログファイル、データベースなどの出力先で表示する際に、その出力先の表示制限によってメッセージの一部が見えなくなる（truncated）場合を指します。getMessage()は、エラーの内容を正確に把握し、問題解決に役立てるための重要な手段です。