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

Copy
1<?php
2
3/**
4 * SplQueueのserializeメソッドとphp.iniのserialize_precision設定が
5 * 浮動小数点数のシリアライズにどのように影響するかを示すサンプルコード。
6 *
7 * serialize_precisionは、浮動小数点数をシリアライズする際の桁数を制御します。
8 * デフォルト値（PHP 7.1以降は-1）では、可能な限り多くの有効数字が出力されますが、
9 * 明示的に値を設定することで、出力を切り詰めることができます。
10 */
11function demonstrateSplQueueSerializationPrecision(): void
12{
13    // SplQueueの新しいインスタンスを作成
14    $queue = new SplQueue();
15
16    // キューに異なる型の要素を追加。浮動小数点数は精度の影響を確認するため。
17    $queue->enqueue('Sample string');
18    $queue->enqueue(12345);
19    $queue->enqueue(0.1234567890123456789); // 高精度の浮動小数点数
20    $queue->enqueue(true);
21    $queue->enqueue(['key' => 'value', 'price' => 9.87654321]); // 配列内の浮動小数点数
22
23    // --- デフォルトの serialize_precision 設定でのシリアライズ ---
24    echo "--- デフォルトの serialize_precision 設定でのシリアライズ ---" . PHP_EOL;
25    // 現在の serialize_precision の値を取得して表示
26    $originalPrecision = ini_get('serialize_precision');
27    echo "現在の serialize_precision: " . $originalPrecision . PHP_EOL;
28
29    // SplQueue::serialize() メソッドを呼び出し、キューの内容を文字列にシリアライズ
30    $serializedDataDefault = $queue->serialize();
31    echo "シリアライズされたデータ (デフォルト精度): " . $serializedDataDefault . PHP_EOL . PHP_EOL;
32
33    // --- serialize_precision を変更してのシリアライズ ---
34    echo "--- serialize_precision を '8' に設定してのシリアライズ ---" . PHP_EOL;
35    // ini_set() を使用して serialize_precision を変更 (例: 8桁に制限)
36    // この設定はPHPスクリプト全体に影響するため、実運用では注意が必要です。
37    ini_set('serialize_precision', '8');
38    echo "serialize_precision を '8' に設定しました。" . PHP_EOL;
39    echo "現在の serialize_precision: " . ini_get('serialize_precision') . PHP_EOL;
40
41    // 再度 SplQueue::serialize() を呼び出し、変更後の設定でのシリアライズ結果を取得
42    $serializedDataChanged = $queue->serialize();
43    echo "シリアライズされたデータ (精度 '8'): " . $serializedDataChanged . PHP_EOL . PHP_EOL;
44
45    // 精度変更による影響を比較するために、デシリアライズして確認することもできます。
46    echo "--- 変更後のデータ ({$serializedDataChanged}) をデシリアライズ ---" . PHP_EOL;
47    $unserializedQueue = new SplQueue();
48    $unserializedQueue->unserialize($serializedDataChanged);
49    echo "デシリアライズされたキューの要素:" . PHP_EOL;
50    foreach ($unserializedQueue as $item) {
51        // 浮動小数点数や配列内の浮動小数点数が精度 '8' で丸められていることを確認
52        if (is_numeric($item)) {
53            echo "- " . $item . " (型: " . gettype($item) . ")" . PHP_EOL;
54        } elseif (is_array($item)) {
55            echo "- " . json_encode($item) . " (型: " . gettype($item) . ")" . PHP_EOL;
56        } else {
57            echo "- " . (string)$item . " (型: " . gettype($item) . ")" . PHP_EOL;
58        }
59    }
60
61    // スクリプト終了前に元の serialize_precision に戻す (推奨されるプラクティス)
62    ini_set('serialize_precision', $originalPrecision);
63}
64
65// 関数を実行し、サンプルコードの動作を確認
66demonstrateSplQueueSerializationPrecision();
67
68?>

SplQueue::serializeメソッドは、PHPの標準ライブラリであるSplQueueクラスに属し、キューに格納されたデータ構造全体を、PHPが内部的に利用する形式の文字列に変換します。このメソッドは引数を取らず、シリアライズされたデータを表すstring型の値を返します。これにより、キューの状態をファイルに保存したり、ネットワーク経由で送信したりすることが可能になります。

特に、浮動小数点数が含まれるデータをシリアライズする場合、PHPの設定項目であるserialize_precisionが重要な役割を果たします。この設定は、浮動小数点数を文字列に変換する際の精度（有効桁数）を制御します。サンプルコードでは、まずデフォルトのserialize_precision設定でキューをシリアライズし、次にini_set関数を使ってserialize_precisionを「8」に変更した後に再度シリアライズしています。これにより、浮動小数点数が含まれる要素が、異なる精度で文字列化される様子を確認できます。デフォルトでは最大限の精度でシリアライズされますが、serialize_precisionを変更することで、出力される浮動小数点数の桁数が制限され、結果としてシリアライズされた文字列の内容が変わることを示しています。このように、serializeメソッドは、外部の設定によってその挙動が影響を受ける場合があることを理解するのに役立ちます。

Copy
1<?php
2
3/**
4 * SplQueue の直列化 (serialize) と復元 (unserialize) のデモンストレーションを行います。
5 *
6 * システムエンジニアを目指す初心者向けに、キューにデータを追加し、
7 * そのオブジェクトの状態を文字列として保存（直列化）し、
8 * 後でその文字列からキューを復元する（非直列化）一連の流れを示します。
9 */
10function demonstrateSplQueueSerialization(): void
11{
12    // 1. SplQueue オブジェクトを作成し、データを追加します。
13    echo "--- 元の SplQueue の操作 ---" . PHP_EOL;
14    $originalQueue = new SplQueue();
15    $originalQueue->enqueue('Apple');
16    $originalQueue->enqueue('Banana');
17    $originalQueue->enqueue('Cherry');
18
19    echo "元のキューに 'Apple', 'Banana', 'Cherry' を追加しました。" . PHP_EOL;
20    echo "キューのサイズ: " . $originalQueue->count() . PHP_EOL;
21
22    // 2. SplQueue オブジェクトを直列化 (serialize) します。
23    //    SplQueue::serialize() メソッドは、オブジェクトの状態を保存可能な文字列形式に変換します。
24    $serializedQueue = $originalQueue->serialize();
25    echo PHP_EOL . "--- SplQueue の直列化 ---" . PHP_EOL;
26    echo "直列化された文字列: " . $serializedQueue . PHP_EOL;
27
28    // 3. 直列化された文字列から SplQueue オブジェクトを復元 (unserialize) します。
29    //    PHP のグローバルな unserialize() 関数は、直列化された文字列から新しいオブジェクトを生成します。
30    //    この時、SplQueue クラスの unserialize() メソッドが内部的に利用され、状態が復元されます。
31    $restoredQueue = unserialize($serializedQueue);
32
33    echo PHP_EOL . "--- 復元された SplQueue の操作 ---" . PHP_EOL;
34    echo "直列化された文字列からキューを復元しました。" . PHP_EOL;
35    echo "復元されたキューのサイズ: " . $restoredQueue->count() . PHP_EOL;
36
37    // 4. 復元されたキューからデータを取り出し、元の順序 (FIFO: First-In, First-Out) が維持されていることを確認します。
38    echo "復元されたキューから要素を取り出します (FIFO):" . PHP_EOL;
39    while (!$restoredQueue->isEmpty()) {
40        echo "  - " . $restoredQueue->dequeue() . PHP_EOL;
41    }
42
43    // 復元されたキューが空になったことを確認
44    echo "復元されたキューの最終的なサイズ: " . $restoredQueue->count() . PHP_EOL;
45}
46
47// 関数の実行
48demonstrateSplQueueSerialization();

SplQueue::serialize()メソッドは、PHPのキュー（SplQueue）オブジェクトが持つ現在の状態を、保存や転送に適した文字列形式に変換する「直列化」の機能を提供します。このメソッドは引数を必要とせず、呼び出すと、キュー内部に格納されている要素やその順序といった情報を含んだ文字列を戻り値として返します。

生成された直列化された文字列は、データベースに保存したり、ファイルに書き込んだり、ネットワーク経由で他のシステムに送信したりすることで、オブジェクトの状態を永続化・共有できます。

後でこの文字列をPHPのグローバルなunserialize()関数に渡すと、新しいSplQueueオブジェクトとして、元の状態が完全に復元されます。これにより、復元されたキューからは、直列化前と同じ順序（FIFO: First-In, First-Out）で要素を取り出すことができます。

このように、serialize()とunserialize()を組み合わせることで、プログラムの実行を跨いでオブジェクトの状態を維持し、必要に応じて再利用することが可能となり、システム開発において重要な役割を果たします。