PHP

PHP のコルーチンを使ってみる

More than 3 years have passed since last update.

PHP 5.5 でコルーチンが実装されましたが、全く使っていなかったので使ってみました。


コルーチンとは

コルーチンとは何なのかというと・・・Wikipedia によると次の通りです。

コルーチン - Wikipedia


コルーチンはいったん処理を中断した後、続きから処理を再開できる。

接頭辞 co は協調を意味するが、複数のコルーチンが中断・継続により協調動作を行うことによる。


これだけではよくわからないので動くコードを書いて理解します。


サンプル

main() 関数と co() 関数が定義されています。co() がコルーチンです。

<?php

function co()
{
echo "co 1st yield\n";
yield;

echo "co 2nd yield\n";
yield;

echo "co end\n";
}

function main()
{
echo "main init\n";
$co = co();

echo get_class($co) . "\n";
$co->rewind();

echo "main 1st send\n";
$co->send(null);

echo "main 2nd send\n";
$co->send(null);

echo "main end\n";
}

main();

これを実行すると次のように出力されます。

main init

Generator
co 1st yield
main 1st send
co 2nd yield
main 2nd send
co end
main end

出力内容からコードの実行順を考えます。

まず、main()co() を呼び出していますが、この時点では co() の中身は実行されていません。


main()

echo "main init\n";

$co = co();

co() は値を返していませんが、関数内部に yield があるので Generator のインスタンスが返ります(コルーチンとジェネレータは同じものです)。


main()

echo get_class($co) . "\n"; // -> Generator


次に $co->rewind() を実行します。


main()

$co->rewind();


すると co() の最初の yield までが実行されます。


co()

echo "co 1st yield\n";

yield;

そこで一旦 co() の処理は中断され、main() の続きに戻ります。


main()

echo "main 1st send\n";

$co->send(null);

そして $co->send(null) が呼ばれたところで、先ほど中断した co() の続きに戻ります。

.

.

コルーチンの処理が途中で中断して呼び出し元に返り、そして中断したところから再開することで main()co() が交互に実行されています。このような動作がコルーチンの特徴です。


  1. 関数の処理を中断して呼び出し元に処理を戻す


    • コルーチンで yield を呼びます



  2. 中断した場所から関数の処理を再開する


    • 呼び出し元で $co->send() を呼びます




コルーチンの rewind()

上のサンプルではコルーチンの最初の呼び出し後に $co->rewind() をしています。

もし $co->rewind() を呼ばないとどうなるか・・・サンプルの当該箇所をコメントアウトしてみます。

<?php

function co()
{
echo "co 1st yield\n";
yield;

echo "co 2nd yield\n";
yield;

echo "co end\n";
}

function main()
{
echo "main init\n";
$co = co();

echo get_class($co) . "\n";
//$co->rewind();

echo "main 1st send\n";
$co->send(null);

echo "main 2nd send\n";
$co->send(null);

echo "main end\n";
}

main();

少し出力内容が変わりました。

main init

Generator
main 1st send
co 1st yield
co 2nd yield
main 2nd send
co end
main end

最初の $co->send(null) の呼び出しでコルーチンの先頭から2番目の yield までが実行されています。

最初に $co->rewind() を呼んでおけば、その時点で先頭から1番目の yield までが実行され、次の $co->send(null) では1番目の yield から2番目の yield までが実行されます。

なお、$co->rewind() ではなく $co->current()$co->key() でも同じ効果が得られます。


コルーチンと値の受け渡し

コルーチンと呼び出し元は双方向に値を受け渡しすることができます。

コルーチンから呼び出し元に値を渡すときは、yield に引数を付けて $co->send() の戻り値や $co->current() で受け取ります。

呼び出し元からコルーチンに値を渡すときは、$co->send() の引数で指定して yield の戻り値で受け取ります。

<?php

function co()
{
$val = (yield "co 1st");
echo "co: $val\n";

$val = (yield "co 2nd");
echo "co: $val\n";
}

function main()
{
$co = co();

$val = $co->current();
echo "main: $val\n";

$co->send("main 1st");

$val = $co->current();
echo "main: $val\n";

$co->send("main 2st");
}

main();

次のように出力されます。

main: co 1st

co: main 1st
main: co 2nd
co: main 2st

yield の引数で指定した "co 1st" のような文字列を main() 関数の $co->current() で取り出しており、$co->send() の引数で指定した "main 1st" のような文字列を yield の戻り値で取り出しています。

最初の説明の通り、コルーチンから呼び出し元への値の受け渡しは $co->send() の戻り値でも出来ますが・・・

<?php

function co()
{
$val = (yield "co 1st");
echo "co: $val\n";

$val = (yield "co 2nd");
echo "co: $val\n";
}

function main()
{
$co = co();

$val = $co->send("main 1st");
echo "main: $val\n";

$val = $co->send("main 2st");
echo "main: $val\n";
}

main();

これを実行すると次のように表示されます。

co: main 1st

main: co 2nd
co: main 2st
main:

前述の コルーチンの rewind() で説明した通り、最初にいきなり $co->send() を呼ぶと2番目の yield までが実行されます、そのため $co->send() の戻り値は2番目の yield の引数になります。よって上の例だと1番目の yield の引数が受け取れていません。

なので、コルーチンから呼び出し元へ値を渡すときは $co->current() の方が良いだろうと思います。

なお、ジェネレータを使ったことがあれば知っているかもしれませんが、yield の引数には次のようにキーと値を指定することができます。

<?php

function co()
{
yield "Key" => "Value";
}

function main()
{
$co = co();
$key = $co->key();
$val = $co->current();
echo "$key => $val\n";
}

main();

しかし、次のように配列で2値を渡してもたいして変わらないので、コルーチンとして使う分にはキーを使う必要は無いと思います。

<?php

function co()
{
yield ["Key", "Value"];
}

function main()
{
$co = co();
list ($key, $val) = $co->current();
echo "$key => $val\n";
}

main();


コルーチンに例外を渡す

$co->throw() の引数で例外オブジェクトを指定すると、コルーチンの yield から例外と飛ばすことができます。

<?php

function co()
{
echo "co: first\n";
try {
yield;
echo "!!!\n";
} catch (RuntimeException $ex) {
echo "co: {$ex->getMessage()}\n";
throw $ex;
}
}

function main()
{
$co = co();
$co->rewind();
try {
echo "main: throw\n";
$co->throw(new RuntimeException("Error!"));
echo "!!!\n";
} catch (RuntimeException $ex) {
echo "main: {$ex->getMessage()}\n";
}
}

main();

これを実行すると次のように出力されます。

co: first

main: throw
co: Error!
main: Error!

異常を表す値を $co->send() で渡して条件分岐してもたいして変わらないかもしれませんが、例外ベースの方がコードは書きやすい(こともある)でしょう。


試しにコルーチンを使った簡単な TCP チャットを書いてみました。

cap.gif

チャットの実装部分のコードは下記のリンク先です。

yield でクライアントからの入力を受信して、$send() でクライアントへ送信します。とても手続き的なコードですが、シングルスレッドの非同期 I/O で複数の接続をさばいています。

普通、非同期 I/O で複数の接続をさばこうとするとめんどくさいことになりがちですが、コルーチンを使えばこのように簡単に書くことができます。

もちろん server.php の側でそれなりの実装は必要です。server.php は次の通りです。

見る人が見ればすぐわかるやっつけなコードですが(エラー時の例外処理がないしストリームをデータグラムのように扱っている)、それなりに動作します。

なお、同じようにやっつけで作ったコルーチンを使わない単純なエコーサーバはこちら。

server.php とほとんど同じです。接続を受け入れた時にジェネレータを返すコールバックを呼んでいるのと、クライアントからデータを受信したときや切断されたときにジェネレータの send() を呼んでいるぐらいしか違いはありません。