【PHP8.x】sleep()関数の使い方

Copy
1<?php
2
3// このスクリプトは、PHPのsleep関数を使用してプログラムの実行を一時停止する方法を示します。
4
5// sleep関数は、引数で指定された秒数だけプログラムの実行を停止します。
6// 引数は整数である必要があります。
7
8echo "プログラム開始: " . date('H:i:s') . PHP_EOL;
9
10// ここでプログラムの実行を1秒間停止します。
11// sleep関数は整数秒のみを受け付けます。
12// 例えば「0.5秒」のようなミリ秒単位の一時停止にはusleep関数（マイクロ秒単位）などを使用します。
13sleep(1); // 1秒間プログラムの実行を停止します。
14
15echo "1秒経過後: " . date('H:i:s') . PHP_EOL;
16
17// 別の例として、3秒間停止します。
18echo "次に3秒間停止します..." . PHP_EOL;
19sleep(3); // 3秒間プログラムの実行を停止します。
20
21echo "3秒経過後: " . date('H:i:s') . PHP_EOL;
22
23echo "プログラム終了。" . PHP_EOL;
24
25?>

このサンプルコードは、PHPのsleep関数を利用してプログラムの実行を一時的に停止する方法を説明しています。sleep関数は、引数として渡された整数秒の間、プログラムの処理を中断します。

引数$secondsには、停止させたい秒数を整数で指定します。例えば、sleep(1)と記述すると1秒間、sleep(3)と記述すると3秒間、処理が停止します。sleep関数は整数秒のみを受け付けるため、0.5秒のような小数点以下の秒数（ミリ秒）で一時停止を行いたい場合には、usleep関数などの別の関数を使用する必要があります。

sleep関数が正常に実行された場合、通常は0が戻り値として返されます。サンプルコードでは、プログラムの開始時刻とsleep関数による停止後の時刻をそれぞれ表示することで、実行が一時停止されたことを具体的に確認できます。これにより、意図的に処理の進行を遅らせたい場合などに活用できます。

Copy
1<?php
2
3/**
4 * sleep関数の基本的な動作と、Web環境で「効かない」と感じられる理由を示すサンプルコード。
5 *
6 * sleep関数は、指定された秒数だけPHPスクリプトの実行を一時停止させます。
7 * ウェブサーバーで動作するPHPスクリプト内でこれを使用すると、
8 * ユーザーのブラウザへの応答もその間停止するため、
9 * ページが読み込まれない、あるいは「固まった」ように感じられ、
10 * 結果的に「sleepが効かない」と誤解されることがあります。
11 *
12 * このコードを実行し、ブラウザでアクセスすると、
13 * 処理開始のメッセージが表示された後、指定秒数だけ何も更新されず、
14 * その後に処理再開のメッセージが表示されることを確認できます。
15 */
16function demonstrateBlockingSleep()
17{
18    $secondsToSleep = 3; // スクリプトを停止する秒数
19
20    echo "処理を開始します。<br>" . PHP_EOL;
21    echo "現在時刻: " . date('H:i:s') . "<br>" . PHP_EOL;
22
23    // バッファリングされた出力を即座にブラウザに送信します。
24    // これにより、sleepが始まる前に「処理を開始します」が表示されます。
25    // (Webサーバーの設定によっては即時反映されない場合もあります)
26    ob_flush();
27    flush();
28
29    echo "{$secondsToSleep}秒間、処理を一時停止します...<br>" . PHP_EOL;
30
31    // ここでスクリプトの実行が一時停止します
32    sleep($secondsToSleep);
33
34    echo "処理を再開しました。<br>" . PHP_EOL;
35    echo "現在時刻: " . date('H:i:s') . "<br>" . PHP_EOL;
36    echo "処理が完了しました。<br>" . PHP_EOL;
37}
38
39// 関数を実行します
40demonstrateBlockingSleep();
41
42?>

PHPのsleep関数は、実行中のPHPスクリプトを指定された秒数だけ一時停止させるために使用されます。引数$secondsには、スクリプトを停止させたい秒数を整数で指定します。この関数は、正常に実行が完了した場合には0を、エラーが発生した場合には非0の整数を戻り値として返します。

このsleep関数をWeb環境で利用する際、「sleepが効かない」と誤解されることがあります。これは、ウェブサーバー上でPHPスクリプトが一時停止している間、ユーザーのブラウザへの応答も停止してしまうためです。その結果、ウェブページが読み込まれないか、表示が固まったように見えることがあり、ユーザーはスクリプトが停止していない、あるいは処理が進んでいないと感じてしまいます。しかし実際には、スクリプトは指定された秒数だけ確実に処理を一時停止しています。

提供されたサンプルコードは、このsleep関数の基本的な動作と、Web環境で「効かない」と感じられる理由を具体的に示しています。コード中のob_flush()とflush()は、sleep関数が始まる前に「処理を開始します」というメッセージをブラウザに送信しようと試みるものですが、ウェブサーバーの設定によっては即座に表示されない場合もあります。このコードをブラウザで実行すると、最初のメッセージが表示された後、数秒間画面の更新が止まり、その後次のメッセージが表示されることで、スクリプトが一時停止していたことを確認できます。

Copy
1<?php
2
3/**
4 * プログラムの実行を一定時間一時停止するサンプルコードです。
5 * PHPのsleep()関数は秒単位で、usleep()関数はマイクロ秒単位で待機します。
6 * キーワード「ミリ秒」に関連して、usleep()でのミリ秒待機方法も示します。
7 */
8
9// sleep() 関数を使用した秒単位の待機
10// 指定した秒数だけプログラムの実行を一時停止します。
11echo "1秒間の待機を開始します...\n";
12sleep(1); // 1秒間プログラムを一時停止
13echo "1秒間の待機が終了しました。\n";
14
15echo "--------------------\n";
16
17// ミリ秒単位で待機したい場合
18// sleep() 関数は秒単位なので、ミリ秒単位の待機には usleep() 関数を使用します。
19// usleep() 関数はマイクロ秒（μs）単位で引数を取ります。
20// 1ミリ秒 = 1000マイクロ秒 です。
21
22$milliseconds = 500; // 待機したいミリ秒数を指定
23echo "{$milliseconds}ミリ秒の待機を開始します...\n";
24// ミリ秒をマイクロ秒に変換して usleep() に渡します。
25usleep($milliseconds * 1000); // 500ミリ秒 = 500 * 1000 マイクロ秒
26echo "{$milliseconds}ミリ秒の待機が終了しました。\n";
27
28echo "--------------------\n";
29
30// 別のミリ秒待機例：250ミリ秒
31$milliseconds = 250;
32echo "{$milliseconds}ミリ秒の待機を開始します...\n";
33usleep($milliseconds * 1000);
34echo "{$milliseconds}ミリ秒の待機が終了しました。\n";
35
36?>

PHPのsleep関数は、プログラムの実行を一定時間一時停止させるために使用されます。この関数は、引数にint $secondsという整数型の値を受け取ります。この引数で指定された秒数だけ、プログラムの処理が一時的に止まります。例えば、sleep(1);と記述すると、プログラムは1秒間停止します。関数の戻り値は整数型で、通常は待機が成功したことを示す0が返されますが、この戻り値が直接利用されることは多くありません。

サンプルコードでは、まずsleep(1);でプログラムを1秒間待機させる基本的な使い方を示しています。これは、連続する処理の間に短い間隔を設けたい場合などに役立ちます。

「ミリ秒」というキーワードに関して、sleep関数は秒単位での待機しかできません。ミリ秒単位でプログラムを一時停止したい場合は、usleep関数を使用します。usleep関数は、引数をマイクロ秒（1秒の100万分の1）単位で受け取ります。1ミリ秒は1000マイクロ秒に相当するため、例えば500ミリ秒待機したい場合は、usleep(500 * 1000);のように、待機したいミリ秒数を1000倍してマイクロ秒に変換して引数に渡します。サンプルコードでは、この方法で500ミリ秒や250ミリ秒の待機を実行する具体的な例も紹介しており、秒未満のより細かい時間調整が可能です。

Copy
1<?php
2
3/**
4 * PHPのsleep関数を使って、スクリプトの実行を一時停止する方法を示します。
5 *
6 * sleep()関数は、指定された秒数だけ現在のスクリプトの実行をブロック（一時停止）します。
7 * これは同期的な処理であり、スクリプトは指定された時間、完全に待機します。
8 * 「非同期」というキーワードがありますが、sleep()自体は非同期処理を実現するものではありません。
9 * 非同期処理を実現するには、通常、PromiseベースのライブラリやFibersなどのより高度な機能が必要です。
10 */
11function demonstrateBlockingSleep(): void
12{
13    echo "処理開始: " . date('H:i:s') . "\n";
14
15    $secondsToSleep = 3;
16    echo "{$secondsToSleep}秒間、スクリプトの実行を一時停止します...\n";
17
18    // sleep()関数は、指定された秒数だけスクリプトの実行を停止します。
19    // この間、他の処理は行われません。
20    sleep($secondsToSleep);
21
22    echo "処理再開: " . date('H:i:s') . "\n";
23    echo "一時停止が終了し、処理が続行されました。\n";
24}
25
26// 関数を実行して、sleep()の動作を確認します。
27demonstrateBlockingSleep();

PHPのsleep関数は、現在実行中のスクリプトを指定された秒数だけ一時停止させるために使用されます。引数int $secondsには、スクリプトを停止させたい秒数を整数で指定します。この関数は、処理が成功した場合には0を返します。

sleep関数は、指定された時間、スクリプトの実行を完全にブロックする「同期的な」処理を行います。そのため、スクリプトが一時停止している間は、他の処理を並行して実行することはできません。提供されたキーワードに「非同期」がありますが、sleep関数自体は非同期処理を実現するものではなく、非同期処理を行うにはPromiseベースのライブラリなどのより高度な機能が必要です。

サンプルコードでは、demonstrateBlockingSleep関数内で処理開始時刻を表示し、sleep関数によって3秒間スクリプトの実行を一時停止しています。その後、処理再開時刻を表示することで、スクリプトが実際に一時停止し、指定された時間が経過した後に実行が再開される様子を確認できます。これにより、sleep関数がスクリプトの実行を一時的に止める働きを理解できます。