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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * このスクリプトは、MessagePack 拡張機能が必要です。
7 * (例: pecl install msgpack)
8 *
9 * MessagePack 形式のデータを安全にデシリアライズ（アンパック）する関数です。
10 * 不正なデータが渡された際に発生するエラーを捕捉し、
11 * CompileError->message と同様に、エラーオブジェクトからメッセージを取得して表示します。
12 */
13function safeMessagePackUnpack(string $packedData): void
14{
15    echo "入力データ: " . bin2hex($packedData) . PHP_EOL;
16
17    try {
18        // MessagePack 形式のバイナリデータを PHP の値にデシリアライズします。
19        // データが不正な形式の場合、PHP 8 では ValueError 例外がスローされます。
20        $unpackedData = msgpack_unpack($packedData);
21
22        echo "デシリアライズ成功:" . PHP_EOL;
23        print_r($unpackedData);
24    } catch (ValueError $e) {
25        // デシリアライズに失敗した場合、例外を捕捉します。
26        // $e->getMessage() を使って、エラーの詳細メッセージを取得・表示します。
27        // これは、リファレンスにある CompileError の message プロパティと同じ役割を果たします。
28        echo "エラー: デシリアライズに失敗しました。" . PHP_EOL;
29        echo "メッセージ: " . $e->getMessage() . PHP_EOL;
30    } finally {
31        // 処理の区切りとして横線を表示します。
32        echo '-------------------------' . PHP_EOL;
33    }
34}
35
36// 1. 正常なデータの処理例
37// PHP の連想配列データ
38$validData = [
39    'id' => 1001,
40    'user' => 'Taro',
41    'permissions' => ['read', 'write']
42];
43// データを MessagePack 形式にシリアライズ（パック）します。
44$packedValidData = msgpack_pack($validData);
45safeMessagePackUnpack($packedValidData);
46
47
48// 2. 不正なデータの処理例
49// MessagePack 形式ではない、意図的に壊したバイナリデータ
50$packedInvalidData = "\x81\xA3"; // 不完全なマップデータ
51safeMessagePackUnpack($packedInvalidData);
52

このPHPコードは、MessagePack形式のデータを安全にPHPの値へ変換する処理と、その際に発生しうるエラーへの対処方法を示しています。

safeMessagePackUnpack関数は、引数として受け取ったMessagePack形式のバイナリデータ文字列を、msgpack_unpack関数で変換します。この変換処理はデータが不正な場合に失敗する可能性があるため、tryブロック内で実行されます。

データが不正でmsgpack_unpack関数が失敗すると、PHP 8ではValueErrorという例外が発生します。この例外はcatchブロックで捕捉され、その例外オブジェクトが持つgetMessage()メソッドが呼び出されます。このメソッドは引数を取らず、エラーの原因を説明する具体的なメッセージを文字列として返します。

このgetMessage()メソッドの役割は、リファレンス情報にあるCompileErrorクラスのmessageプロパティが、コンパイルエラーに関する詳細なメッセージを文字列として保持しているのと同様です。サンプルコードでは、正常なデータが正しく変換される一方、不正なデータではエラーメッセージが表示され、プログラムが安全に処理を継続できることを示しています。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * メッセージキューのワーカーを模倣するクラス
7 *
8 * タスクをキューから取り出して処理します。
9 * 処理中にエラーが発生した場合、そのエラーのメッセージを取得し、
10 * 別のエラーキューに記録するロジックを示します。
11 */
12class MessageQueueWorker
13{
14    /** @var array<array{type: string, data: mixed}> タスクを保持するキュー */
15    private array $taskQueue = [];
16
17    /** @var array<array{error_message: string, original_task: array}> エラー情報を保持するキュー */
18    private array $errorQueue = [];
19
20    /**
21     * キューに新しいタスクを追加します。
22     *
23     * @param string $type タスクの種類
24     * @param mixed $data タスクのデータ
25     */
26    public function addTask(string $type, mixed $data): void
27    {
28        $this->taskQueue[] = ['type' => $type, 'data' => $data];
29        echo "タスクを追加しました: Type='{$type}'" . PHP_EOL;
30    }
31
32    /**
33     * キューに溜まったタスクの処理を開始します。
34     */
35    public function run(): void
36    {
37        echo "--- ワーカー処理開始 ---" . PHP_EOL;
38
39        // キューが空になるまでタスクを順番に処理する
40        while ($task = array_shift($this->taskQueue)) {
41            try {
42                echo "タスク処理中: Type='{$task['type']}'" . PHP_EOL;
43                // タスクの種類に応じて処理を分岐
44                match ($task['type']) {
45                    'send_email' => $this->processSendEmail($task['data']),
46                    'calculate'  => $this->processCalculate($task['data']),
47                    default      => throw new \InvalidArgumentException("未定義のタスクタイプです。"),
48                };
49                echo "タスク成功: Type='{$task['type']}'" . PHP_EOL;
50            } catch (\Throwable $e) {
51                // CompileError, Error, Exception など、あらゆる種類の例外をキャッチ
52                echo "タスク失敗: Type='{$task['type']}'" . PHP_EOL;
53
54                // ThrowableインターフェースのgetMessage()メソッドでエラーメッセージを取得し、
55                // エラーキューにタスク情報と共に保存します。
56                $this->errorQueue[] = [
57                    'error_message' => $e->getMessage(),
58                    'original_task' => $task,
59                ];
60            }
61        }
62
63        echo "--- ワーカー処理終了 ---" . PHP_EOL;
64    }
65
66    /**
67     * 失敗したタスクが記録されたエラーキューの内容を表示します。
68     */
69    public function printFailedTasks(): void
70    {
71        echo PHP_EOL . "--- エラーキューの内容 ---" . PHP_EOL;
72        if (empty($this->errorQueue)) {
73            echo "失敗したタスクはありませんでした。" . PHP_EOL;
74            return;
75        }
76        print_r($this->errorQueue);
77    }
78
79    /**
80     * メール送信タスクの処理を模倣します（成功例）。
81     */
82    private function processSendEmail(string $email): void
83    {
84        // 実際のメール送信処理
85        usleep(100000); // 0.1秒待機
86    }
87
88    /**
89     * 計算タスクの処理を模倣します（失敗例）。
90     *
91     * @param array{numerator: int, denominator: int} $data
92     */
93    private function processCalculate(array $data): void
94    {
95        // 0による除算エラー（DivisionByZeroError）を意図的に発生させます
96        $result = $data['numerator'] / $data['denominator'];
97    }
98}
99
100// --- 以下、実行コード ---
101
102// ワーカーのインスタンスを作成
103$worker = new MessageQueueWorker();
104
105// 3つのタスクをキューに追加
106$worker->addTask('send_email', 'user1@example.com');
107// 意図的にエラーを発生させるタスク (0での除算)
108$worker->addTask('calculate', ['numerator' => 100, 'denominator' => 0]);
109// 未定義のタスクタイプでエラーを発生させる
110$worker->addTask('generate_report', []);
111
112// ワーカーを実行してキューを処理
113$worker->run();
114
115// エラーキューの内容を確認
116$worker->printFailedTasks();

このPHPサンプルコードは、「メッセージキュー」という、タスクを一時的に保管して後から順番に処理する仕組みを模倣したものです。MessageQueueWorkerクラスが、追加されたタスクを一つずつ実行します。

このコードの重要な点は、runメソッド内にあるtry...catchブロックを利用したエラー処理です。タスク処理中に予期せぬ問題が発生しても、catch (\Throwable $e)によってプログラムの実行は停止せず、エラーを安全に捕捉できます。CompileErrorを含むあらゆる種類のエラーや例外が、$eという変数に格納されます。

ここで中心となるのが$e->getMessage()メソッドです。このメソッドは引数を必要とせず、発生したエラーの原因を説明する具体的なメッセージを文字列（string）として返します。サンプルコードでは、このメソッドで取得したエラーメッセージを、失敗したタスクの情報と共にerrorQueue配列へ記録しています。これにより、例えば「0による除算」や「未定義のタスク」といったエラーが発生した際に、どのタスクがどのような理由で失敗したのかを後から正確に追跡することが可能になります。