【PHP8.x】Fiber::__construct()メソッドの使い方

Copy
1<?php
2
3/**
4 * このクラスは、PHP 8 の Fiber (コルーチン) 機能と、
5 * コンストラクタプロパティプロモーションの例を示します。
6 *
7 * Fiber は、プログラムの実行を一時停止・再開できる軽量なコルーチンです。
8 * これにより、非同期的な処理をより同期的なコードに近い形で記述できます。
9 * コンストラクタプロパティプロモーションは、PHP 8で導入された機能で、
10 * コンストラクタの引数を直接クラスのプロパティとして定義・初期化する際に役立ちます。
11 */
12class FiberTaskExecutor
13{
14    /**
15     * コンストラクタプロパティプロモーションの例。
16     * `private string $initialMessage` と記述することで、
17     * `private string $initialMessage;` というプロパティの定義と、
18     * `public function __construct(string $initialMessage) { $this->initialMessage = $initialMessage; }`
19     * という初期化処理を簡潔に記述できます。
20     *
21     * @param string $initialMessage Fiberに渡す初期メッセージ。
22     */
23    public function __construct(private string $initialMessage)
24    {
25    }
26
27    /**
28     * Fiberを生成し、その実行フローを制御するメソッドです。
29     */
30    public function executeFiber(): void
31    {
32        echo "メインスレッド: Fiberの準備を開始します。\n";
33
34        // Fiber::__construct の使用例:
35        // Fiberは `callable` (呼び出し可能な関数) を引数として受け取ります。
36        // この `callable` がFiberが実行するコードブロックとなります。
37        // `use ($this)` を使うことで、クロージャ内でこのクラスのプロパティ `$initialMessage` にアクセスできます。
38        $fiber = new Fiber(function (): void {
39            // Fiberが開始されると、このブロックの実行が始まります。
40            echo "  └ Fiber: 開始。メッセージ: " . $this->initialMessage . "\n";
41
42            // Fiber::suspend() を呼び出すと、Fiberの実行が一時停止し、
43            // 引数に渡した値 (`'Suspend after first message'`) が呼び出し元 (メインスレッド) に返されます。
44            echo "  └ Fiber: 最初の処理を終え、一時停止します。\n";
45            $receivedFromMain = Fiber::suspend('Suspend after first message');
46
47            // メインスレッドから Fiber::resume() が呼ばれると、ここで実行が再開されます。
48            // resume() の引数に渡された値が、Fiber::suspend() の戻り値として `$receivedFromMain` に格納されます。
49            echo "  └ Fiber: 再開されました。メインスレッドから受け取った値: '" . $receivedFromMain . "'\n";
50
51            // もう一度一時停止します。
52            echo "  └ Fiber: 2回目の処理を終え、一時停止します。\n";
53            Fiber::suspend('Suspend after second message');
54
55            // ここに到達した場合、Fiberは完全に終了します。
56            echo "  └ Fiber: 実行を完了しました。\n";
57        });
58
59        echo "メインスレッド: Fiberを開始します。\n";
60        // Fiber::start() を呼び出してFiberの実行を開始します。
61        // Fiber内で Fiber::suspend() が呼び出されると、その引数が $firstResumeResult に格納されます。
62        $firstResumeResult = $fiber->start();
63        echo "メインスレッド: Fiberが一時停止しました。受け取った値: '" . $firstResumeResult . "'\n";
64
65        echo "メインスレッド: Fiberの実行を再開します。\n";
66        // Fiber::resume() を呼び出して、一時停止中のFiberの実行を再開します。
67        // ここで渡す `'Hello from Main!'` は、Fiber内の `Fiber::suspend()` の戻り値となります。
68        $secondResumeResult = $fiber->resume('Hello from Main!');
69        echo "メインスレッド: Fiberが再び一時停止しました。受け取った値: '" . $secondResumeResult . "'\n";
70
71        // Fiberが終了しているかを確認します。
72        // 2回目の suspend() で停止しているので、まだ終了していません。
73        if ($fiber->isTerminated()) {
74            echo "メインスレッド: Fiberは終了しました。\n";
75        } else {
76            echo "メインスレッド: Fiberはまだ終了していません。最後に再開して完了させます。\n";
77            // 最後に Fiber を完了させます。
78            // 戻り値はもうありませんが、`resume()`を呼ぶことでFiberの実行を完了させます。
79            $fiber->resume();
80            if ($fiber->isTerminated()) {
81                echo "メインスレッド: Fiberは無事に終了しました。\n";
82            }
83        }
84    }
85}
86
87// FiberTaskExecutorのインスタンスを作成します。
88// コンストラクタプロパティプロモーションにより、`'Greetings...'` が `$initialMessage` プロパティに格納されます。
89$executor = new FiberTaskExecutor('Greetings from the main application!');
90
91// Fiberの実行を開始し、そのフローを体験します。
92$executor->executeFiber();
93

PHP 8のFiber::__constructは、プログラムの実行を一時停止・再開できる軽量なコルーチンであるFiberオブジェクトを新しく生成するためのコンストラクタです。このコンストラクタはcallable $callbackという引数を一つ受け取ります。このcallableは、Fiberが実際に実行する一連の処理を定義した関数やメソッドであり、Fiberの内部ロジックを記述するために使用されます。Fiber::__constructはコンストラクタであるため、特定の戻り値はなく、呼び出されると新しいFiberオブジェクトを初期化して利用可能な状態にします。

サンプルコードでは、new Fiber(function() { ... })という形でFiberインスタンスを生成し、実行したい処理を無名関数（クロージャ）として渡しています。生成されたFiberオブジェクトは、Fiber::start()で実行を開始し、Fiber::suspend()で一時停止、Fiber::resume()で再開されることで、メインスレッドと協調しながら非同期的な処理を実現します。これにより、同期的なコードに近い形式で非同期処理を記述できるようになります。

また、このサンプルコードではPHP 8で導入された「コンストラクタプロパティプロモーション」も活用されており、コンストラクタの引数である$initialMessageをprivate string $initialMessageのように記述することで、プロパティの定義と初期化を同時に行い、コードを簡潔にしています。

Copy
1<?php
2
3// PHP 8.1以降で利用可能なFiber（ファイバー）は、協調的なマルチタスク（コルーチン）を実現する軽量な実行コンテキストです。
4// Fiber::__construct メソッドは、ファイバーが実行する処理を定義するcallable（呼び出し可能な関数やクロージャ）を引数に取ります。
5
6// Fiberのインスタンスを生成します。
7// コンストラクタには、ファイバーが実行するコードブロックをクロージャとして渡します。
8$fiber = new Fiber(function (): void {
9    echo "  >> Fiberが開始されました。\n";
10
11    // Fiber::suspend() を使うと、ファイバーの実行を一時停止し、
12    // メインコードに制御を戻すことができます。
13    // suspend() に渡した値は、start() または resume() の戻り値としてメインコードで受け取られます。
14    $dataFromMain = Fiber::suspend('Fiberから一時停止の信号を送ります。');
15
16    echo "  >> Fiberがメインから値を受け取りました: " . $dataFromMain . "\n";
17    echo "  >> Fiberが終了します。\n";
18});
19
20echo "メイン処理: Fiberの実行を開始する前です。\n";
21
22// Fiberの実行を開始します。
23// FiberがFiber::suspend() で一時停止すると、start() メソッドはその時点でFiber::suspend() に渡された値を返します。
24$initialResult = $fiber->start();
25
26echo "メイン処理: Fiberから最初の結果を受け取りました: " . $initialResult . "\n";
27
28// Fiberが一時停止状態（isSuspended() がtrue）の場合、resume() メソッドで再開できます。
29// resume() に渡した値は、Fiber内でFiber::suspend() の戻り値として受け取られます。
30if ($fiber->isSuspended()) {
31    echo "メイン処理: Fiberが一時停止しているので、再開します。\n";
32    $finalResult = $fiber->resume('メインからFiberへメッセージ！');
33    // Fiberが完全に終了すると、resume() はFiberのcallableの最終的な戻り値を返します。
34    // この例ではcallableが何も返さないため、nullが返されます。
35}
36
37echo "メイン処理: 全ての処理が完了しました。\n";
38
39?>

PHPのFiber::__constructメソッドは、PHP 8.1以降で利用可能な協調的マルチタスクを実現する「Fiber（ファイバー）」のインスタンスを生成する際に使用されます。このコンストラクタの主な役割は、新しく作成されるFiberが実行する具体的な処理内容を定義することです。

引数にはcallable $callbackを指定します。これは、関数やクロージャ（無名関数）など、呼び出し可能なコードブロックを渡すことを意味します。この$callbackこそが、Fiberが実行を開始したときに動く一連の処理ロジックそのものになります。サンプルコードでは、この引数としてfunction(): void { ... }というクロージャが渡されており、Fiberの開始メッセージ表示やFiber::suspend()による一時停止、メイン処理からの値の受け取りといった一連の処理がこのクロージャ内に記述されています。

Fiber::__constructメソッド自体は、戻り値を持ちません。new Fiber(...)のようにnew演算子を使うことで新たなFiberインスタンスが生成され、このコンストラクタはそのインスタンスの初期化と同時に、実行すべき処理内容をFiberに「組み込む」役割を担っています。これにより、非同期処理やコルーチンをより効率的に実現するための基盤が作られます。

Copy
1<?php
2
3// Fiberクラスのコンストラクタ (Fiber::__construct) の使用例
4// PHP 8.1 以降で動作します。
5
6/**
7 * ファイバー内で実行されるタスクを表すクロージャ。
8 * このクロージャがFiber::__constructの callable 引数として渡されます。
9 */
10$fiberTask = function (): void {
11    echo "--- ファイバー内部の処理を開始 ---\n";
12    
13    // 何らかの重い処理をシミュレート
14    usleep(500000); // 0.5秒待機
15    echo "ファイバーが一時停止する前\n";
16
17    // ファイバーの実行を一時停止し、メインスクリプトに制御を戻す
18    // このとき、引数として値をメインスクリプトに渡すことができます。
19    $messageFromMain = Fiber::suspend('ファイバーからメインスクリプトへメッセージ');
20    
21    echo "ファイバーが再開され、メインスクリプトから受信したメッセージ: " . $messageFromMain . "\n";
22    usleep(500000); // 0.5秒待機
23    echo "--- ファイバー内部の処理を終了 ---\n";
24};
25
26echo "メインスクリプト: Fiberインスタンスを生成する前\n";
27
28// Fiber::__construct を使用してFiberインスタンスを生成します。
29// コンストラクタには、ファイバーが実行する callable (この場合はクロージャ) を渡します。
30$fiber = new Fiber($fiberTask);
31
32echo "メインスクリプト: Fiberインスタンスを生成しました。\n";
33echo "メインスクリプト: ファイバーの実行を開始します。\n";
34
35// ファイバーの実行を開始します。
36// ファイバーが Fiber::suspend() で一時停止すると、その引数の値が返されます。
37$valueFromFiber = $fiber->start();
38
39echo "メインスクリプト: ファイバーが一時停止し、受信した値: " . $valueFromFiber . "\n";
40
41// メインスクリプトでの別の処理
42usleep(1000000); // 1秒待機
43echo "メインスクリプト: ファイバーを再開する前\n";
44
45// ファイバーの実行を再開します。
46// resume() の引数は、一時停止していたファイバー内部に渡されます。
47$fiber->resume('メインスクリプトからファイバーへメッセージ');
48
49echo "メインスクリプト: ファイバーの実行が完了したかどうかを確認します。\n";
50
51// ファイバーが終了したかを確認
52if ($fiber->isTerminated()) {
53    echo "メインスクリプト: ファイバーは正常に終了しました。\n";
54}
55
56?>

PHPのFiber::__constructは、プログラムの非同期処理を可能にするFiberクラスのインスタンスを生成するコンストラクタです。ファイバーは、その実行を途中で一時停止し、後で再開できるという特徴を持つ軽量なコルーチンの一種で、PHP 8.1以降で利用可能です。

このコンストラクタはcallable $callbackという必須の引数を一つ受け取ります。この$callbackには、ファイバー内で実行される一連の処理を記述した関数やクロージャを渡します。サンプルコードでは、$fiberTaskというクロージャがこの$callbackとして利用されており、ファイバーが実行すべきタスクを定義しています。

Fiber::__constructを呼び出すと、引数で指定された処理を持つ新しいファイバーインスタンスが初期化されます。しかし、この時点ではまだファイバー内部の処理は開始されません。実際にファイバーの実行を開始するには、生成されたFiberインスタンスのstart()メソッドを呼び出す必要があります。

コンストラクタ自体はインスタンスの初期化を行うため、特定の戻り値はありません。このFiberを活用することで、Webアプリケーションなどで時間のかかる処理をメインスレッドをブロックせずに実行し、ユーザーエクスペリエンスを向上させるといった並行処理を実現できます。

Copy
1<?php
2
3// このコードはPHP 8.1以降で動作します。
4
5/**
6 * PHPのFiberクラスの__constructメソッドの使用例。
7 * Fiberの基本的な構築（インスタンス化）と実行の流れを示します。
8 *
9 * @return void
10 */
11function runFiberConstructionExample(): void
12{
13    // Fiber内で実行される処理を定義します。
14    // このクロージャ（無名関数）が、Fiber::__constructの引数となります。
15    $fiberCallable = function (): string {
16        echo "  [Fiber] Fiber内の処理を開始します。\n";
17        // 実際のアプリケーションでは、ここで時間のかかる計算やI/O処理などが行われます。
18        sleep(1); // 処理の遅延を模倣
19        echo "  [Fiber] Fiber内の処理が完了しました。\n";
20        return "Fiberからの最終結果";
21    };
22
23    echo "[Main] Fiberインスタンスを構築します。\n";
24    // Fiberクラスのインスタンスを生成します。
25    // __constructメソッドは、このFiberが実行すべき処理（$fiberCallable）を受け取ります。
26    $fiber = new Fiber($fiberCallable);
27
28    echo "[Main] Fiberの実行を開始します。\n";
29    // Fiber::start() メソッドを呼び出すことで、$fiberCallable内のコードが実行され始めます。
30    // Fiber内の処理が完了すると、その戻り値が start() の戻り値として返されます。
31    $result = $fiber->start();
32
33    echo "[Main] Fiberが完了しました。Fiberからの戻り値: \"" . $result . "\"\n";
34
35    // Fiberが正常に終了したことを確認します。
36    if ($fiber->isTerminated()) {
37        echo "[Main] Fiberは正常に終了しています。\n";
38    }
39}
40
41// サンプルコードを実行します。
42runFiberConstructionExample();
43
44?>

PHP 8.1以降で導入されたFiberクラスの__constructメソッドは、新しいFiberインスタンスを構築するために使用されます。このメソッドは、引数としてcallable $callbackを受け取ります。この$callbackには、Fiberが開始されたときに実行されるべき処理を定義した関数（クロージャなど）を指定します。__constructメソッド自体は戻り値を返さず、Fiberインスタンスを初期化する役割を担います。

サンプルコードでは、まずFiber内で実行する処理として$fiberCallableという無名関数を定義しています。次に、new Fiber($fiberCallable)と記述することで、この処理を引数として新しいFiberインスタンスを生成しています。この時点ではまだFiber内の処理は開始されません。その後、$fiber->start()メソッドを呼び出すことで、$fiberCallable内の処理が実行され始め、処理が完了するとその結果がstart()メソッドの戻り値として返されます。最後に$fiber->isTerminated()でFiberが正常に終了したことを確認し、一連の構築から実行、終了までの流れを示しています。