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

Copy
1<?php
2
3/**
4 * Random\Randomizer オブジェクトのシリアライズとデシリアライズの例を示します。
5 *
6 * このコードは PHP 8.2 以降で動作します。
7 * Random\Randomizer クラスは PHP 8.2 で導入されました。
8 *
9 * `unserialize()` 関数がオブジェクトを復元する際に、
10 * `Random\Randomizer::__unserialize` マジックメソッドが内部的に呼び出されます。
11 * このメソッドは、シリアライズされたデータからオブジェクトのプロパティを再構築する役割を担います。
12 */
13function demonstrateRandomizerUnserialize(): void
14{
15    // 1. 元の乱数生成器 (Randomizer) を準備します。
16    // 再現性を確保するため、特定のシード値を持つエンジンを使用します。
17    $originalEngine = new Random\Engine\Mt19937(12345);
18    $originalRandomizer = new Random\Randomizer($originalEngine);
19
20    echo "--- 元のRandomizerからの最初の乱数 ---\n";
21    echo "  整数 (1-100): " . $originalRandomizer->getInt(1, 100) . "\n";
22    echo "  浮動小数点数 (0.0-1.0): " . $originalRandomizer->getFloat(0.0, 1.0) . "\n";
23
24    // 2. Randomizer オブジェクトをシリアライズします。
25    // このプロセス中に `Random\Randomizer::__serialize` マジックメソッドが呼び出され、
26    // オブジェクトの状態が配列として準備され、文字列に変換されます。
27    $serializedData = serialize($originalRandomizer);
28
29    echo "\n--- シリアライズされたデータ ---\n";
30    echo "  " . $serializedData . "\n";
31
32    // 3. シリアライズされたデータから Randomizer オブジェクトをデシリアライズします。
33    // この `unserialize()` 関数の呼び出しによって、`Random\Randomizer::__unserialize`
34    // マジックメソッドが自動的に呼び出されます。
35    // `__unserialize` メソッドは、シリアライズデータ内の配列 ($data) を引数として受け取り、
36    // オブジェクトのプロパティをその状態に復元します。
37    $unserializedRandomizer = unserialize($serializedData);
38
39    echo "\n--- デシリアライズされたRandomizerからの次の乱数 ---\n";
40    // デシリアライズされた Randomizer は、元の Randomizer の乱数シーケンスを
41    // 正しく引き継いでいるため、次の乱数値が生成されます。
42    echo "  整数 (1-100): " . $unserializedRandomizer->getInt(1, 100) . "\n";
43    echo "  浮動小数点数 (0.0-1.0): " . $unserializedRandomizer->getFloat(0.0, 1.0) . "\n";
44
45    // 4. デシリアライズが成功し、正しい型のオブジェクトが復元されたかを確認します。
46    if ($unserializedRandomizer instanceof Random\Randomizer) {
47        echo "\nデシリアライズ成功: Random\\Randomizer のインスタンスが正しく復元されました。\n";
48    } else {
49        echo "\nデシリアライズ失敗: オブジェクトの復元に問題が発生しました。\n";
50    }
51}
52
53// 関数を実行して、Randomizer オブジェクトのシリアライズとデシリアライズの動作を確認します。
54demonstrateRandomizerUnserialize();
55
56?>

PHP 8.2以降で利用可能なRandom\Randomizerクラスは、予測可能な乱数を生成するためのオブジェクトです。このクラスに存在する__unserializeメソッドは、PHPのオブジェクトを「シリアライズ」（保存可能な形式に変換）し、その後「デシリアライズ」（元のオブジェクトに復元）する際に、内部的に自動で呼び出される特殊なメソッド（マジックメソッド）です。

具体的には、unserialize()関数を使って、以前保存したRandom\Randomizerオブジェクトのデータを復元しようとすると、この__unserializeメソッドが実行されます。引数として渡されるarray $dataには、シリアライズ時に保存されたオブジェクトの状態を表す情報が含まれており、__unserializeメソッドはこの情報をもとに、復元しようとしているRandom\Randomizerオブジェクトのプロパティを初期化し、元の状態に戻します。

このメソッドは値を何も返しません（void）。その代わり、自身が属するオブジェクトの状態を直接変更することで、乱数生成器がシリアライズ前の乱数シーケンスを正確に引き継ぎ、続きから乱数を生成できるようになります。これにより、アプリケーションが中断されても、乱数生成の状態を正確に再現・継続することが可能です。

Copy
1<?php
2
3/**
4 * このサンプルコードは、PHP 8.2以降で利用可能な `Random\Randomizer` クラスの
5 * 内部的な `__unserialize` マジックメソッドが、`unserialize()` 関数によって
6 * オブジェクトの状態を復元する際にどのように利用されるかを示します。
7 *
8 * `__unserialize` メソッドは開発者が直接呼び出すものではなく、
9 * `unserialize()` 関数がオブジェクトを再構築する際に内部的に呼び出す特殊なメソッドです。
10 *
11 * キーワード「php unserialize to json online」に関連付け、
12 * デシリアライズされたオブジェクトから得られた情報をJSONに変換する例も含みます。
13 */
14
15// PHP 8.2以降の環境が必要です。Random\Randomizer クラスはPHP 8.2で導入されました。
16
17try {
18    // 1. Random\Randomizer オブジェクトを初期化し、状態を進める
19    // 再現性を確保するため、固定シードのエンジンを使用します。
20    $seed = 12345;
21    $originalRandomizer = new Random\Randomizer(new Random\Engine\Xoshiro256StarStar($seed));
22
23    $initialNumber = $originalRandomizer->getInt(1, 100);
24    $secondNumber = $originalRandomizer->getInt(1, 100);
25    echo "元のRandomizerで最初の乱数: " . $initialNumber . PHP_EOL;
26    echo "元のRandomizerで次の乱数: " . $secondNumber . PHP_EOL;
27
28    // 2. Random\Randomizer オブジェクトをシリアライズする
29    // オブジェクトの内部状態（乱数生成の進行状況）がバイトストリームに変換されます。
30    $serializedData = serialize($originalRandomizer);
31    echo PHP_EOL . "シリアライズされたデータの長さ: " . strlen($serializedData) . " バイト" . PHP_EOL;
32
33    // 3. シリアライズされたデータをデシリアライズする
34    // `unserialize()` 関数が内部的に `Random\Randomizer::__unserialize` を呼び出し、
35    // バイトストリームからオブジェクトの状態を復元します。
36    $deserializedRandomizer = unserialize($serializedData);
37
38    echo PHP_EOL . "--- デシリアライズ後の状態確認 ---" . PHP_EOL;
39    if ($deserializedRandomizer instanceof Random\Randomizer) {
40        // デシリアライズされたオブジェクトから乱数を生成します。
41        // これは、オリジナルのRandomizerがシリアライズされた時点の状態から継続します。
42        $numberFromDeserialized = $deserializedRandomizer->getInt(1, 100);
43        echo "デシリアライズされたRandomizerでの最初の乱数: " . $numberFromDeserialized . PHP_EOL;
44
45        // 状態が正しく復元されたことを確認するため、元のRandomizerの次の値と比較
46        $nextNumberOriginal = $originalRandomizer->getInt(1, 100);
47        echo "元のRandomizerでの次の乱数 (比較用): " . $nextNumberOriginal . PHP_EOL;
48
49        if ($numberFromDeserialized === $nextNumberOriginal) {
50            echo "-> 状態が正しく復元され、乱数生成が継続されていることが確認できました。" . PHP_EOL;
51        }
52
53        // 4. デシリアライズされたオブジェクトから得られた情報をJSONに変換する
54        // `Random\Randomizer` オブジェクト自体は直接JSONに変換できないため、
55        // 生成された乱数などの関連データを配列にまとめてJSONエンコードします。
56        $outputData = [
57            'description' => 'Randomizerオブジェクトのデシリアライズと乱数生成の結果',
58            'initial_seed_used' => $seed,
59            'original_numbers_generated_before_serialization' => [$initialNumber, $secondNumber],
60            'original_next_number_after_serialization' => $nextNumberOriginal,
61            'deserialized_numbers_generated' => [
62                $numberFromDeserialized,
63                $deserializedRandomizer->getInt(1, 100) // さらに次の乱数を生成
64            ],
65            'state_restored_correctly' => ($numberFromDeserialized === $nextNumberOriginal),
66        ];
67
68        $jsonOutput = json_encode($outputData, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE);
69
70        echo PHP_EOL . "--- デシリアライズされたデータから生成されたJSON ---" . PHP_EOL;
71        echo $jsonOutput . PHP_EOL;
72
73    } else {
74        echo "エラー: オブジェクトのデシリアライズに失敗しました。" . PHP_EOL;
75    }
76
77} catch (Exception $e) {
78    echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
79}

PHPのRandom\Randomizer::__unserializeメソッドは、開発者が直接呼び出すことのない、特別な「マジックメソッド」です。このメソッドは、PHP 8以降のオブジェクトデシリアライズ機構の一部として、unserialize()関数がオブジェクトをバイトデータから元の状態に復元する際に、PHPの実行環境によって自動的に内部で呼び出されます。引数array $dataは、デシリアライズ対象のオブジェクトの状態を再構築するために必要な情報を格納した配列として、unserialize()関数から内部的に提供されます。このメソッドの戻り値はvoidであり、オブジェクトの状態を復元することに専念するため、特定の値を返しません。

サンプルコードでは、PHP 8.2で導入されたRandom\Randomizerクラスのインスタンスをシリアライズし、その後にunserialize()関数を使ってデシリアライズする過程を示しています。__unserializeメソッドが内部的に正しく機能することで、元のオブジェクトの乱数生成の進行状況が、デシリアライズされた新しいオブジェクトにも正確に引き継がれることを確認できます。これにより、乱数生成の状態が継続される様子が分かります。

さらに、「php unserialize to json online」というキーワードに関連付け、デシリアライズによって復元されたオブジェクトから得られた乱数などの情報を、データ交換に適したJSON形式に変換して出力する例も示されています。これは、PHPオブジェクトの永続化や、システム間でデータをやり取りする際の一般的な流れを表しています。