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

Copy
1<?php
2
3class CustomException extends Error
4{
5    /**
6     * 例外メッセージを上書きする
7     *
8     * @var string
9     */
10    protected $message = 'Unknown exception';
11
12    /**
13     * コンストラクタ
14     *
15     * @param string $message 例外メッセージ
16     * @param int $code 例外コード
17     */
18    public function __construct(string $message = "", int $code = 0)
19    {
20        // 親クラスのコンストラクタを呼び出す前に、$this->message を上書きする。
21        // 親クラスのコンストラクタは、$this->message を使用するため。
22        if (!empty($message)) {
23            $this->message = $message;
24        }
25        parent::__construct($this->message, $code);
26    }
27
28    /**
29     * 例外メッセージを取得する
30     *
31     * @return string
32     */
33    public function getMessage(): string
34    {
35        // Error クラスの getMessage メソッドをオーバーライド
36        return "Custom Exception: " . $this->message;
37    }
38}
39
40// 例外を発生させる
41try {
42    throw new CustomException("This is a custom error message.", 100);
43} catch (CustomException $e) {
44    // 例外メッセージを表示
45    echo $e->getMessage() . PHP_EOL;
46    // 例外コードを表示
47    echo "Error Code: " . $e->getCode() . PHP_EOL;
48}
49

このサンプルコードは、PHPのErrorクラスを拡張したCustomExceptionクラスで、getMessageメソッドをオーバーライドする方法を示しています。getMessageメソッドは、例外が発生した際に、その例外に関するメッセージを文字列として返す役割を持っています。

ErrorクラスのgetMessageメソッドをオーバーライドすることで、例外メッセージをカスタマイズできます。この例では、CustomExceptionクラス内でgetMessageメソッドをオーバーライドし、"Custom Exception: "というプレフィックスを付加したメッセージを返すようにしています。

コンストラクタでは、親クラスのコンストラクタを呼び出す前に、$this->message プロパティを上書きしています。これは、親クラスのコンストラクタが $this->message を使用するため、適切なメッセージを設定するために重要です。

try-catchブロックでは、CustomExceptionを発生させ、catchブロックでgetMessageメソッドを呼び出して、カスタマイズされた例外メッセージを表示しています。getCodeメソッドで例外コードも取得し表示しています。

このコードは、例外処理において、より具体的な情報を伝えるために、getMessageメソッドをオーバーライドする基本的な方法を理解するのに役立ちます。例外メッセージをカスタマイズすることで、デバッグやエラーハンドリングを効率的に行うことができます。

Copy
1<?php
2
3try {
4    // 例外を発生させる可能性のある処理
5    str_repeat("A", PHP_INT_MAX); // 非常に長い文字列を作成してメモリ不足を引き起こす
6} catch (Error $e) {
7    // エラーメッセージを取得
8    $errorMessage = $e->getMessage();
9
10    // エラーメッセージを出力 (getMessage() が切り捨てられたかどうかはメッセージの内容で判断する)
11    echo "エラーメッセージ: " . $errorMessage . PHP_EOL;
12}
13
14?>

このサンプルコードは、PHPのErrorクラスに属するgetMessageメソッドの使い方を示しています。getMessageメソッドは引数を取らず、エラーオブジェクトが持つエラーメッセージを文字列（string型）として返します。

この例では、まずtry-catch構文を使って例外処理を行います。tryブロック内では、非常に長い文字列を作成し、意図的にメモリ不足を引き起こす処理(str_repeat("A", PHP_INT_MAX))を実行しています。これによりErrorオブジェクトが生成され、catchブロックで捕捉されます。

catchブロック内では、捕捉したErrorオブジェクト $e に対してgetMessage()メソッドを呼び出し、エラーメッセージを取得しています。取得したエラーメッセージは $errorMessage 変数に格納され、echo文を使って出力されます。

getMessage()メソッドは、エラーの内容を説明する重要な情報を取得するために使用されます。ただし、エラーメッセージが非常に長い場合、PHPの設定によっては切り捨てられる可能性があります。サンプルコードでは、getMessage()が切り捨てられたかどうかはメッセージの内容を見て判断する必要がある点に注意してください。このサンプルコードを通じて、例外発生時のエラーメッセージの取得と出力方法を理解することができます。