【PHP8.x】ReflectionClass::SKIP_INITIALIZATION_ON_SERIALIZE定数の使い方

Copy
1<?php
2
3/**
4 * システムエンジニアを目指す初心者のためのシリアライズとデシリアライズの概念を示すクラスです。
5 * PHP 8.1以降で導入された __serialize() および __unserialize() マジックメソッドを使用します。
6 */
7class DataObject
8{
9    private string $name;
10    private float $value;
11    private bool $initializedByConstructor;
12
13    /**
14     * オブジェクトのコンストラクタ。オブジェクトがこのメソッドで初期化されたことを記録します。
15     */
16    public function __construct(string $name, float $value)
17    {
18        echo "DEBUG: DataObject::__construct called. Name: {$name}, Value: {$value}\n";
19        $this->name = $name;
20        $this->value = $value;
21        $this->initializedByConstructor = true;
22    }
23
24    /**
25     * オブジェクトがシリアライズされる際に呼び出されます。
26     * ここで、シリアライズするプロパティを制御し、配列として返します。
27     *
28     * @return array シリアライズするプロパティとその値の連想配列。
29     */
30    public function __serialize(): array
31    {
32        echo "DEBUG: DataObject::__serialize called.\n";
33        // PHP 8.1以降では、__unserialize() が呼び出される際、コンストラクタはデフォルトで実行されません。
34        // これは、ReflectionClass::SKIP_INITIALIZATION_ON_SERIALIZE という内部的な概念と関連しています。
35        // この定数はPHPの内部実装に関連するもので、直接ユーザーコードで参照することはできませんが、
36        // __unserialize() がオブジェクトの「初期化をスキップして状態を復元する」という挙動を示します。
37        return [
38            'name' => $this->name,
39            'value' => $this->value,
40            'initializedByConstructor' => false, // シリアライズ後のオブジェクトはコンストラクタで初期化されていないと仮定
41        ];
42    }
43
44    /**
45     * オブジェクトがデシリアライズされる際に呼び出されます。
46     * __serialize() が返したデータに基づいて、オブジェクトの状態を復元します。
47     *
48     * @param array $data __serialize() が返したデータ。
49     */
50    public function __unserialize(array $data): void
51    {
52        echo "DEBUG: DataObject::__unserialize called.\n";
53        // コンストラクタが実行されないため、ここでデシリアライズされたデータを使ってプロパティを設定します。
54        $this->name = $data['name'];
55        $this->value = $data['value'];
56        $this->initializedByConstructor = $data['initializedByConstructor'];
57    }
58
59    /**
60     * オブジェクトの現在の状態を表示します。
61     */
62    public function displayState(): void
63    {
64        echo "  - Name: {$this->name}\n";
65        echo "  - Value: {$this->value}\n";
66        echo "  - Initialized by constructor: " . ($this->initializedByConstructor ? 'Yes' : 'No') . "\n";
67    }
68}
69
70/**
71 * PHPのシリアライズ機能と、php.ini設定である `serialize_precision` の影響をデモンストレーションする関数。
72 */
73function demonstrateSerialization(): void
74{
75    echo "--- シリアライズのデモンストレーション開始 ---\n";
76
77    // -----------------------------------------------------------
78    // 1. `serialize_precision` の設定と浮動小数点数のシリアライズ
79    // -----------------------------------------------------------
80    echo "\n=== 1. serialize_precision の影響 ===\n";
81    echo "   `serialize_precision` は、浮動小数点数をシリアライズする際の精度を制御する `php.ini` 設定です。\n";
82    echo "   PHP 8.1以降ではデフォルト値が17に変更され、より高い精度が保証されています。\n";
83
84    // 現在の `serialize_precision` 設定を保存し、後で元に戻す
85    $defaultPrecision = ini_get('serialize_precision');
86    echo "   現在の `serialize_precision`: {$defaultPrecision}\n";
87
88    $originalValue = 123.4567890123456789; // 高精度な浮動小数点数
89    $originalObject = new DataObject('High Precision Value', $originalValue);
90    echo "   --- 元オブジェクトの状態 (コンストラクタで初期化) ---\n";
91    $originalObject->displayState();
92
93    echo "\n   --- デフォルト精度でのシリアライズとデシリアライズ ---\n";
94    // `serialize_precision` がデフォルトのまま（通常は高精度）でシリアライズ
95    $serializedDataDefault = serialize($originalObject);
96    echo "   シリアライズされたデータ: " . $serializedDataDefault . "\n";
97    $unserializedObjectDefault = unserialize($serializedDataDefault);
98    echo "   デシリアライズされたオブジェクトの状態:\n";
99    $unserializedObjectDefault->displayState();
100
101    // `serialize_precision` を低い値に設定して影響を確認
102    // これにより、浮動小数点数の精度が制限されることを示します。
103    ini_set('serialize_precision', '8'); // 小数点以下8桁の精度に設定
104    echo "\n   --- `serialize_precision` を '8' に設定して再シリアライズ ---\n";
105    echo "   `serialize_precision` を '" . ini_get('serialize_precision') . "' に変更しました。\n";
106    $serializedDataLowPrecision = serialize($originalObject); // 同じオブジェクトを低精度でシリアライズ
107    echo "   シリアライズされたデータ: " . $serializedDataLowPrecision . "\n";
108    $unserializedObjectLowPrecision = unserialize($serializedDataLowPrecision);
109    echo "   デシリアライズされたオブジェクトの状態:\n";
110    $unserializedObjectLowPrecision->displayState();
111    echo "   （浮動小数点数の値が丸められていることに注目してください。）\n";
112
113    // `serialize_precision` を元の設定に戻す
114    ini_set('serialize_precision', $defaultPrecision);
115    echo "\n   `serialize_precision` を元の設定 ({$defaultPrecision}) に戻しました。\n";
116
117    echo "\n--- シリアライズのデモンストレーション終了 ---\n";
118}
119
120// デモンストレーション関数を実行します
121demonstrateSerialization();

PHPのシリアライズは、オブジェクトの状態を文字列などの形式で保存し、後で元のオブジェクトとして復元する機能です。PHP 8.1以降では、オブジェクトをシリアライズする際に開発者が定義する__serialize()マジックメソッドが呼び出され、デシリアライズ時には__unserialize()マジックメソッドが使用されます。

__serialize()メソッドは、シリアライズするプロパティとその値を連想配列として返す役割を持ち、引数はなく配列を返します。一方、__unserialize()メソッドは、__serialize()が返した配列データを受け取り、オブジェクトのプロパティを復元します。このメソッドは引数として配列を受け取り、戻り値はありません。

特に__unserialize()が実行される際、対象のオブジェクトは通常のコンストラクタを介さずに状態が復元されます。この、コンストラクタの実行をスキップしてオブジェクトを初期化する内部的な概念は、PHPの内部定数であるReflectionClass::SKIP_INITIALIZATION_ON_SERIALIZEと関連しています。この定数はPHPの内部実装で使われるものであり、システムエンジニアが直接ユーザーコードで参照することはありませんが、デシリアライズの仕組みを理解する上で重要です。

また、php.ini設定のserialize_precisionは、浮動小数点数をシリアライズする際の精度を制御します。PHP 8.1以降はデフォルト値が17に変更され、以前よりも高い精度で浮動小数点数を保存できるようになりました。この設定値を変更すると、シリアライズされる浮動小数点数の有効桁数が変わり、デシリアライズ後の値に影響を与える可能性があります。例えば、低い値に設定すると、小数点以下の情報が丸められてしまうことがあります。

Copy
1<?php
2
3/**
4 * オブジェクトのシリアライズ/デシリアライズの振る舞いをデモンストレーションするクラス。
5 */
6class DataObject
7{
8    public string $name;
9    public int $id;
10    public float $value;
11
12    public function __construct(string $name, int $id, float $value)
13    {
14        $this->name = $name;
15        $this->id = $id;
16        $this->value = $value;
17        echo "Debug: DataObject::__construct() が呼ばれました。\n";
18    }
19
20    // PHP 7.4以降で推奨されるデシリアライズマジックメソッド
21    // これを定義しない場合、__wakeup() かデフォルトの動作が使われます。
22    public function __unserialize(array $data): void
23    {
24        $this->name = $data['name'] ?? 'Unknown';
25        $this->id = $data['id'] ?? 0;
26        $this->value = $data['value'] ?? 0.0;
27        echo "Debug: DataObject::__unserialize() が呼ばれました。\n";
28    }
29
30    // PHP 7.4以降では、__serialize() が優先されます。
31    // 定義しない場合、publicプロパティがデフォルトでシリアライズされます。
32    // public function __serialize(): array { return get_object_vars($this); }
33}
34
35/**
36 * PHPのシリアライズ関連機能と ReflectionClass::SKIP_INITIALIZATION_ON_SERIALIZE 定数、
37 * および浮動小数点数のシリアライズ精度についてデモンストレーションします。
38 *
39 * このコードはPHP 8.1以降で動作します。
40 * ReflectionClass::SKIP_INITIALIZATION_ON_SERIALIZE 定数はPHP 8.1で導入されました。
41 * php.ini の 'serialize_precision' 設定はPHP 8.1で削除されました。
42 */
43function demonstratePhpSerialization(): void
44{
45    echo "--- ReflectionClass::SKIP_INITIALIZATION_ON_SERIALIZE 定数について (PHP 8.1+) ---\n";
46    // ReflectionClass::SKIP_INITIALIZATION_ON_SERIALIZE はPHP 8.1で導入された定数です。
47    // この定数は開発者が直接 unserialize() のオプションとして利用するものではなく、
48    // 主にPHPの内部処理や ReflectionClass::newInstanceWithoutConstructor() と組み合わせて
49    // オブジェクトの初期化をスキップする振る舞いを制御するために使用されます。
50    echo "定数 " . ReflectionClass::class . "::SKIP_INITIALIZATION_ON_SERIALIZE の値: "
51        . ReflectionClass::SKIP_INITIALIZATION_ON_SERIALIZE . "\n\n";
52
53    echo "--- unserialize() でのオブジェクト初期化スキップ (PHP 8.1+) ---\n";
54    // 指定された定数とは直接異なりますが、同じ「初期化をスキップする」概念を持つ機能として、
55    // PHP 8.1で導入された unserialize() の 'object_initialization_skipping' オプションを示します。
56
57    $originalObject = new DataObject("Sample Data", 101, 1.2345678901234567);
58    echo "元のオブジェクト: Name = {$originalObject->name}, ID = {$originalObject->id}, Value = {$originalObject->value}\n";
59    $serializedData = serialize($originalObject);
60    echo "シリアライズされたデータ: " . $serializedData . "\n\n";
61
62    echo "--- 1. 通常のデシリアライズ (DataObject::__unserialize() が呼ばれる) ---\n";
63    $deserializedObject = unserialize($serializedData);
64    echo "通常デシリアライズ後のオブジェクト: Name = {$deserializedObject->name}, ID = {$deserializedObject->id}, Value = {$deserializedObject->value}\n\n";
65
66    echo "--- 2. 初期化をスキップしてデシリアライズ (DataObject::__unserialize() は呼ばれない) ---\n";
67    // 'object_initialization_skipping' => true を渡すと、オブジェクトのプロパティはセットされますが、
68    // __construct(), __unserialize(), __wakeup() メソッドは呼ばれません。
69    $skippedObject = unserialize(
70        $serializedData,
71        ['object_initialization_skipping' => true]
72    );
73    echo "初期化スキップ後デシリアライズオブジェクト: Name = {$skippedObject->name}, ID = {$skippedObject->id}, Value = {$skippedObject->value}\n";
74    echo "注目: 上記のデシリアライズ時には 'DataObject::__construct()' や 'DataObject::__unserialize()' のDebug出力は表示されません。\n\n";
75
76    echo "--- 浮動小数点数のシリアライズ精度 (キーワード: serialize_precision) ---\n";
77    // php.ini の 'serialize_precision' 設定は、PHP 8.1で完全に削除されました。
78    // PHP 7.4から8.0までは非推奨でしたが、存在していました。
79    // 現在 (PHP 8.1以降) は、通常の浮動小数点数精度を制御する 'precision' 設定がシリアライズ時の精度に影響します。
80    echo "現在の php.ini 'precision' 設定値: " . ini_get('precision') . "\n";
81
82    $highPrecisionFloat = 1.2345678901234567; // 多くの桁を持つ浮動小数点数
83    echo "元の浮動小数点数: {$highPrecisionFloat}\n";
84    $serializedFloat = serialize($highPrecisionFloat);
85    echo "シリアライズされた浮動小数点数: {$serializedFloat}\n";
86    $deserializedFloat = unserialize($serializedFloat);
87    echo "デシリアライズされた浮動小数点数: {$deserializedFloat}\n";
88    echo "浮動小数点数のシリアライズ/デシリアライズ時には、精度設定（precision）により、\n";
89    echo "元の値と完全に一致しない場合があることに注意してください。\n";
90}
91
92// 関数を実行してデモンストレーションを開始します。
93demonstratePhpSerialization();

PHP 8.1で導入されたReflectionClass::SKIP_INITIALIZATION_ON_SERIALIZEは、オブジェクトの初期化をスキップする挙動を制御するための整数型の定数です。この定数自体を開発者がunserialize()のオプションとして直接使うことはなく、主にPHPの内部処理で利用されます。

この「初期化スキップ」の概念は、PHP 8.1以降のunserialize()関数に['object_initialization_skipping' => true]オプションを渡すことで体験できます。このオプションを指定すると、デシリアライズ時にオブジェクトのコンストラクタ（__construct())やデシリアライズ用のマジックメソッド（__unserialize()や__wakeup()）が実行されません。これにより、オブジェクトのプロパティのみが復元され、特定の初期化処理を回避することが可能です。

serialize_precisionというキーワードは、過去のPHPバージョンにおける浮動小数点数のシリアライズ精度に関する設定でした。PHP 8.1以降ではphp.iniのserialize_precision設定は削除されており、現在は一般的な浮動小数点数の表示精度を制御するprecision設定が、シリアライズ時の精度に影響を与えます。浮動小数点数は、この精度設定によりシリアライズとデシリアライズの過程で、元の値とわずかに異なる場合があることにご留意ください。