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

Copy
1<?php
2
3/**
4 * プログラムの実行を0.5秒間一時停止するサンプルコード。
5 * PHPのusleep()関数を使用して、指定したマイクロ秒数だけ処理を停止します。
6 * これはキーワード「php sleep 0.5 秒」に最も関連性の高い例です。
7 */
8
9// 処理開始時刻を浮動小数点数（秒）で取得
10$startTime = microtime(true);
11echo "処理を開始します: " . date('H:i:s', $startTime) . "." . sprintf('%03d', (int)(($startTime - floor($startTime)) * 1000)) . "秒\n";
12
13// 500,000マイクロ秒（= 0.5秒）プログラムの実行を一時停止します。
14// usleep() 関数は引数にマイクロ秒単位の整数を取ります。
15// 1秒 = 1,000,000マイクロ秒なので、0.5秒は 500,000マイクロ秒です。
16usleep(500000);
17
18// 処理終了時刻を取得
19$endTime = microtime(true);
20echo "処理を終了しました: " . date('H:i:s', $endTime) . "." . sprintf('%03d', (int)(($endTime - floor($endTime)) * 1000)) . "秒\n";
21
22// 経過時間を計算して表示
23$elapsedTime = $endTime - $startTime;
24echo "経過時間: " . round($elapsedTime, 3) . "秒\n";
25

ご提示いただいたリファレンス情報にあるDom\CDATASection::__sleepメソッドは、PHPのオブジェクトがシリアライズされる際に呼び出される特別なマジックメソッドです。これはオブジェクトのどのプロパティを保存すべきかを示す文字列の配列を戻り値として返し、プログラムの実行を一時停止する機能とは異なり、オブジェクトの状態管理に関するものです。引数は持ちません。

一方、キーワード「php sleep 0.5 秒」とサンプルコードは、PHPプログラムの実行を一定時間一時停止する方法を示しています。ここではusleep()関数が使用されており、プログラムの処理をマイクロ秒単位で指定した時間だけ停止させる役割を担います。

サンプルコードではusleep(500000)と記述され、500,000マイクロ秒、すなわち0.5秒間プログラムの実行が一時停止します。usleep()関数は、一時停止したい時間をマイクロ秒単位の整数として引数に受け取ります。1秒は1,000,000マイクロ秒です。この関数自体には、通常、処理結果を明示的に確認するための戻り値はほとんど考慮されず、成功すれば一時停止後に処理が継続されます。

このような一時停止機能は、例えば、外部APIへの連続アクセス時に負荷を軽減するために間隔を空けたり、特定の処理に遅延を加えたりする場面で活用されます。サンプルコードは、処理の開始と終了時刻を表示することで、実際に0.5秒間の遅延が発生していることを確認できるように構成されています。

Copy
1<?php
2
3/**
4 * PHPの特殊メソッドである __sleep() の動作を示すサンプルクラスです。
5 * このメソッドは、オブジェクトが serialize() される際に、どのプロパティを保存するかを制御します。
6 *
7 * リファレンス情報にある Dom\CDATASection クラスも、PHPの内部で __sleep() に似たメカニズムを
8 * 用いて、そのインスタンスがシリアライズされる際の挙動を制御している場合があります。
9 *
10 * また、本サンプルでは、キーワードにある「ミリ秒」単位での時間待機を示す usleep() 関数も使用し、
11 * シリアライズ処理の前後に意図的な遅延を挿入しています。
12 */
13class SerializableWithSleep
14{
15    public string $publicData;
16    private int $internalId; // シリアライズする private プロパティ
17    public string $volatileData; // シリアライズから除外するプロパティ
18
19    /**
20     * コンストラクタ
21     *
22     * @param string $publicData 公開データ
23     * @param int $internalId 内部ID
24     * @param string $volatileData 一時的なデータ
25     */
26    public function __construct(string $publicData, int $internalId, string $volatileData)
27    {
28        $this->publicData = $publicData;
29        $this->internalId = $internalId;
30        $this->volatileData = $volatileData;
31    }
32
33    /**
34     * オブジェクトが serialize() される直前に呼び出されるマジックメソッドです。
35     * シリアライズするプロパティの名前を文字列の配列で返します。
36     *
37     * この例では、$volatileData はシリアライズの対象から除外されます。
38     *
39     * @return array シリアライズするプロパティ名の配列
40     */
41    public function __sleep(): array
42    {
43        echo "DEBUG: __sleep() が呼び出されました。シリアライズするプロパティを選択中...\n";
44        // publicData と internalId はシリアライズするが、volatileData は除外する
45        return ['publicData', 'internalId'];
46    }
47
48    /**
49     * オブジェクトが unserialize() された直後に呼び出されるマジックメソッドです。
50     * デシリアライズ後の初期化処理などを行います。
51     */
52    public function __wakeup(): void
53    {
54        echo "DEBUG: __wakeup() が呼び出されました。オブジェクトの初期化を実行中...\n";
55        // volatileData はシリアライズされなかったので、ここでデフォルト値を再設定する
56        $this->volatileData = "復元後のデフォルト一時データ";
57    }
58
59    /**
60     * 内部IDを取得するメソッド
61     *
62     * @return int 内部ID
63     */
64    public function getInternalId(): int
65    {
66        return $this->internalId;
67    }
68}
69
70echo "--- PHPの__sleep()マジックメソッドとusleep()関数のデモンストレーション ---\n\n";
71
72// オブジェクトの初期状態
73$originalObject = new SerializableWithSleep(
74    "重要データA",
75    12345,
76    "セッション限定の一時データ"
77);
78
79echo "元のオブジェクトの状態:\n";
80echo "  Public Data: " . $originalObject->publicData . "\n";
81echo "  Internal ID: " . $originalObject->getInternalId() . "\n";
82echo "  Volatile Data: " . $originalObject->volatileData . "\n\n";
83
84// シリアライズ処理の前に少し待機（100ミリ秒）
85echo "シリアライズ開始前に 100 ミリ秒待機 (usleep(100 * 1000))...\n";
86usleep(100 * 1000); // 100ミリ秒 = 100,000マイクロ秒
87
88// オブジェクトをシリアライズする
89$serializedData = serialize($originalObject);
90echo "オブジェクトがシリアライズされました。\n";
91echo "シリアライズされたデータ: " . $serializedData . "\n\n";
92
93// シリアライズ処理の後に少し待機（100ミリ秒）
94echo "シリアライズ完了後に 100 ミリ秒待機 (usleep(100 * 1000))...\n";
95usleep(100 * 1000); // 100ミリ秒 = 100,000マイクロ秒
96
97// シリアライズされたデータをデシリアライズしてオブジェクトを復元する
98$restoredObject = unserialize($serializedData);
99echo "オブジェクトがデシリアライズされ、復元されました。\n";
100
101echo "復元されたオブジェクトの状態:\n";
102echo "  Public Data: " . $restoredObject->publicData . "\n";
103echo "  Internal ID: " . $restoredObject->getInternalId() . "\n"; // internalIdは復元される
104echo "  Volatile Data: " . $restoredObject->volatileData . "\n\n"; // volatileDataは__wakeupで再設定される
105
106echo "注意点:\n";
107echo "- `volatileData` は `__sleep()` でシリアライズから除外されたため、復元時に元の値が失われ、`__wakeup()` で再設定された値になりました。\n";
108echo "- `usleep()` 関数は、引数で指定されたマイクロ秒数（1ミリ秒 = 1000マイクロ秒）だけプログラムの実行を一時停止します。\n\n";
109
110echo "--- 全処理完了。さらに 50 ミリ秒待機して終了 (usleep(50 * 1000))...\n";
111usleep(50 * 1000);
112echo "待機完了。\n";
113
114?>

このサンプルコードは、PHPでオブジェクトを保存（シリアライズ）する際の挙動を制御する特別なメソッド__sleep()について説明します。__sleep()は、serialize()関数でオブジェクトが文字列に変換される直前に自動で呼び出されます。このメソッドは引数を取らず、戻り値として「シリアライズするプロパティ名」を文字列の配列で返します。これにより、オブジェクトの一部のプロパティだけを保存し、不要なプロパティを除外することが可能です。サンプルでは、volatileDataプロパティが__sleep()の戻り値に含まれていないため、シリアライズの対象から除外されます。オブジェクトが復元（デシリアライズ）される際には、__wakeup()メソッドが自動で呼び出され、保存されなかったプロパティの初期化など、復元後の処理を行うことができます。コード中には、プログラムの実行を指定されたマイクロ秒数（1ミリ秒は1000マイクロ秒）だけ一時停止させるusleep()関数も使用されており、処理のタイミング調整を示す例となっています。この仕組みにより、復元されたオブジェクトのvolatileDataは元の値ではなく、__wakeup()で再設定された値になります。