【PHP8.x】messageプロパティの使い方

Copy
1<?php
2
3/**
4 * UnhandledMatchError の発生をシミュレートし、そのメッセージプロパティを表示する関数。
5 * PHP 8 の match 式で、すべての可能なケースがカバーされていない場合に発生します。
6 *
7 * @param mixed $value match 式に渡す値
8 * @return string エラーメッセージ、または処理結果
9 */
10function demonstrateUnhandledMatchErrorMessage(mixed $value): string
11{
12    try {
13        // match 式を使用して、意図的に UnhandledMatchError を発生させる。
14        // $value が 1 でも 2 でもない場合、どのケースにもマッチせずエラーとなる。
15        $result = match ($value) {
16            1 => 'Value is one.',
17            2 => 'Value is two.',
18            // $value が 3 や他の値の場合、ここに対応するケースがないため UnhandledMatchError が発生する
19        };
20        return "処理成功: " . $result;
21    } catch (UnhandledMatchError $e) {
22        // UnhandledMatchError を捕捉し、その message プロパティにアクセスする。
23        // message プロパティには、エラーの詳細な説明が文字列として格納されている。
24        return "捕捉されたエラーメッセージ: " . $e->message;
25    } catch (Throwable $e) {
26        // UnhandledMatchError 以外の予期せぬエラーも捕捉する。
27        return "予期せぬエラーが発生しました: " . $e->getMessage();
28    }
29}
30
31// 例1: UnhandledMatchError が発生するケース
32// 値 '3' は match 式のどのケースにもマッチしない
33echo demonstrateUnhandledMatchErrorMessage(3) . "\n";
34
35// 例2: UnhandledMatchError が発生する別のケース（文字列型）
36// 値 'test' も match 式のどのケースにもマッチしない
37echo demonstrateUnhandledMatchErrorMessage('test') . "\n";
38
39// 例3: エラーが発生しないケース
40// 値 '1' は match 式のケースにマッチする
41echo demonstrateUnhandledMatchErrorMessage(1) . "\n";

このコードは、PHP 8で導入されたmatch式を使用する際に発生する可能性のあるUnhandledMatchErrorというエラーについて説明しています。UnhandledMatchErrorは、match式に与えられた値が、定義されたどのケースにも合致しない場合に発生するエラーです。

ここで注目するのは、UnhandledMatchErrorクラスが持つ「message」プロパティです。このプロパティは引数を持たず、エラーの詳細な説明を文字列として提供します。

サンプルコードのdemonstrateUnhandledMatchErrorMessage関数は、引数として$valueを受け取り、それをmatch式に渡します。$valueが1または2に合致すれば、処理結果の文字列を返します。一方、$valueがどのケースにも合致しない場合（例：3や'test'）、UnhandledMatchErrorが発生します。このエラーはtry-catchブロックで捕捉され、catchブロック内で$e->messageにアクセスすることで、そのエラーの詳細な説明文字列を取得し、表示しています。

この関数の戻り値は、処理が成功した場合はその結果の文字列、エラーが発生した場合は捕捉されたエラーメッセージの文字列です。この例を通して、match式の適切な利用方法と、予期せぬエラー発生時のメッセージ取得方法を理解できます。

Copy
1<?php
2
3/**
4 * メッセージキューから受信したメッセージをそのタイプに基づいて処理する関数。
5 * 未知のメッセージタイプが到着し、デフォルトの処理が定義されていない場合に
6 * UnhandledMatchError が発生するシナリオを示します。
7 *
8 * @param string $messageType 処理するメッセージのタイプ。
9 * @return string 処理結果のメッセージ。
10 */
11function processQueueMessage(string $messageType): string
12{
13    // 実際のメッセージキューアプリケーションでは、
14    // ここでメッセージの内容を解析し、そのタイプに応じて処理を振り分けます。
15    // PHP 8 の match 式は、このような条件分岐に最適です。
16    return match ($messageType) {
17        'user_registered' => "ユーザー登録メッセージを処理しました。",
18        'order_placed' => "注文確定メッセージを処理しました。",
19        'product_updated' => "商品更新メッセージを処理しました。",
20        // 'default' アームを意図的に省略し、
21        // 未知の $messageType に対して UnhandledMatchError を発生させます。
22    };
23}
24
25// --- メッセージ処理のシミュレーション ---
26
27echo "--- メッセージ処理開始 ---\n\n";
28
29// 正常に処理されるメッセージの例
30$handledMessageTypes = [
31    'user_registered',
32    'order_placed',
33];
34
35foreach ($handledMessageTypes as $type) {
36    try {
37        echo "受信メッセージタイプ: '{$type}'\n";
38        $result = processQueueMessage($type);
39        echo "処理結果: {$result}\n\n";
40    } catch (UnhandledMatchError $e) {
41        // このブロックは正常なメッセージでは実行されません。
42        // UnhandledMatchError は match 式がどのケースにもマッチせず、
43        // かつ default がない場合に発生します。
44        echo "エラー: 未処理のメッセージタイプ '{$type}' です。\n";
45        echo "詳細: " . $e->message . "\n\n"; // UnhandledMatchError の message プロパティにアクセス
46    }
47}
48
49// UnhandledMatchError が発生するメッセージの例
50$unhandledMessageType = 'payment_received'; // match 式にこのタイプに対応するアームがない
51
52echo "--- 未処理メッセージのシミュレーション ---\n";
53echo "受信メッセージタイプ: '{$unhandledMessageType}' (未定義)\n";
54try {
55    $result = processQueueMessage($unhandledMessageType);
56    echo "処理結果: {$result}\n\n"; // この行は実行されません
57} catch (UnhandledMatchError $e) {
58    // 未知のメッセージタイプの場合、UnhandledMatchError がここで捕捉されます。
59    echo "エラー: 未処理のメッセージタイプ '{$unhandledMessageType}' が検出されました。\n";
60    echo "詳細: " . $e->message . "\n\n"; // UnhandledMatchError の message プロパティにアクセス
61}
62
63echo "--- メッセージ処理終了 ---\n";
64

PHP 8で導入されたmatch式は、複数の条件分岐を簡潔に記述できる便利な機能です。UnhandledMatchErrorは、このmatch式を使用する際に、渡された値がどの条件にも一致せず、さらに「その他すべて」を処理するdefaultのアームも指定されていない場合に発生するエラーです。

このUnhandledMatchErrorクラスが持つmessageプロパティは、エラーに関する詳細な情報を文字列として提供します。このプロパティに引数を渡す必要はなく、常にエラーの内容を示す文字列が返されます。

サンプルコードでは、メッセージキューから受信したメッセージをそのタイプに応じて処理するシナリオをシミュレートしています。processQueueMessage関数内ではmatch式を使ってメッセージタイプを判別していますが、'payment_received'のように定義されていないメッセージタイプが渡されると、defaultアームが省略されているためUnhandledMatchErrorが発生します。

プログラムはtry-catchブロックでこのエラーを捕捉し、$e->messageを使って「未処理のメッセージタイプ 'payment_received' が検出されました」といった具体的なエラーメッセージを表示しています。これにより、どのメッセージタイプが未処理であったかを容易に把握し、適切なエラー処理やデバッグを行うことができます。messageプロパティは、エラーの原因を特定し、システムエンジニアが問題を解決する上で重要な情報源となります。