Итераторы, генераторы и символы

Узнай, на чём держатся `for...of` и spread: протокол итерации, `Symbol.iterator`, функции-генераторы с `yield`, ленивые последовательности и символы как уникальные ключи.

  • Продвинутый
  • 20 мин
  • 10 вопросов
  • Урок 24 из 39

В этом уроке ты узнаешь

  • Объяснять протокол итерации (Symbol.iterator, next(), { value, done }) и делать свой объект итерируемым
  • Писать функции-генераторы с yield для ленивых и бесконечных последовательностей
  • Использовать символы как уникальные, не конфликтующие ключи и знать известные символы

for...of работает с массивами, строками, Map и Set, но не с обычным объектом {} — получаешь TypeError: ... is not iterable. Что есть у массивов и строк, чего нет у объектов? Особый метод под ключом Symbol.iterator. Зная этот протокол, можно научить любой объект работать с for...of, spread и деструктуризацией, а генераторы делают это почти без усилий.

Символы

Symbol — примитивный тип, появившийся в ES2015 (всего в JavaScript семь примитивных типов). Каждый вызов Symbol() создаёт уникальное значение, даже если описание совпадает. Символы используют как ключи свойств, которые никогда не конфликтуют с другими ключами: если библиотека добавит в твой объект свой символьный ключ, она не заденет твои свойства id или name. Символьные ключи не видны в for...in, Object.keys и JSON.stringify. А Symbol.for('key') возвращает общий для всей программы символ.

JavaScript
const id1 = Symbol('id');
const id2 = Symbol('id');

console.log(typeof id1, id1 === id2);
console.log(id1.toString(), id1.description);

const user = { name: 'Leyla', [id1]: 501 };
console.log(user[id1]);
console.log(Object.keys(user), JSON.stringify(user));

console.log(Symbol.for('app') === Symbol.for('app'));
Ожидаемый результат
symbol false
Symbol(id) id
501
[ 'name' ] {"name":"Leyla"}
true
Известный символЧем управляет
Symbol.iteratorfor...of, spread, деструктуризация
Symbol.asyncIteratorfor await...of
Symbol.toPrimitiveпревращение объекта в число или строку
Symbol.toStringTagимя в результате Object.prototype.toString

Чтобы читать дальше, зарегистрируйся бесплатно

Остальные разделы урока, тест и заметки открываются с аккаунтом Educora. Регистрация занимает минуту, а прогресс сохраняется на всех твоих устройствах.

Протокол итерации

Объект итерируемый (iterable), если у него есть метод [Symbol.iterator](), который возвращает итератор. Итератор — объект с методом next(); каждый вызов next() возвращает { value, done }. done: true сообщает, что последовательность закончилась. for...of, spread ..., деструктуризация, Array.from, new Map(...) и Promise.all — все используют этот протокол.

JavaScript
const letters = ['a', 'b'];
const iterator = letters[Symbol.iterator]();

console.log(iterator.next());
console.log(iterator.next());
console.log(iterator.next());
Ожидаемый результат
{ value: 'a', done: false }
{ value: 'b', done: false }
{ value: undefined, done: true }
«Под капотом» for...of делает именно это: вызывает next(), пока не придёт done: true.
JavaScript
const range = {
  from: 1,
  to: 5,
  [Symbol.iterator]() {
    let current = this.from;
    const last = this.to;
    return {
      next() {
        return current <= last
          ? { value: current++, done: false }
          : { value: undefined, done: true };
      },
    };
  },
};

for (const n of range) console.log(n);
console.log([...range], Math.max(...range));
const [first, second] = range;
console.log(first, second);
Ожидаемый результат
1
2
3
4
5
[ 1, 2, 3, 4, 5 ] 5
1 2

Генераторы

Писать итератор вручную долго. Функция-генератор (function*) при вызове не выполняет тело, а возвращает объект-генератор — он одновременно итератор и итерируемый объект. yield отдаёт значение и приостанавливает функцию; следующий next() продолжает выполнение сразу после yield. Код работает лениво: значение вычисляется, только когда его запрашивают.

JavaScript
function* countdown(from) {
  console.log('start');
  while (from > 0) {
    yield from;
    from--;
  }
  return 'liftoff';
}

const gen = countdown(3);
console.log('generator created');
console.log(gen.next());
console.log(gen.next().value, gen.next().value);
console.log(gen.next());
console.log([...countdown(2)]);
Ожидаемый результат
generator created
start
{ value: 3, done: false }
2 1
{ value: 'liftoff', done: true }
start
[ 2, 1 ]
«start» выводится только при первом next(). Значение return приходит только вместе с done: true — for...of и spread его игнорируют.

Поскольку значения вычисляются по требованию, генератор может быть бесконечным: while (true) здесь безопасен, ведь take забирает ровно столько значений, сколько нужно, и останавливается. Это удобно и для чтения больших файлов построчно или данных, приходящих постранично.

JavaScript
function* ids() {
  let n = 1;
  while (true) yield `id-${n++}`;
}

function* fibonacci() {
  let [a, b] = [0, 1];
  while (true) {
    yield a;
    [a, b] = [b, a + b];
  }
}

function* take(iterable, count) {
  if (count <= 0) return;
  for (const item of iterable) {
    yield item;
    if (--count === 0) return;
  }
}

console.log([...take(ids(), 3)]);
console.log([...take(fibonacci(), 10)].join(' '));
Ожидаемый результат
[ 'id-1', 'id-2', 'id-3' ]
0 1 1 2 3 5 8 13 21 34

Генераторы на практике

JavaScript
class Playlist {
  #songs = [];

  add(...titles) {
    this.#songs.push(...titles);
    return this;
  }

  *[Symbol.iterator]() {
    yield* this.#songs;
  }
}

const playlist = new Playlist().add('Morning', 'Caspian Waves', 'Old Baku');

for (const [index, song] of [...playlist].entries()) {
  console.log(`${index + 1}. ${song}`);
}
console.log(Array.from(playlist, (song) => song.length));
Ожидаемый результат
1. Morning
2. Caspian Waves
3. Old Baku
[ 7, 13, 8 ]
yield* передаёт работу другому итерируемому объекту — здесь приватному массиву. Песни остаются скрытыми, но класс работает с for...of и Array.from.

Когда данные приходят со временем (страницы API, сообщения чата), пригодятся асинхронный генератор (async function*) и цикл for await...of: цикл ждёт каждую следующую порцию.

JavaScript
const wait = (ms) => new Promise((resolve) => setTimeout(resolve, ms));

async function* loadPages(total) {
  for (let page = 1; page <= total; page++) {
    await wait(100);
    yield [`item ${page * 2 - 1}`, `item ${page * 2}`];
  }
}

for await (const items of loadPages(3)) {
  console.log(items);
}
console.log('All pages loaded');
Ожидаемый результат
[ 'item 1', 'item 2' ]
[ 'item 3', 'item 4' ]
[ 'item 5', 'item 6' ]
All pages loaded

Задание

Напиши генератор chunk(array, size): он делит массив на части по size элементов и отдаёт каждую часть через yield (последняя часть может быть короче).

Задание · JavaScript
function* chunk(array, size) {
  // yield slices of the array with `size` items each
}

for (const part of chunk([1, 2, 3, 4, 5, 6, 7], 3)) {
  console.log(part);
}
console.log([...chunk(['a', 'b', 'c', 'd'], 2)].length);
Ожидаемый результат
[ 1, 2, 3 ]
[ 4, 5, 6 ]
[ 7 ]
2

Задание

Сделай объект countdown итерируемым без генератора: метод [Symbol.iterator]() возвращает объект с методом next(), который выдаёт числа от start до 1. Каждый цикл должен получать новый итератор.

Задание · JavaScript
const countdown = {
  start: 3,
  // add [Symbol.iterator]() that returns { next() { ... } }
};

console.log([...countdown]);
for (const n of countdown) {
  console.log(`T-${n}`);
}
Ожидаемый результат
[ 3, 2, 1 ]
T-3
T-2
T-1

Запомни

  • Символ — уникальный примитив; символьные ключи не конфликтуют и не видны в Object.keys и JSON.stringify.
  • У итерируемого объекта есть метод [Symbol.iterator](), возвращающий итератор; next() итератора возвращает { value, done }.
  • for...of, spread, деструктуризация и Array.from работают с любым итерируемым объектом.
  • function* и yield создают приостанавливаемые, ленивые и даже бесконечные генераторы.
  • async function* и for await...of нужны для данных, приходящих со временем.
Заметил ошибку или неточность в уроке?

Проверь себя

Вопросов: 10. Каждый правильный ответ приносит XP.

Вопрос 1 / 10

Вопрос 1 / 10. Чему равно Symbol('x') === Symbol('x')?