Метод JavaScript Array [Symbol.iterator]()

Array 对象参考手册Объект Array в JavaScript


Пример

Получите объект итератора массива и выведите его в цикле:

const fruits = ['apple', 'banana', 'orange']; //1. Получите объект итератора массива const iterator = fruits[Symbol.iterator](); //2. Вручную вызовите метод next() итератора console.log(iterator.next()); // { value: 'apple', done: false } console.log(iterator.next()); // { value: 'banana', done: false } console.log(iterator.next()); // { value: 'orange', done: false } console.log(iterator.next()); // { value: undefined, done: true } //3. Используйте цикл for...of (он автоматически вызывает [Symbol.iterator]() внутри) for (const fruit of fruits) { console.log(fruit); } //Вывод: // apple // banana // orange //4. Используйте оператор spread (также опирается на итератор) const fruitCopy = [...fruits]; console.log(fruitCopy); // ['apple', 'banana', 'orange']

Попробуйте сами »

Определение и использование

[Symbol.iterator]()Это встроенный метод массивов JavaScript, возвращающий итератор массива по умолчанию. Этот метод делает массив итерируемым объектом, который может бытьfor...ofиспользован циклами и другими конструкциями.

Что такое итератор?

Прежде чем объяснить[Symbol.iterator]()этот метод, нам нужно сначала понять, что такое итератор.

Итератор — это протокол в JavaScript, который определяет, как последовательно получать доступ к элементам коллекции. Любой объект, реализующий протокол итератора, может быть использованfor...ofциклами, оператором расширения (...) и другими возможностями JavaScript.

Объект-итератор должен реализовыватьnext()метод, который возвращает объект, содержащий два свойства:

  • value: значение текущей итерации
  • done: логическое значение, указывающее, завершена ли итерация

Базовый синтаксис

const iterator = array[Symbol.iterator]();

Пример кода

Рассмотрим простой пример:

Пример

const fruits = ['apple', 'banana', 'orange'];

// Получить итератор массива
const iterator = fruits[Symbol.iterator]();

console.log(iterator.next()); // { value: 'apple', done: false }
console.log(iterator.next()); // { value: 'banana', done: false }
console.log(iterator.next()); // { value: 'orange', done: false }
console.log(iterator.next()); // { value: undefined, done: true }

В этом примере мы:

  1. создали массив, содержащий три фрукта
  2. с помощью[Symbol.iterator]()метода, получили итератор массива
  3. Многократно вызывайте у итератораnext()метод, чтобы получить каждый элемент массива по очереди.

Практические сценарии применения

1. Использование цикла for...of

for...ofЦикл внутри автоматически вызывает у массива[Symbol.iterator]()метод:

Пример

const colors = ['red', 'green', 'blue'];

for (const color of colors) {
  console.log(color);
}
// Вывод:
// red
// green
// blue

2. Использование оператора расширения

Оператор расширения также полагается на протокол итератора:

Пример

const numbers = [1, 2, 3];
const copiedNumbers = [...numbers];

console.log(copiedNumbers); // [1, 2, 3]

3. Деструктурирующее присваивание

Деструктуризация массива также использует итератор:

Пример

const [first, second] = ['a', 'b', 'c'];
console.log(first); // 'a'
console.log(second); // 'b'

Настройка поведения итерации массива

Хотя это редко нужно, вы можете переопределить стандартный[Symbol.iterator]()метод для настройки поведения итерации:

Пример

const customArray = [1, 2, 3];

customArray[Symbol.iterator] = function() {
  let index = this.length;
 
  return {
    Далее: () => {
      index--;
      return {
        value: this[index],
        done: index < 0
      };
    }
  };
};

for (const num of customArray) {
  console.log(num);
}
// Вывод:
// 3
// 2
// 1

В этом примере мы изменили итератор так, чтобы массив перебирался с конца в начало.


Сравнение с другими методами итерации

Отличия от forEach()

  • forEach()является методом массива, который выполняет функцию обратного вызова для каждого элемента
  • [Symbol.iterator]()возвращает объект итератора, позволяя более гибко управлять процессом итерации

Связь с keys()/values()/entries()

Все эти методы возвращают итераторы, но имеют разное применение:

  • keys(): возвращает итератор по индексам массива
  • values(): возвращает итератор по элементам массива (то же, что[Symbol.iterator]())
  • entries(): возвращает итератор по парам индекс/значение

Совместимость с браузерами

Array [Symbol.iterator]()Метод поддерживается в следующих средах:

  • Chrome 38+
  • Firefox 36+
  • Edge 12+
  • Safari 9+
  • Opera 25+
  • Node.js 0.12+

Итог

Array [Symbol.iterator]()Метод играет ключевую роль в реализации протокола iterable массивами JavaScript. Понимание того, как работает этот метод, может помочь вам:

  1. Глубже понять механизм итерации JavaScript
  2. Пишите более эффективный код итерации
  3. Настраивайте поведение итерации при необходимости

Помните, что в большинстве случаев вам не нужно вызывать этот метод напрямую, потому чтоfor...ofциклы и другие возможности языка обрабатывают это внутри. Но понимание того, как это работает, сделает вас лучшим JavaScript-разработчиком.

Array 对象参考手册Объект Array в JavaScript

Другие расширения