ES6 では新しく Generator 関数が導入されました。yield キーワードを使って関数の実行フローを一時停止でき、実行フローを変更する可能性を提供し、それによって非同期プログラミングに解決策を提供します。基本的な使い方
Generator 関数の構成
Generator には通常の関数と区別される2つの部分があります:
-
1つ目は、function の後、関数名の前に * があることです;
-
関数内部に yield 式があること。
ここで * は関数が Generator 関数であることを示し、yield は関数内部の状態を定義するために使われます。
実行メカニズム
Generator 関数の呼び出しは通常の関数と同じように、関数名の後に()を付けるだけです。しかし、Generator 関数は通常の関数のようにすぐには実行されず、内部状態オブジェクトを指すポインタを返します。そのため、イテレータオブジェクト Iterator の next メソッドを呼び出すと、ポインタは関数の先頭または前回停止した場所から実行を開始します。
next メソッドを初めて呼び出すと、Generator 関数の先頭から実行を開始し、最初に one を出力し、yield のところまで実行すると停止します。そして yield の後ろの式の値 '1' を、返されるオブジェクトの value プロパティの値とします。このとき関数はまだ実行し終えていないので、返されるオブジェクトの done プロパティの値は false です。
next メソッドを2回目に呼び出すときは、前のステップと同じです。
next メソッドを3回目に呼び出すときは、最初に three を出力し、次に関数の return 操作を実行し、return の後ろの式の値を、返されるオブジェクトの value プロパティの値とします。このとき関数はすでに終了しているので、done プロパティの値は true です。
next メソッドを4回目に呼び出すときは、関数はすでに実行し終えているので、返される value プロパティの値は undefined、done プロパティの値は true です。3番目のステップを実行するときに return 文がない場合は、直接 {value: undefined, done: true} を返します。
関数が返すイテレータオブジェクトのメソッド
next メソッド
通常、next メソッドに引数を渡さない場合、yield 式の戻り値は undefined です。next に引数を渡す場合、その引数は前のステップの yield の戻り値となります。
next に引数を渡さない
next を使う以外にも、for...of ループを使って Generator 関数が生成する Iterator オブジェクトを反復処理できます。
return メソッド
return メソッドは指定された値を返し、Generator 関数の反復を終了します。
return メソッドが引数を提供する場合はその引数を返し、引数を提供しない場合は undefined を返します。
イテレータオブジェクトは2つのエラーをスローしました。1つ目は Generator 関数内部でキャッチされ、2つ目は関数本体の内部の catch 関数がすでに実行されているため、このエラーは再度キャッチされず、そのためこのエラーは Generator 関数本体の外にスローされ、関数本体の外の catch によってキャッチされます。
yield* 式
yield* 式は、yield がイテレータオブジェクトを返すことを表し、Generator 関数の内部で別の Generator 関数を呼び出すために使用されます。
使用シーン
Iterator の実装
Iterator インターフェースを持たないオブジェクトに反復処理のメソッドを提供します。
Reflect.ownKeys() は、列挙可能かどうかに関係なく、Symbol を含むオブジェクトのすべてのプロパティを返します。
jane はネイティブでは Iterator インターフェースを持っておらず、for...of で反復処理できません。ここでは Generator 関数を使って Iterator インターフェースを追加したので、jane オブジェクトを反復処理できます。