【PHP8.x】__wakeupメソッドの使い方

Copy
1<?php
2
3namespace Dom;
4
5class HTMLDocument
6{
7    private $data;
8
9    public function __construct()
10    {
11        $this->data = "初期データ";
12    }
13
14    public function setData(string $data): void
15    {
16        $this->data = $data;
17    }
18
19    public function getData(): string
20    {
21        return $this->data;
22    }
23
24    public function __sleep(): array
25    {
26        // シリアライズするプロパティを定義
27        return ['data'];
28    }
29
30    public function __wakeup(): void
31    {
32        // デシリアライズ後に実行される処理
33        // __wakeup を空にすると bypass できる脆弱性があったが、PHP 7.0.0 以降はエラーとなる
34        // したがって、何らかの処理を記述する必要がある。ここでは初期化処理を行う。
35        $this->data = "デシリアライズ後のデータ";
36    }
37}
38
39// 使用例
40$doc = new HTMLDocument();
41$doc->setData("シリアライズ前のデータ");
42echo "シリアライズ前のデータ: " . $doc->getData() . "\n";
43
44// シリアライズ
45$serialized = serialize($doc);
46echo "シリアライズされたデータ: " . $serialized . "\n";
47
48// アンシリアライズ
49$unserialized = unserialize($serialized);
50
51// アンシリアライズ後のデータの確認
52echo "アンシリアライズ後のデータ: " . $unserialized->getData() . "\n";
53

このサンプルコードは、PHPのDom\HTMLDocumentクラスにおける__sleep()と__wakeup()というマジックメソッドの挙動を示しています。

__sleep()メソッドは、オブジェクトがserialize()関数によってシリアライズされる際に自動的に呼び出されます。このメソッドは、シリアライズするプロパティ名を配列で返す必要があります。サンプルコードでは、dataプロパティのみをシリアライズ対象として指定しています。

__wakeup()メソッドは、unserialize()関数によってオブジェクトがデシリアライズされる際に自動的に呼び出されます。このメソッドは、オブジェクトの初期化や、デシリアライズ後の状態を調整するために使用されます。重要な点として、PHP 7.0.0以降では、__wakeup()メソッドを空にするとエラーが発生します。これは、過去に__wakeup()メソッドを空にすることでオブジェクトの脆弱性を回避（bypass）できる問題があったためです。サンプルコードでは、__wakeup()メソッド内でdataプロパティを初期化しています。

コード例では、まずHTMLDocumentオブジェクトを作成し、setData()メソッドでdataプロパティに値を設定します。その後、serialize()関数でオブジェクトをシリアライズし、unserialize()関数でデシリアライズしています。__wakeup()メソッドの効果により、デシリアライズ後のオブジェクトのdataプロパティの値が初期化されていることを確認できます。

このサンプルは、オブジェクトのシリアライズとデシリアライズの過程で__sleep()と__wakeup()メソッドがどのように機能するかを理解するのに役立ちます。特に、__wakeup()メソッドがセキュリティ上の理由から必須となっている点に注意してください。

Copy
1<?php
2
3namespace Dom;
4
5class MyHTMLDocument extends \DOMDocument
6{
7    public string $data;
8
9    public function __construct()
10    {
11        parent::__construct();
12        $this->data = "初期データ";
13    }
14
15    public function __sleep(): array
16    {
17        // シリアライズするプロパティを指定
18        return array('data');
19    }
20
21    public function __wakeup(): void
22    {
23        // unserialize 時に実行される処理
24        echo "オブジェクトがunserializeされました。\n";
25        // 必要に応じて初期化処理などを行う
26        $this->data = "wakeup後のデータ";
27    }
28}
29
30// オブジェクトの作成
31$doc = new MyHTMLDocument();
32
33// オブジェクトをシリアライズ
34$serialized = serialize($doc);
35
36// オブジェクトをアンシリアライズ
37$unserialized = unserialize($serialized);
38
39// アンシリアライズされたオブジェクトのプロパティを確認
40echo "データ: " . $unserialized->data . "\n";
41
42?>

PHP 8のDom\HTMLDocumentクラスにおける__wakeupメソッドは、オブジェクトがunserialize()関数によって復元される際に自動的に実行されるマジックメソッドです。引数はなく、戻り値はvoid（何も返さない）です。

このサンプルコードでは、DOMDocumentクラスを継承したMyHTMLDocumentクラスを定義しています。MyHTMLDocumentクラスは、シリアライズ時に保存するプロパティを指定する__sleepメソッドと、アンシリアライズ時に実行される__wakeupメソッドを実装しています。

__sleepメソッドは、serialize()関数によってオブジェクトがシリアライズされる際に呼び出され、保存するプロパティの配列を返します。ここではdataプロパティのみを保存するように指定しています。

__wakeupメソッドは、unserialize()関数によってオブジェクトが復元される際に呼び出されます。サンプルコードでは、unserializeされたことを示すメッセージを表示し、dataプロパティを"wakeup後のデータ"で初期化しています。このメソッドは、データベース接続の再確立や、一時ファイルの再作成など、オブジェクトが使用可能になるために必要な初期化処理を行うのに適しています。

サンプルコードを実行すると、まずMyHTMLDocumentオブジェクトが作成され、serialize()関数でシリアライズされます。次に、unserialize()関数でシリアライズされたデータがオブジェクトに復元される際に、__wakeupメソッドが実行され、コンソールにメッセージが出力されます。最後に、アンシリアライズされたオブジェクトのdataプロパティの値が表示されます。この値は、__wakeupメソッドによって更新された"wakeup後のデータ"となります。