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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 意図的に実行時エラーを発生させる関数。
7 *
8 * @throws RuntimeException 常に例外を発生させる
9 */
10function simulateError(): void
11{
12    // RuntimeExceptionは、プログラム実行中に発生したエラーを示すための例外です。
13    // ここでは「サーバーに接続できません。」というメッセージを持った例外を意図的に発生させます。
14    throw new RuntimeException('サーバーに接続できません。');
15}
16
17try {
18    // 例外が発生する可能性のある処理を try ブロックで囲みます。
19    simulateError();
20} catch (RuntimeException $e) {
21    // try ブロック内で RuntimeException が発生した場合、この catch ブロックが実行されます。
22    // 変数 $e には、発生した例外の情報を持つオブジェクトが格納されます。
23
24    // $e->getMessage() メソッドを使い、例外オブジェクトからメッセージ文字列を取得します。
25    $errorMessage = $e->getMessage();
26
27    // 取得したエラーメッセージを画面に出力します。
28    // 出力結果: エラー: サーバーに接続できません。
29    echo 'エラー: ' . $errorMessage . PHP_EOL;
30}
31

$e->getMessage()は、catchブロックで捕捉した例外オブジェクトから、エラーメッセージの文字列を取得するためのメソッドです。プログラムでエラーが発生した際に、その具体的な内容を知るために使用します。

サンプルコードでは、まずtryブロックの中で意図的にRuntimeExceptionという例外を発生させています。この例外が作られる際に、「サーバーに接続できません。」というメッセージが設定されています。例外が発生すると、処理はcatchブロックに移ります。

catchブロックでは、発生した例外の情報を持つオブジェクトが変数$eに代入されます。ここで$e->getMessage()を呼び出すと、例外オブジェクトに保存されていた「サーバーに接続できません。」という文字列が取得できます。このメソッドは引数を必要とせず、戻り値として例外に設定されたメッセージ文字列（string型）を返します。

このように、getMessage()を使うことで、発生した例外の具体的な原因を取得し、それを画面に表示したり、ログファイルに記録したりすることが可能になります。

Copy
1<?php
2
3/**
4 * ユーザー情報を取得する関数（データベース接続失敗をシミュレート）
5 *
6 * @param int $userId ユーザーID
7 * @return array<string, mixed> ユーザー情報
8 * @throws RuntimeException 処理の続行が不可能な実行時エラーが発生した場合
9 */
10function findUserById(int $userId): array
11{
12    // 実行時エラー（例: データベースに接続できない）をシミュレートします。
13    $isDbConnected = false;
14
15    if (!$isDbConnected) {
16        // 実行時に発生した問題を RuntimeException としてスローします。
17        // コンストラクタの引数に渡した文字列が、例外メッセージになります。
18        throw new RuntimeException("データベースに接続できませんでした。");
19    }
20
21    // 本来はここでデータベースからユーザー情報を取得して返す
22    return ['id' => $userId, 'name' => 'Taro Yamada'];
23}
24
25// 例外が発生する可能性のある処理を try ブロックで囲みます。
26try {
27    // この関数呼び出しで RuntimeException がスローされます。
28    $user = findUserById(1);
29    print_r($user);
30} catch (RuntimeException $e) {
31    // catch ブロックでスローされた RuntimeException を捕捉します。
32    // $e は RuntimeException のインスタンスです。
33
34    // getMessage() メソッドを使い、例外オブジェクトからエラーメッセージ文字列を取得します。
35    $message = $e->getMessage();
36
37    // 取得したエラーメッセージを画面に出力します。
38    // 出力: "エラーが発生しました: データベースに接続できませんでした。"
39    echo "エラーが発生しました: " . $message . PHP_EOL;
40}

RuntimeExceptionクラスのgetMessageメソッドは、発生した例外（エラー）に関する詳細なメッセージを文字列として取得するために使用します。

PHPでは、プログラムの実行中に予期せぬ問題が発生した場合、「例外」をスロー（throw）してエラーの発生を知らせます。このスローされた例外は、try-catchブロックで捕捉（キャッチ）して、エラー処理を行うのが一般的です。

サンプルコードでは、findUserById関数の中で、データベース接続の失敗を想定してnew RuntimeException("データベースに接続できませんでした。")という形で意図的に例外を発生させています。このとき、コンストラクタに渡された文字列が、この例外のエラーメッセージとして内部に保存されます。

catchブロックでは、発生したRuntimeExceptionのインスタンスを$eという変数で受け取っています。そして、$e->getMessage()を呼び出すことで、先ほど保存されたエラーメッセージ「データベースに接続できませんでした。」を文字列として取り出しています。

このメソッドに引数は必要ありません。戻り値は、例外オブジェクトが保持しているエラーメッセージの文字列（string）です。取得したメッセージは、ログへの記録や、ユーザーへのエラー通知などに活用できます。