JavaScript / コードを試す
反復可能とイテレータ — for...of で回せるものの正体
for...of とスプレッドが使えるかどうかは Symbol.iterator を持つかで決まります。自分で作る方法、ジェネレータ、1度きりしか回せないこと、無限の列を扱う形まで実行して確かめます。
固定例はNode 24.22.3の実行記録を照合しています()。下の入力欄の結果は今回の実行で確認してください。
コードを編集して試す
ブラウザー内で実行します。コードの送信・自動実行・自動保存はしません。このタブを閉じると入力は失われます。機密情報は入力しないでください。
8,192 UTF-8 byte・実行1.5秒・出力60行/8KiB以内。Ctrl / ⌘ + Enterでも実行できます。
パネルを開くと編集できます。
現在の入力は未実行です。
入力中のコードをこの例へ置き換えます。
実行画面や検索画面の間の通常クリックでは入力をこのタブのRAMで保持します。元の教材は別タブで開きます。再読み込み・タブ終了ではRAMの入力は失われます。
for...of とスプレッドが使えるかどうかは、たった1つの決まりで決まります。
for (const value of [[1], 'ab', new Set([1]), new Map([['a', 1]])]) { console.log(typeof value[Symbol.iterator]); } console.log(typeof ({})[Symbol.iterator]);
function function function function undefined
Symbol.iterator という名前の関数を持っていれば回せます。
素のオブジェクトはこれを持っていません。だから落ちます。
for (const value of { a: 1 }) {
console.log(value);
}TypeError: {(intermediate value)} is not iterable| 回せるもの | 回せないもの |
|---|---|
配列 / 文字列 / Set / Map |
素のオブジェクト |
arguments |
{ length: 3 } のような形だけ似たもの |
| ジェネレータ | 数値・真偽値 |
素のオブジェクトを回すなら、いったん配列にします。
for (const [key, value] of Object.entries({ a: 1, b: 2 })) { console.log(key, value); }
a 1 b 2
→ Object.keys() / values() / entries()
中身は「次を返す関数」だけ
Symbol.iterator を呼ぶとイテレータが返り、それに next() を聞きます。
const iterator = [10, 20][Symbol.iterator](); console.log(iterator.next()); console.log(iterator.next()); console.log(iterator.next());
{ value: 10, done: false }
{ value: 20, done: false }
{ value: undefined, done: true }done が true になるまで呼び続ける。 for...of がやっているのはこれだけです。
自分で作る
Symbol.iterator を持たせれば、素のオブジェクトでも回せます。
const range = { from: 1, to: 3, *[Symbol.iterator]() { for (let i = this.from; i <= this.to; i++) { yield i; } }, }; console.log([...range]); console.log(Array.from(range));
[ 1, 2, 3 ] [ 1, 2, 3 ]
function* と yield で書くと、next() を自分で用意しなくて済みます。
これをジェネレータと呼びます。
ジェネレータ
function* gen() { yield 1; yield 2; return 99; } const g = gen(); console.log(g.next(), g.next(), g.next(), g.next()); console.log([...gen()]);
{ value: 1, done: false } { value: 2, done: false } { value: 99, done: true } { value: undefined, done: true }
[ 1, 2 ]yieldで止まって値を返し、次に呼ばれたら続きから動くreturnした値はdone: trueと一緒に来るfor...ofとスプレッドはreturnの値を拾いません([1, 2]だけ)
return に意味のある値を入れないでください。 多くの書き方で消えます。
1度回すと空になる
ここがいちばん事故になります。
function* gen() {
yield 1;
yield 2;
}
const g = gen();
console.log([...g]);
console.log([...g]);[ 1, 2 ] []
配列は何度でも回せますが、イテレータは使い切りです。
const array = [1, 2]; console.log([...array], [...array]);
[ 1, 2 ] [ 1, 2 ]
2回使うなら、先に配列にしてください。
function* gen() { yield 1; yield 2; } const values = [...gen()]; console.log(values, values);
[ 1, 2 ] [ 1, 2 ]
終わらない列も書ける
return するまで作られないので、無限に続く列を書いても止まりません。
function* naturals() { let n = 1; while (true) { yield n++; } } function* take(iterable, count) { let i = 0; for (const value of iterable) { if (i++ >= count) return; yield value; } } console.log([...take(naturals(), 5)]);
[ 1, 2, 3, 4, 5 ]
必要になったときにだけ計算されます。これを遅延評価と呼びます。
[...naturals()] と書くと止まりません。必ず打ち切りを挟んでください。
途中で抜けたときの後始末
function* gen() { try { yield 1; yield 2; yield 3; } finally { console.log('後始末'); } } for (const n of gen()) { console.log(n); if (n === 2) break; }
1 2 後始末
break で抜けても、finally は動きます。
ファイルや接続を閉じる処理を、安心して書けます。
→ Error と try / catch / finally / throw
どこで効いてくるか
Symbol.iterator を持っていれば、言語のいろいろな場所がそのまま使えます。
function* gen() { yield 1; yield 2; } const [first, ...rest] = gen(); console.log(first, rest); console.log(Math.max(...gen())); console.log(new Set(gen())); console.log(Object.fromEntries([['a', 1]]));
1 [ 2 ]
2
Set(2) { 1, 2 }
{ a: 1 }for...of・スプレッド・分割代入・Array.from()・new Set()・new Map()。
入口が1つなので、対応する場所が一気に増えます。
まとめ
- 回せるかどうかはSymbol.iterator を持つかだけで決まる
- 素のオブジェクトは持っていない。
Object.entries()を挟む - 中身は
next()が{ value, done }を返すだけ function*とyieldで短く書ける- イテレータは使い切り。 2回使うなら先に配列にする
- 終わらない列も書ける。ただし打ち切りを忘れると止まらない
breakで抜けてもfinallyは動く