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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * __wakeup マジックメソッドの動作を示すサンプルクラスです。
7 *
8 * unserialize() 関数がオブジェクトを復元する際に、__wakeup() メソッドが
9 * 自動的に呼び出されます。これは、データベース接続の再確立など、
10 * オブジェクト復元時に必要な初期化処理を行うために利用されます。
11 *
12 * PHPの組み込みクラスである Dom\DocumentFragment も、アンシリアライズされる際には
13 * 同様の __wakeup メソッドが内部的に呼び出され、オブジェクトの状態を復元します。
14 */
15class Connection
16{
17    private string $dsn;
18    private ?string $resource; // データベース接続リソースなどを模したプロパティ
19
20    public function __construct(string $dsn)
21    {
22        $this->dsn = $dsn;
23        $this->connect();
24    }
25
26    /**
27     * serialize() 実行時に呼び出されます。
28     * 接続リソースはシリアライズできないため、接続を切断し、
29     * 保存したいプロパティ名のみを配列で返します。
30     */
31    public function __sleep(): array
32    {
33        echo "-> __sleep() が呼び出され、接続リソースが解放されました。\n";
34        $this->resource = null;
35        return ['dsn']; // 'dsn' プロパティのみをシリアライズ対象とする
36    }
37
38    /**
39     * unserialize() 実行時に呼び出されます。
40     * ここで、復元されたプロパティを元に再度接続処理を行います。
41     */
42    public function __wakeup(): void
43    {
44        echo "-> __wakeup() が呼び出され、再接続を試みます。\n";
45        $this->connect();
46    }
47
48    // 接続処理を模したメソッド
49    private function connect(): void
50    {
51        $this->resource = 'Connected to ' . $this->dsn;
52        echo "-> 接続が確立されました。({$this->resource})\n";
53    }
54
55    // 接続状態を取得するメソッド
56    public function getStatus(): string
57    {
58        return $this->resource ?? 'Not Connected';
59    }
60}
61
62// 1. オブジェクトを生成します。
63echo "1. オブジェクトを生成します。\n";
64$connection = new Connection('mysql:host=localhost;dbname=testdb');
65echo "   現在の状態: " . $connection->getStatus() . "\n\n";
66
67// 2. オブジェクトをシリアライズ（文字列に変換）します。
68// この処理の中で __sleep() が呼ばれます。
69echo "2. オブジェクトをシリアライズします。\n";
70$serializedData = serialize($connection);
71echo "   シリアライズされたデータ: " . $serializedData . "\n\n";
72
73// 3. シリアライズされた文字列からオブジェクトを復元します。
74// この処理の中で __wakeup() が呼ばれます。
75echo "3. オブジェクトをアンシリアライズします。\n";
76$restoredConnection = unserialize($serializedData);
77
78// 4. 復元されたオブジェクトの状態を確認します。
79echo "\n4. 復元されたオブジェクトの状態を確認します。\n";
80echo "   現在の状態: " . $restoredConnection->getStatus() . "\n";
81
82?>

PHPの__wakeupメソッドは、オブジェクトが文字列化された状態（シリアライズ）から元のオブジェクトへと復元される（アンシリアライズ）際に、自動的に呼び出される特別なマジックメソッドです。このメソッドは、unserialize()関数が実行され、オブジェクトのプロパティが復元された直後に動作します。主な役割は、オブジェクトの復元後に必要となる初期化処理を行うことで、例えばデータベース接続のような、シリアライズ中に維持できないリソースを再確立するために利用されます。

Dom\DocumentFragmentのようなPHPの組み込みクラスも、内部的には同様の__wakeupメカニズムを利用し、アンシリアライズ時に自身の状態を適切に初期化して、利用可能な状態に復元しています。このメソッドは引数を取らず、また、戻り値もvoid（何も返さない）です。

サンプルコードでは、Connectionクラスを通じてその動作を示しています。オブジェクトをシリアライズする際に__sleepメソッドで接続リソースを解放し、アンシリアライズによってオブジェクトが復元される直前には__wakeupメソッドが呼び出され、再度接続を確立しています。これにより、一度シリアライズされたオブジェクトも、アンシリアライズ後に正しく機能する状態に戻すことが可能です。このように__wakeupは、オブジェクトの持続性を管理する上で重要な役割を果たします。