【PHP8.x】RuntimeException::messageプロパティの使い方
messageプロパティの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
『messageプロパティは、例外が発生した際の詳細な説明文を保持するプロパティです。』このプロパティは、PHPの全ての例外クラスの基底となるExceptionクラスで定義されており、実行時エラーを表すRuntimeExceptionクラスはこれを継承しています。プロパティに格納される文字列は、なぜ例外がスローされたのかを開発者が理解するための重要な情報となります。messageプロパティの値は、RuntimeExceptionのインスタンスを生成する際のコンストラクタの第一引数で設定します。例えば、new RuntimeException("ファイルが見つかりません。")のように記述すると、「ファイルが見つかりません。」という文字列がこのプロパティに格納されます。このプロパティはprotectedとして宣言されているため、クラスの外部から直接アクセスすることはできません。値を取得するには、公開されているgetMessage()メソッドを使用します。try-catch構文で例外を捕捉した際に、$exception->getMessage()のように呼び出すことで、設定されたエラーメッセージを取得し、ログに出力したり、利用者に通知したりすることが可能です。この仕組みにより、プログラムの実行時に発生した予期せぬエラーの原因を特定し、デバッグ作業を効率化できます。
構文(syntax)
1<?php 2 3try { 4 throw new RuntimeException("これは実行時エラーのメッセージです。"); 5} catch (RuntimeException $e) { 6 // RuntimeExceptionオブジェクトのメッセージを取得します 7 echo $e->getMessage(); 8} 9
引数(parameters)
引数なし
引数はありません
戻り値(return)
string
RuntimeExceptionクラスのmessageプロパティは、例外が発生した際の詳細なメッセージを文字列として返します。
サンプルコード
PHP RuntimeException message を alert する
1<?php 2 3declare(strict_types=1); 4 5/** 6 * ファイルの読み込みを試み、失敗した場合に例外メッセージを 7 * JavaScript のアラートボックスで表示するサンプルクラスです。 8 */ 9class FileProcessor 10{ 11 /** 12 * ファイルを読み込み、失敗時にメッセージボックスを表示します。 13 * 14 * @param string $filename 読み込むファイル名 15 * @return void 16 */ 17 public function process(string $filename): void 18 { 19 try { 20 // 存在しないファイルを読み込もうとして、意図的にエラーを発生させる 21 // file_get_contentsは失敗時に false を返す 22 $content = @file_get_contents($filename); 23 if ($content === false) { 24 // RuntimeExceptionをスローし、カスタムメッセージを設定する 25 throw new RuntimeException("ファイル '{$filename}' が見つかりません。"); 26 } 27 28 // 成功した場合の処理 (このサンプルでは何もしない) 29 echo "ファイルの読み込みに成功しました。"; 30 31 } catch (RuntimeException $e) { 32 // 捕捉した例外から message プロパティの値を取得する 33 $errorMessage = $e->getMessage(); 34 35 // JavaScriptインジェクションを防ぐため、メッセージをエスケープする 36 // JSONエンコードは、JavaScriptの文字列リテラルとして安全に出力する簡単な方法 37 $jsonEncodedMessage = json_encode($errorMessage); 38 39 // JavaScriptのalert()を使い、メッセージボックスを表示するHTMLを生成 40 echo <<<HTML 41<!DOCTYPE html> 42<html lang="ja"> 43<head> 44 <meta charset="UTF-8"> 45 <title>エラー通知</title> 46</head> 47<body> 48 <script> 49 // PHPから受け取ったエラーメッセージをアラートで表示 50 alert({$jsonEncodedMessage}); 51 </script> 52 <p>エラーが発生しました。詳細はメッセージボックスを確認してください。</p> 53</body> 54</html> 55HTML; 56 } 57 } 58} 59 60// クラスのインスタンスを作成 61$processor = new FileProcessor(); 62 63// 存在しないファイル名を渡してメソッドを実行 64$processor->process('non_existent_file.txt'); 65
RuntimeExceptionクラスのmessageプロパティは、プログラムの実行時に発生したエラー（例外）に関する説明的なメッセージを文字列として保持します。このプロパティの値は、new RuntimeException()でオブジェクトが生成される際に引数として渡された文字列が設定されます。
サンプルコードでは、まずtryブロック内で、存在しないファイルを読み込もうとして意図的にエラー状況を作り出しています。ファイルの読み込みに失敗すると、throw new RuntimeException(...)の記述により、引数に指定したエラーメッセージを持つRuntimeExceptionオブジェクトが生成され、発生（スロー）されます。
次にcatchブロックで、発生したRuntimeExceptionを$eという変数で捕捉します。そして$e->getMessage()メソッドを呼び出すことで、messageプロパティに格納されている「ファイル 'non_existent_file.txt' が見つかりません。」という文字列を取得します。getMessage()メソッドは引数を取らず、戻り値としてmessageプロパティの文字列（string型）を返します。取得したメッセージは、JavaScriptのalert()関数に渡され、ブラウザ上にメッセージボックスとして表示されます。このようにmessageプロパティは、発生したエラーの具体的な内容をユーザーに通知したり、ログに記録したりする際に利用されます。
このサンプルコードは、PHPで発生したエラーメッセージをブラウザのメッセージボックスで表示するものです。エラー出力を抑制する@演算子は、デバッグを困難にするため多用は避けるべきです。try...catch構文でエラーを適切に捕捉することが、安全なプログラムの基本となります。捕捉した例外オブジェクトのgetMessage()メソッドを使うことで、エラー発生時に設定されたメッセージ文字列を取得できます。最も重要な点は、PHPの変数をJavaScriptに出力する際のセキュリティ対策です。json_encode()関数で変数をエスケープすることで、悪意のあるスクリプトの埋め込み（クロスサイトスクリプティング）を防ぎ、安全性を高めることができます。
PHP RuntimeException によるメッセージキュー処理
1<?php 2 3declare(strict_types=1); 4 5/** 6 * シンプルなインメモリメッセージキューをシミュレートするクラス。 7 * キューが空の状態でメッセージを取り出そうとすると、RuntimeException が発生します。 8 */ 9class SimpleMessageQueue 10{ 11 /** 12 * @var string[] メッセージを保持するキュー 13 */ 14 private array $queue = []; 15 16 /** 17 * キューにメッセージを追加します（エンキュー）。 18 * 19 * @param string $taskMessage 追加するタスクメッセージ 20 */ 21 public function enqueue(string $taskMessage): void 22 { 23 $this->queue[] = $taskMessage; 24 echo "キューにタスクを追加しました: '{$taskMessage}'" . PHP_EOL; 25 } 26 27 /** 28 * キューからメッセージを1つ取り出します（デキュー）。 29 * 30 * @return string 取り出したタスクメッセージ 31 * @throws RuntimeException キューが空の場合にスローされる 32 */ 33 public function dequeue(): string 34 { 35 if (empty($this->queue)) { 36 // キューが空のときは、実行時エラーとして RuntimeException をスローする 37 throw new RuntimeException('メッセージキューが空のため、タスクを取得できませんでした。'); 38 } 39 40 // 配列の先頭から要素を取り出して返す 41 return array_shift($this->queue); 42 } 43 44 /** 45 * キューが空かどうかを返します。 46 * 47 * @return bool 48 */ 49 public function isEmpty(): bool 50 { 51 return empty($this->queue); 52 } 53} 54 55// --- 以下、サンプルコードの実行部分 --- 56 57$queue = new SimpleMessageQueue(); 58 59// タスクをキューに追加 60$queue->enqueue('ユーザーID:100へのメール送信'); 61$queue->enqueue('商品ID:500の在庫更新'); 62 63echo "--- キューの処理を開始 ---" . PHP_EOL; 64 65try { 66 // キューが空になるまでタスクを処理し続ける 67 while (!$queue->isEmpty()) { 68 $task = $queue->dequeue(); 69 echo "処理中のタスク: '{$task}'" . PHP_EOL; 70 // 本来はここでタスクに応じた重い処理を実行する 71 } 72 73 // すべてのタスクを処理したので、キューは空になっているはず 74 echo "--- 全てのタスクが完了しました ---" . PHP_EOL; 75 76 // わざと空のキューから再度タスクを取り出し、例外を発生させる 77 echo "空のキューからタスクを取得しようと試みます..." . PHP_EOL; 78 $queue->dequeue(); 79 80} catch (RuntimeException $e) { 81 // RuntimeException がスローされた場合、ここでキャッチする 82 echo "==============================" . PHP_EOL; 83 echo "エラーが発生しました！" . PHP_EOL; 84 // Exception オブジェクトの getMessage() メソッドでエラーメッセージを取得して表示する 85 // これが RuntimeException->message プロパティの値に相当する 86 echo "エラーメッセージ: " . $e->getMessage() . PHP_EOL; 87 echo "==============================" . PHP_EOL; 88}
このPHPサンプルコードは、「メッセージキュー」という非同期処理でよく使われる仕組みを簡易的にクラスとして実装したものです。メッセージキューは、実行したいタスクを一時的に保管しておく場所として機能します。
SimpleMessageQueueクラスには、キューにタスクを追加するenqueueメソッドと、先頭からタスクを1つ取り出すdequeueメソッドが定義されています。このコードの重要な点は、dequeueメソッド内でキューが空の場合に、実行時エラーを表すRuntimeExceptionという種類の例外をthrow（スロー）している部分です。
例外をthrowする際、new RuntimeException()の引数に渡されたエラーメッセージの文字列は、そのオブジェクトのmessageプロパティに保存されます。
コードの実行部分では、try...catchブロックが使われています。これは、tryブロック内で発生した例外をcatchブロックで捕捉（キャッチ）するための構文です。意図的に空のキューからタスクを取り出して例外を発生させ、catchブロックでRuntimeExceptionオブジェクト（変数$e）として受け取ります。
最後に、$e->getMessage()メソッドを呼び出しています。このメソッドは引数を取らず、RuntimeExceptionが内部に保持しているmessageプロパティの値を文字列（string）として返します。これにより、例外発生時に設定されたエラーメッセージを画面に表示することができます。
このコードのように、失敗する可能性のある処理を呼び出す際は、try...catch構文でエラーを捕捉することが重要です。もし捕捉しない場合、プログラムはエラー箇所で強制終了してしまいます。catchブロックで受け取った例外オブジェクトの getMessage() メソッドを呼び出すと、エラー発生時に設定された具体的なメッセージを取得できます。このメッセージは、RuntimeException の message プロパティに格納された値であり、エラーの原因調査に役立ちます。なお、このサンプルはメモリ上で動く簡易的なキューのため、プログラムが終了するとデータは消えます。実際のシステムでは、より堅牢な仕組みが必要です。