【PHP8.x】Random\RandomException::__construct()メソッドの使い方

Copy
1<?php
2
3/**
4 * PHP 8 で導入された Constructor Promotion (コンストラクタプロモーション) のサンプルコードです。
5 *
6 * Random\RandomException はPHPの組み込み例外クラスであり、そのコンストラクタ (__construct) を
7 * ユーザーが Constructor Promotion を使って定義し直すことはできません。
8 *
9 * このコードでは、Random\RandomException のコンストラクタ引数 (メッセージ、コード、先行例外) と
10 * 同じ構成を持つ独自のカスタム例外クラスを定義し、そこで Constructor Promotion を適用する例を示します。
11 * Constructor Promotion を使うと、コンストラクタの引数をプロパティとして宣言し、
12 * 自動的に初期化されるため、冗長なコードを削減できます。
13 */
14class MyCustomPromotionException extends \Exception
15{
16    /**
17     * Constructor Promotion を使用したコンストラクタの例。
18     *
19     * コンストラクタ引数に public, protected, private のいずれかのアクセス修飾子を付けることで、
20     * その引数が自動的に同じ名前とアクセスレベルのクラスプロパティとして定義され、
21     * コンストラクタ呼び出し時に渡された値で初期化されます。
22     *
23     * @param string $message  例外のメッセージ。
24     * @param int $code        例外のコード番号。
25     * @param Throwable|null $previous 先行する（原因となった）例外オブジェクト。PHP 7.4以降のnullableタイプヒント。
26     */
27    public function __construct(
28        // アクセス修飾子 (private) を付けて引数をプロパティとして定義
29        private string $message = '',
30        private int $code = 0,
31        private ?\Throwable $previous = null // ?\Throwable は「Throwable型またはnull」を意味します
32    ) {
33        // 親クラス (Exception) のコンストラクタを呼び出し、基本的な例外情報を設定します。
34        // Constructor Promotion で定義されたプロパティを親クラスに渡すこともできます。
35        parent::__construct($this->message, $this->code, $this->previous);
36
37        // Constructor Promotion を使わない場合、通常は以下のようにプロパティを宣言し、
38        // コンストラクタ内で $this->message = $message; のように初期化する必要があります。
39        // private string $message;
40        // public function __construct(string $message, ...) { $this->message = $message; }
41    }
42
43    /**
44     * このカスタム例外の使用例を示すメソッド。
45     *
46     * @param string $input 処理対象の文字列データ。
47     */
48    public static function processData(string $input): void
49    {
50        echo "--- データ処理: '{$input}' ---\n";
51        try {
52            if (empty($input)) {
53                // Constructor Promotion で定義したカスタム例外をスロー
54                throw new MyCustomPromotionException("入力データが空です。", 5001);
55            }
56            if (strlen($input) < 5) {
57                // 先行例外を含むカスタム例外をスロー
58                throw new MyCustomPromotionException(
59                    "入力データが短すぎます。",
60                    5002,
61                    new \InvalidArgumentException("最低5文字が必要です。")
62                );
63            }
64            echo "処理成功: データは有効です。\n";
65        } catch (MyCustomPromotionException $e) {
66            echo "捕捉されたカスタム例外:\n";
67            echo "  メッセージ: " . $e->getMessage() . "\n";
68            echo "  コード: " . $e->getCode() . "\n";
69            if ($e->getPrevious() !== null) {
70                echo "  先行例外メッセージ: " . $e->getPrevious()->getMessage() . "\n";
71                echo "  先行例外クラス: " . get_class($e->getPrevious()) . "\n";
72            }
73            echo "  ファイル: " . $e->getFile() . " (行: " . $e->getLine() . ")\n";
74        } catch (\Exception $e) {
75            echo "捕捉された予期せぬ一般例外: " . $e->getMessage() . "\n";
76        }
77    }
78}
79
80// サンプルコードの実行
81MyCustomPromotionException::processData("Hello World");
82echo "\n";
83MyCustomPromotionException::processData("");
84echo "\n";
85MyCustomPromotionException::processData("abc");
86echo "\n";
87MyCustomPromotionException::processData("12345"); // 成功ケース

PHPのRandom\RandomException::__constructは、Random\RandomExceptionオブジェクトが生成される際に自動的に呼び出される特別なメソッドです。このメソッドは、例外発生時の状況を伝えるための初期設定を行います。引数として、例外の内容を説明する文字列$message、エラーの種類を示す整数$code、そしてこの例外が何らかの別の例外によって引き起こされた場合にその元の例外オブジェクトを渡す$previousを受け取ります。戻り値は特にありません。

サンプルコードでは、PHP 8で導入された「Constructor Promotion（コンストラクタプロモーション）」の概念を説明するため、組み込みのRandom\RandomExceptionではなく、引数の構成が同じ独自のカスタム例外クラスMyCustomPromotionExceptionを作成しています。Constructor Promotionを使用すると、コンストラクタの引数に直接privateのようなアクセス修飾子を付けることで、その引数がクラスのプロパティとして自動的に定義され、かつ初期化されるため、プロパティの宣言と代入のコードを省略でき、より簡潔に記述できます。このようにして定義されたプロパティは、オブジェクト内部で$this->messageのようにアクセス可能です。この機能により、コードの可読性と保守性が向上します。

Copy
1<?php
2
3// PHP 8以降で導入されたコンストラクタプロパティプロモーションの例です。
4// Random\RandomException::__construct の引数シグネチャを参考に、
5// カスタム例外クラスでプロパティプロモーションを適用する方法を示します。
6
7class MyServiceException extends Exception
8{
9    /**
10     * コンストラクタプロパティプロモーションを使用して、
11     * メッセージ、コード、前の例外をプロパティとして定義し、初期化します。
12     *
13     * @param string $message 例外メッセージ。publicプロパティとして定義。
14     * @param int $code 例外コード。publicプロパティとして定義。
15     * @param Throwable|null $previous 前の例外 (存在する場合)。publicプロパティとして定義。
16     */
17    public function __construct(
18        public string $message = '',
19        public int $code = 0,
20        public ?Throwable $previous = null
21    ) {
22        // 基底クラス(Exception)のコンストラクタを呼び出します。
23        // プロパティプロモーションはプロパティの宣言と初期化を行いますが、
24        // 基底クラスのコンストラクタ呼び出しは別途行う必要があります。
25        parent::__construct($message, $code, $previous);
26    }
27
28    // 必要に応じて、このカスタム例外に固有のメソッドを追加できます。
29}
30
31/**
32 * サービス内でエラーが発生した場合をシミュレートする関数。
33 * 特定の条件でMyServiceExceptionをスローします。
34 *
35 * @param bool $shouldFail 失敗させるかどうか。
36 * @return string
37 * @throws MyServiceException
38 */
39function performServiceOperation(bool $shouldFail): string
40{
41    if ($shouldFail) {
42        // Random\RandomException のコンストラクタと同様の引数でカスタム例外をスロー。
43        // 例として、前の例外（previous）も渡してみます。
44        $innerException = new RuntimeException("内部処理で問題が発生しました。", 500);
45        throw new MyServiceException(
46            "サービス操作中に予期せぬエラーが発生しました。",
47            1001, // カスタムエラーコード
48            $innerException // 前の例外
49        );
50    }
51    return "サービス操作は正常に完了しました。";
52}
53
54// サービス操作を実行してみます
55try {
56    echo performServiceOperation(false) . PHP_EOL; // 成功するケース
57    echo performServiceOperation(true) . PHP_EOL;  // 失敗するケース (ここで例外がスローされる)
58} catch (MyServiceException $e) {
59    // MyServiceException を捕捉し、詳細を表示
60    echo "--- カスタム例外を捕捉しました！ ---" . PHP_EOL;
61    echo "例外クラス名: " . get_class($e) . PHP_EOL;
62    echo "getMessage(): " . $e->getMessage() . PHP_EOL;
63    echo "getCode(): " . $e->getCode() . PHP_EOL;
64    
65    // publicプロパティとして定義したので、コンストラクタ引数を直接プロパティとして参照することも可能です
66    echo "プロパティ \$message: " . $e->message . PHP_EOL;
67    echo "プロパティ \$code: " . $e->code . PHP_EOL;
68
69    if ($e->getPrevious() !== null) {
70        echo "getPrevious() メッセージ: " . $e->getPrevious()->getMessage() . PHP_EOL;
71        // publicプロパティとして定義したので、\$previous から直接アクセスも可能
72        echo "プロパティ \$previous メッセージ: " . $e->previous->getMessage() . PHP_EOL;
73    }
74    echo "-----------------------------------" . PHP_EOL;
75} catch (Exception $e) {
76    // MyServiceException 以外の、その他の例外を捕捉
77    echo "その他の例外を捕捉しました: " . $e->getMessage() . PHP_EOL;
78}
79

このサンプルコードは、PHP 8で導入された「コンストラクタプロパティプロモーション」という機能を使って、独自の例外クラス MyServiceException を作成する方法を示しています。

Random\RandomException::__construct は、新しい例外インスタンスを初期化する際に呼び出されるメソッドで、例外メッセージ、エラーコード、そしてその例外が発生する原因となった前の例外（存在する場合）を引数として受け取ります。このメソッド自体は戻り値を持ちません。

通常、これらの引数をクラスのプロパティとして保存するには、コンストラクタ内でプロパティを宣言し、$this->プロパティ名 = 引数名; のように初期化する必要がありました。しかし、PHP 8以降では、MyServiceException のようにコンストラクタの引数に public などのアクセス修飾子を付けることで、その引数が自動的にクラスのプロパティとして定義され、同時に初期化されるようになりました。これがコンストラクタプロパティプロモーションと呼ばれる機能です。これにより、コードをより簡潔に記述できます。

MyServiceException クラスでは、public string $message, public int $code, public ?Throwable $previous がこの方法で定義されており、インスタンス作成時にこれらの値が自動的にプロパティとして設定されます。また、基底クラスである Exception の初期化を行うため、parent::__construct() を呼び出す必要があります。

サンプルコードの実行部分では、performServiceOperation 関数が意図的に MyServiceException をスローし、try-catch ブロックでその例外を捕捉しています。捕捉された $e からは、プロパティプロモーションによって定義された $e->message や $e->code といったプロパティに直接アクセスできることが確認できます。これにより、エラー発生時の情報取得が容易になり、柔軟なエラー処理が可能になります。