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

Copy
1<?php
2
3/**
4 * HashContextオブジェクトのシリアライズとデシリアライズの例
5 *
6 * このコードは、ハッシュ計算の途中状態を保存（シリアライズ）し、
7 * それを後で復元（デシリアライズ）して計算を再開する方法を示します。
8 * unserialize() 関数が呼び出されると、PHP は内部的に
9 * HashContext::__unserialize() メソッドを実行してオブジェクトの状態を復元します。
10 */
11function demonstrateHashContextUnserialization(): void
12{
13    // 1. ハッシュ計算のコンテキスト（途中状態を保持するオブジェクト）を作成します。
14    // アルゴリズムには 'sha256' を使用します。
15    $context = hash_init('sha256');
16
17    // 2. ハッシュ化するデータの一部を追加します。
18    hash_update($context, 'This is the first part of the data, ');
19
20    // 3. HashContextオブジェクトをシリアライズ（文字列に変換）します。
21    // これにより、ハッシュ計算の途中状態を保存できます。
22    $serializedContext = serialize($context);
23    echo "シリアライズされたデータ:" . PHP_EOL;
24    echo $serializedContext . PHP_EOL . PHP_EOL;
25
26    // 4. シリアライズされた文字列からオブジェクトを復元（デシリアライズ）します。
27    // このとき、内部で HashContext::__unserialize() が自動的に呼び出されます。
28    $unserializedContext = unserialize($serializedContext);
29
30    // 5. 復元されたコンテキストを使って、残りのデータを追加し計算を再開します。
31    hash_update($unserializedContext, 'and this is the second part.');
32
33    // 6. 最終的なハッシュ値を取得します。
34    $finalHash = hash_final($unserializedContext);
35    echo "復元後に計算を再開して得られたハッシュ値:" . PHP_EOL;
36    echo $finalHash . PHP_EOL . PHP_EOL;
37
38
39    // --- 検証 ---
40    // 比較のために、シリアライズを行わずに一度に全文をハッシュ化してみます。
41    $fullData = 'This is the first part of the data, and this is the second part.';
42    $expectedHash = hash('sha256', $fullData);
43    echo "全文を一度にハッシュ化した場合の値:" . PHP_EOL;
44    echo $expectedHash . PHP_EOL . PHP_EOL;
45
46    // 7. 両者のハッシュ値が一致することを確認します。
47    if ($finalHash === $expectedHash) {
48        echo "成功: ハッシュコンテキストの状態が正しく復元され、計算が再開できました。" . PHP_EOL;
49    } else {
50        echo "失敗: ハッシュ値が一致しません。" . PHP_EOL;
51    }
52}
53
54// 関数を実行
55demonstrateHashContextUnserialization();
56

HashContext::__unserialize()は、unserialize()関数によってシリアライズ（文字列化）されたHashContextオブジェクトを元の状態に復元（デシリアライズ）する際に、PHPが内部的に自動で呼び出すための特殊なメソッドです。開発者がこのメソッドを直接呼び出すことはありません。このメソッドは、引数$dataで渡される配列（シリアライズされたオブジェクトの状態情報）をもとに、ハッシュ計算のアルゴリズムや計算途中の状態をオブジェクトに復元する役割を担います。戻り値はvoidであり、オブジェクトの状態を更新するだけで何も返しません。

サンプルコードは、この仕組みを利用してハッシュ計算を途中で中断し、後から再開する例を示しています。まずデータの一部をハッシュ化し、serialize()を使ってその計算の途中状態を文字列として保存します。その後、unserialize()で文字列からオブジェクトを復元すると、内部で__unserialize()が呼ばれて計算状態が元に戻ります。最後に、復元したオブジェクトに残りのデータを追加して計算を完了させ、最終的なハッシュ値を取得します。この結果が、全文を一度にハッシュ化した値と一致することから、オブジェクトの状態が正しく復元されたことを確認できます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * PHPのシリアライズされた文字列を、人間が読みやすいJSON形式に変換します。
7 *
8 * この関数は、データベースなどに保存されたPHPのシリアライズ形式のデータを、
9 * APIのレスポンスなどで広く使われるJSON形式に変換する際に役立ちます。
10 *
11 * @param string $serializedString シリアライズされたPHPデータ文字列。
12 * @return string|false 変換に成功した場合はJSON文字列、失敗した場合は false を返します。
13 */
14function convertPhpSerializedToJson(string $serializedString): string|false
15{
16    // unserialize() は、信頼できないデータに対して使用すると危険な場合があるため、
17    // PHP 7.0以降で推奨されるオプション `allowed_classes` を false に設定し、
18    // オブジェクトのデシリアライズを防ぎ、安全性を高めます。
19    $data = unserialize($serializedString, ['allowed_classes' => false]);
20
21    // unserialize() は失敗時に false を返します。
22    // ただし、シリアライズされた `false` (b:0;) と区別するために、元の文字列もチェックします。
23    if ($data === false && $serializedString !== 'b:0;') {
24        // データのデコードに失敗した場合
25        return false;
26    }
27
28    // PHPの配列や値をJSON文字列に変換します。
29    // JSON_PRETTY_PRINT: 出力を整形して可読性を高めます。
30    // JSON_UNESCAPED_UNICODE: 日本語などのマルチバイト文字をエスケープせずに出力します。
31    $json = json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE);
32
33    return $json;
34}
35
36// --- 以下は、関数の使用例です ---
37
38// 1. サンプルとして使用するPHPの連想配列を定義します。
39$originalArray = [
40    'id' => 101,
41    'name' => '田中 さとみ',
42    'email' => 'tanaka@example.com',
43    'is_active' => true,
44    'tags' => ['PHP', 'JSON', 'サンプル'],
45    'profile' => null
46];
47
48// 2. serialize() を使って配列をシリアライズします。（例: `a:6:{s:2:"id";i:101;...}`）
49$serializedData = serialize($originalArray);
50
51echo "--- 元のシリアライズ文字列 ---" . PHP_EOL;
52echo $serializedData . PHP_EOL . PHP_EOL;
53
54// 3. 作成した関数を呼び出し、JSONに変換します。
55$jsonResult = convertPhpSerializedToJson($serializedData);
56
57echo "--- 変換後のJSON文字列 ---" . PHP_EOL;
58if ($jsonResult !== false) {
59    echo $jsonResult . PHP_EOL;
60} else {
61    echo "JSONへの変換に失敗しました。" . PHP_EOL;
62}

このPHPサンプルコードは、PHPのserialize()関数によって特別な形式の文字列に変換されたデータを、広く使われているJSON形式の文字列に変換する実用的な関数を定義しています。データベースなどに保存されたPHP独自のシリアライズデータを、APIのレスポンスなど、他のシステムと連携しやすい形式に変換する際に役立ちます。

中心となるconvertPhpSerializedToJson関数は、引数としてシリアライズされた文字列$serializedStringを受け取ります。内部では、まずunserialize()関数を使い、文字列を元のPHPの配列や値に戻します。このとき、第二引数で['allowed_classes' => false]と指定しているのが重要な点です。これにより、意図しないオブジェクトが生成されるのを防ぎ、セキュリティを向上させています。処理に失敗した場合はfalseが返されます。

データが正常に復元されると、次にjson_encode()関数でJSON形式の文字列に変換されます。オプションを指定することで、出力されるJSONは改行やインデントで整形され、日本語などの文字も正しく表示されます。最終的に、この関数は変換に成功すればJSON文字列を、失敗すればfalseを戻り値として返します。