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

Copy
1<?php
2
3/**
4 * SplObjectStorage に格納するオブジェクトのデモ用クラス。
5 * シリアライズ可能であることを前提とするため、特に実装は不要。
6 */
7class MyObject
8{
9    public string $name;
10    public int $id;
11
12    public function __construct(string $name, int $id)
13    {
14        $this->name = $name;
15        $this->id = $id;
16    }
17
18    /**
19     * オブジェクトの識別子を返す。SplObjectStorage はこの値を内部的に使用する。
20     * 通常は必要ないが、デバッグ目的で実装することもある。
21     */
22    public function __toString(): string
23    {
24        return "MyObject(name: {$this->name}, id: {$this->id})";
25    }
26}
27
28/**
29 * SplObjectStorage::unserialize メソッドの使用例と、
30 * PHP 8 以降で発生するエラーのハンドリングをデモンストレーションする関数。
31 */
32function demonstrateSplObjectStorageUnserialize(): void
33{
34    echo "--- SplObjectStorage::unserialize のデモンストレーション ---\n\n";
35
36    // --- 1. 正常なデシリアライズの例 ---
37    echo "【成功例】正しいシリアライズデータを使ったデシリアライズ\n";
38
39    // 元の SplObjectStorage を作成し、オブジェクトを追加
40    $originalStorage = new SplObjectStorage();
41    $obj1 = new MyObject('Alice', 1);
42    $obj2 = new MyObject('Bob', 2);
43    $originalStorage->attach($obj1);
44    $originalStorage->attach($obj2, ['role' => 'admin']); // データの付加も可能
45
46    echo "元の SplObjectStorage のオブジェクト数: " . $originalStorage->count() . "\n";
47    foreach ($originalStorage as $obj) {
48        echo "  - " . $obj . " (データ: " . json_encode($originalStorage->getInfo()) . ")\n";
49    }
50
51    // SplObjectStorage インスタンスをシリアライズ
52    $serializedData = serialize($originalStorage);
53    echo "シリアライズされたデータ (一部): " . substr($serializedData, 0, 120) . "...\n";
54
55    // 新しい SplObjectStorage インスタンスを作成し、シリアライズデータから復元
56    $restoredStorage = new SplObjectStorage();
57    $restoredStorage->unserialize($serializedData);
58
59    echo "デシリアライズ後の SplObjectStorage のオブジェクト数: " . $restoredStorage->count() . "\n";
60    foreach ($restoredStorage as $obj) {
61        echo "  - " . $obj . " (データ: " . json_encode($restoredStorage->getInfo()) . ")\n";
62    }
63    echo "正常にデシリアライズされました。\n\n";
64
65    // --- 2. 不正なシリアライズデータによるエラーのハンドリング ---
66    echo "【エラー例】不正なシリアライズデータを使ったデシリアライズ\n";
67
68    // 意図的に壊れたシリアライズ文字列を作成
69    // 例えば、末尾を途中で切る、無関係な文字列を混ぜるなど
70    $malformedData = substr($serializedData, 0, strlen($serializedData) / 2) . "THIS_IS_INVALID_DATA_SUFFIX";
71    echo "不正なシリアライズデータ (一部): " . substr($malformedData, 0, 120) . "...\n";
72
73    // 不正なデータで unserialize を試みる
74    $errorStorage = new SplObjectStorage();
75    try {
76        // PHP 8 以降では、不正なシリアライズデータに対して UnexpectedValueException がスローされる
77        $errorStorage->unserialize($malformedData);
78        echo "エラーが発生するはずでしたが、デシリアライズが成功してしまいました。\n"; // この行は実行されないはず
79    } catch (UnexpectedValueException $e) {
80        echo "エラーを捕捉しました！\n";
81        echo "エラーメッセージ: " . $e->getMessage() . "\n";
82        echo "不正なシリアライズデータによるデシリアライズは失敗しました。\n";
83        // エラー発生時には、通常、オブジェクトは空の状態か、部分的にしか復元されていない。
84        echo "現在の SplObjectStorage のオブジェクト数: " . $errorStorage->count() . "\n";
85    } catch (Throwable $e) {
86        // SplObjectStorage::unserialize が UnexpectedValueException 以外の例外をスローすることは稀ですが、
87        // 念のため一般的な Throwable を捕捉することで予期せぬエラーにも対応できます。
88        echo "予期せぬ種類のエラーを捕捉しました: " . $e->getMessage() . "\n";
89    }
90    echo "エラーハンドリングにより、プログラムの異常終了を防ぎました。\n\n";
91}
92
93// 関数を実行してデモンストレーションを開始
94demonstrateSplObjectStorageUnserialize();

SplObjectStorage::unserializeは、PHPでオブジェクトのコレクションを扱うSplObjectStorageインスタンスを、serialize関数で文字列化したデータから元の状態に復元するためのメソッドです。引数string $dataには、serializeによって生成された、復元したいSplObjectStorageのシリアライズデータ文字列を指定します。このメソッドは値を直接返さず、呼び出し元のSplObjectStorageインスタンスの内部状態を更新してデータを復元します。

サンプルコードでは、まずSplObjectStorageを作成し、serializeで文字列化した有効なデータを用いてunserializeで正常に復元される様子を示しています。これにより、元のオブジェクトとその付加情報が正しく再構成されることを確認できます。

次に、意図的に壊した不正なシリアライズデータをunserializeに渡すエラー例を示しています。PHP 8以降では、このような不正なデータが与えられた場合、UnexpectedValueExceptionがスローされるようになりました。サンプルコードではtry-catchブロックを使用し、この例外を捕捉することで、プログラムの異常終了を防ぎ、エラーメッセージを表示して安全に処理を継続しています。エラー発生時、SplObjectStorageは復元されず、空の状態のままであることが一般的です。この例外ハンドリングにより、不正な入力に対する堅牢なコードを記述できます。

Copy
1<?php
2
3/**
4 * SplObjectStorage::unserialize() メソッドの使用例と、
5 * 復元されたオブジェクトの内容を JSON 形式で出力します。
6 *
7 * システムエンジニアを目指す初心者向けに、オブジェクトのシリアライズとデシリアライズ、
8 * 特に SplObjectStorage の操作を理解しやすくするためのサンプルコードです。
9 */
10function demonstrateSplObjectStorageUnserializeAndToJson(): void
11{
12    // SplObjectStorage に格納するカスタムオブジェクトのクラスを定義します。
13    class MyObject
14    {
15        public string $name;
16        public int $id;
17
18        public function __construct(string $name, int $id)
19        {
20            $this->name = $name;
21            $this->id = $id;
22        }
23
24        /**
25         * このオブジェクトのプロパティを連想配列として返します。
26         * これは、オブジェクトを JSON 形式に変換する際に利用されます。
27         *
28         * @return array<string, string|int>
29         */
30        public function toArray(): array
31        {
32            return ['name' => $this->name, 'id' => $this->id];
33        }
34    }
35
36    // 1. 元となる SplObjectStorage を作成し、カスタムオブジェクトを追加します。
37    $originalStorage = new SplObjectStorage();
38
39    $obj1 = new MyObject('ユーザーA', 101);
40    $obj2 = new MyObject('ユーザーB', 102);
41    $obj3 = new MyObject('ユーザーC', 103);
42
43    $originalStorage->attach($obj1); // オブジェクト1を追加
44    $originalStorage->attach($obj2); // オブジェクト2を追加
45    $originalStorage->attach($obj3); // オブジェクト3を追加
46
47    echo "--- 元の SplObjectStorage の内容 --- \n";
48    echo "格納オブジェクト数: " . $originalStorage->count() . "\n";
49    foreach ($originalStorage as $object) {
50        if ($object instanceof MyObject) {
51            echo "  - " . $object->name . " (ID: " . $object->id . ")\n";
52        }
53    }
54    echo "\n";
55
56    // 2. PHP の標準関数 `serialize()` を使って、
57    // SplObjectStorage インスタンス全体を文字列形式に直列化します。
58    // この文字列データが `SplObjectStorage::unserialize()` メソッドの引数となります。
59    $serializedData = serialize($originalStorage);
60
61    echo "--- シリアライズされたデータ長 --- \n";
62    echo "データ長: " . strlen($serializedData) . " バイト\n\n";
63
64    // 3. 新しい (空の) SplObjectStorage インスタンスを作成します。
65    $restoredStorage = new SplObjectStorage();
66
67    // 4. `unserialize()` メソッドを呼び出し、直列化されたデータを復元します。
68    // このメソッドは、現在の `$restoredStorage` インスタンスにデータをロードします。
69    $restoredStorage->unserialize($serializedData);
70
71    echo "--- 復元された SplObjectStorage の内容 --- \n";
72    echo "格納オブジェクト数: " . $restoredStorage->count() . "\n";
73
74    // 5. 復元された SplObjectStorage 内のオブジェクト情報を JSON 形式で出力します。
75    // キーワード「unserialize to json」に関連付け、復元された各オブジェクトを
76    // JSON エンコード可能な形式に変換し、最終的に JSON 文字列として出力します。
77    $jsonOutput = [];
78    foreach ($restoredStorage as $object) {
79        // 復元されたオブジェクトが MyObject のインスタンスであることを確認し、
80        // `toArray()` メソッドで連想配列に変換します。
81        if ($object instanceof MyObject) {
82            $jsonOutput[] = $object->toArray();
83        }
84    }
85
86    echo "--- 復元されたオブジェクトの JSON 出力 --- \n";
87    // `json_encode` で配列を JSON 文字列に変換し、
88    // 可読性を高めるために整形 (JSON_PRETTY_PRINT) して表示します。
89    echo json_encode($jsonOutput, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE) . "\n";
90}
91
92// サンプル関数を実行します。
93demonstrateSplObjectStorageUnserializeAndToJson();
94

このサンプルコードは、PHPのSplObjectStorageクラスが提供するunserialize()メソッドの基本的な使い方と、復元されたオブジェクトをJSON形式で出力する方法を解説しています。

まず、複数のカスタムオブジェクトを格納したSplObjectStorageインスタンスを作成し、その内容を表示しています。次に、このSplObjectStorageインスタンス全体をPHPの標準関数serialize()を使って文字列データに直列化します。この直列化された文字列データが、unserialize()メソッドの引数$dataとして利用されます。

その後、新しい空のSplObjectStorageインスタンスを作成し、そのunserialize()メソッドを呼び出します。引数string $dataに直列化された文字列を渡すことで、このメソッドは指定されたデータをもとに、現在のSplObjectStorageインスタンスに元のオブジェクトの状態を復元します。unserialize()メソッド自体は何も値を返しませんが、メソッドが呼び出されたインスタンスの内容が、元のSplObjectStorageと同じ状態に変更されます。

最後に、復元されたSplObjectStorageに格納されている各オブジェクトを順番に取り出し、そのプロパティから連想配列を作成しています。そして、これらの連想配列をjson_encode()関数で整形し、人間にも読みやすいJSON形式の文字列として画面に出力しています。これは、直列化されたデータを復元し、その内容をJSON形式で確認する、といった一般的な利用シナリオを示しています。