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

Copy
1<?php
2
3/**
4 * ini設定 'serialize_precision' がシリアライズ結果に与える影響と、
5 * HashContext オブジェクトのシリアライズを確認するサンプルコードです。
6 *
7 * HashContext オブジェクトを serialize() すると、内部的に __serialize() メソッドが呼ばれ、
8 * ハッシュ計算の途中状態が保存されます。
9 * 'serialize_precision' は、浮動小数点数を文字列に変換する際の最大有効桁数を設定します。
10 */
11function demonstrateSerializationWithPrecision(): void
12{
13    // 確認用の浮動小数点数
14    $floatValue = M_PI; // 3.141592653589793
15
16    // シリアライズ可能なハッシュコンテキストを作成
17    // このオブジェクトをシリアライズする際に HashContext::__serialize() が呼ばれます
18    $context = hash_init('sha256');
19    hash_update($context, 'some-data-to-hash');
20
21    // シリアライズ対象のデータ（HashContext と浮動小数点数を含む配列）
22    $data = [
23        'context' => $context,
24        'float'   => $floatValue,
25    ];
26
27    // 1. serialize_precision をデフォルト値 (-1) のままシリアライズ
28    // -1 は、値を正確に表現するために必要な桁数を使うことを意味します。
29    ini_set('serialize_precision', -1);
30    $serializedDefault = serialize($data);
31    echo "serialize_precision = -1 (default):" . PHP_EOL;
32    echo $serializedDefault . PHP_EOL . PHP_EOL;
33
34    // 2. serialize_precision を 5 に設定してシリアライズ
35    // 浮動小数点数が5桁の精度でシリアライズされます。
36    ini_set('serialize_precision', 5);
37    $serializedWithPrecision5 = serialize($data);
38    echo "serialize_precision = 5:" . PHP_EOL;
39    echo $serializedWithPrecision5 . PHP_EOL . PHP_EOL;
40
41    // デシリアライズして、値が変化していることを確認
42    $unserializedData = unserialize($serializedWithPrecision5);
43    echo "Unserialized float value (precision=5): " . $unserializedData['float'] . PHP_EOL;
44
45    // デシリアライズしたコンテキストでハッシュ計算を完了できることも確認
46    $restoredContext = $unserializedData['context'];
47    hash_update($restoredContext, '-and-more-data');
48    $finalHash = hash_final($restoredContext);
49    echo "Finalized hash from restored context: " . $finalHash . PHP_EOL;
50}
51
52demonstrateSerializationWithPrecision();

このPHPコードは、ハッシュ計算の途中状態を保持する HashContext オブジェクトを serialize() 関数で文字列に変換する際の動作と、PHPの設定項目 serialize_precision の影響を示すサンプルです。

HashContext オブジェクトを serialize() すると、内部で自動的に __serialize() メソッドが呼び出されます。このメソッドは、オブジェクトが持つハッシュ計算の途中状態を保存するためのデータを配列形式で返します。serialize() 関数はこの配列を受け取り、オブジェクトの状態を復元可能な文字列に変換します。これにより、時間のかかるハッシュ計算を中断し、後で再開することが可能になります。

serialize_precision は、serialize() が浮動小数点数を文字列に変換する際の有効桁数を設定します。サンプルコードでは、まずデフォルト値である -1（精度を落とさない）でシリアライズし、次に値を 5 に設定しています。その結果、浮動小数点数である円周率の値が有効桁数5桁に丸められて出力されることが確認できます。

unserialize() で文字列からデータを復元すると、HashContext オブジェクトは正しく復元され、ハッシュ計算を再開できます。このように、__serialize() はオブジェクトの状態保存に重要な役割を果たします。

Copy
1<?php
2
3// hash_init() でハッシュ計算のコンテキスト（途中状態）を保持するオブジェクトを作成します。
4// ここでは 'sha256' アルゴリズムを使用します。
5$context = hash_init('sha256');
6
7// hash_update() で計算対象のデータを追加します。
8hash_update($context, 'Hello, ');
9
10// serialize() を使って、HashContextオブジェクトを文字列に変換（シリアライズ）します。
11// この時、内部的に HashContext::__serialize() メソッドが呼ばれ、
12// オブジェクトの状態が配列として取得された後、文字列化されます。
13$serializedContext = serialize($context);
14
15echo 'シリアライズされたデータ:' . PHP_EOL;
16echo $serializedContext . PHP_EOL . PHP_EOL;
17
18// シリアライズした文字列から、unserialize() を使ってオブジェクトを復元します。
19// これにより、ハッシュ計算の途中状態を復元できます。
20$restoredContext = unserialize($serializedContext);
21
22// 復元したコンテキストに、さらにデータを追加します。
23hash_update($restoredContext, 'world!');
24
25// hash_final() で最終的なハッシュ値を取得します。
26$hashValue = hash_final($restoredContext);
27
28echo 'シリアライズ・アンシリアライズを経て計算したハッシュ値:' . PHP_EOL;
29echo $hashValue . PHP_EOL . PHP_EOL;
30
31
32// --- 参考：シリアライズせずに一括で計算した場合 ---
33$directHashValue = hash('sha256', 'Hello, world!');
34echo '一括で計算したハッシュ値:' . PHP_EOL;
35echo $directHashValue . PHP_EOL;
36
37?>

このサンプルコードは、PHPでハッシュ計算の途中状態を保存し、後から再開する方法を示しています。hash_init()関数で生成されるHashContextオブジェクトは、ハッシュ計算のコンテキスト（途中経過）を保持します。serialize()関数でこのオブジェクトを文字列に変換（シリアライズ）すると、内部でHashContext::__serialize()メソッドが自動的に呼び出されます。このメソッドは引数を取らず、オブジェクトが持つハッシュアルゴリズムや計算途中の状態といった情報を配列として返します。serialize()関数は、この配列を元にオブジェクトを復元可能な文字列を生成します。その後、unserialize()関数を使うことで、この文字列から元のHashContextオブジェクトを復元し、計算を中断した時点から再開できます。サンプルでは、一度シリアライズして復元したコンテキストにデータを追加して最終的なハッシュ値を計算しており、一括で計算した場合と同じ結果になることで、状態が正しく保存・復元されたことを確認できます。