34. 이터러블

34.1 이터레이션 프로토콜

ES6에서 도입된 이터레이션 프로토콜은 순회 가능한 데이터 컬렉션을 만들기 위해 ECMAScript 사양에 정의하여 미리 약속한 규칙이다.

이터레이션 프로토콜에는 이터러블 프로토콜과 이터레이터 프로토콜이 있다.

• 이터러블 프로토콜
  Well-known Symbol인 Symbol.iterator를 프로퍼티 키로 사용한 메서드를 직접 구현하거나 프로토타입 체인을 통해 상속받은 Symbol.iterator메서드를 호출하면 이터레이터 프로토콜을 준수한 이터레이터를 반환한다.
  이러한 규약을 이터러블 프로토콜이라 하며, 이터러블 프로토콜을 준수한 객체를 이터러블이라 한다.
• 이터레이터 프로토콜
  이터러블의 Symbol.iterator 메서드를 호출하면 이터레이터 프로토콜을 준수한 이터레이터를 반환한다. 이터레이터는 next 메서드를 소유하며 next 메서드를 호출하면 이터러블을 순회하며 value와 done 프로퍼티를 갖는 이터레이터 리절트 객체를 반환한다.
  이러한 규약을 이터레이터 프로토콜이라 하며, 이터레이터 프로토콜을 준수한 객체를 이터레이터라 한다.

34.1.1 이터러블

이터러블인지 확인하는 함수는 다음과 같이 구현할 수 있다.

const isIterable = v => v !== null && typeof v[Symbol.iterator] === 'function';

이터러블은 for ... of 문으로 순회할 수 있으며, 스프레트 문법과 배열 디스트럭처링 할당의 대상으로 사용할 수 있다.

const array = [1,2,3];
  
// 배열은 Array.prototype의 Symbol.iterator 메서드를 상속받는 이터러블이다.
console.log(Symbol.iterator in array); // true
// 이터러블인 배열은 for ... of 문으로 순회 가능하다
for (const item of array) {
  console.log(item);
}
  
// 이터러블인 배열은 스프레드 문법의 대상으로 사용할 수 있다.
console.log([...array]); // [1,2,3]

// 이터러블인 배열은 배열 디스트럭처링 할당의 대상으로 사용할 수 있다.
const [a, ...rest] = array;
console.log(a,rest); // 1,[2,3]

Symbol.iterator 메서드를 직접 구현하지 않거나 상속 받지 않는다면 이터러블 프로토콜을 준수한 이터러블이 아니다. 따라서 일반 객체는 for ... of 문으로 순회할 수 없으며 스프레드 문법과 배열 디스트럭쳐링 할당의 대상으로 사용할 수 없다.

단, 현재 stage 4(Finished) 단계에 제안되어 있는 스프레드 프로퍼티 제안은 일반 객체에 스프레드 문법의 사용을 허용한다.

const obj = { a: 1, b: 2 }
console.log({ ...obj }); // { a: 1, b: 2 }

34.1.2 이터레이터

이터러블의 Symbol.iterator 메서드를 호출하면 이터레이터 프로토콜을 준수한 이터레이터를 반환한다. 이러러블의 Symbol.iterator 메서드가 반환한 이터레이터는 next 메서드를 갖는다.

이터레이터의 next 메서드는 이터러블의 각 요소를 순회하기 위한 포인터의 역할을 한다. 즉 next 메서드를 호출하면 이터러블을 순차적으로 한 단계씩 순회하며 순회 결과를 나타내는 이터레이터 리절트 객체를 반환한다.

const array = [1,2,3];
  
const iterator = array[Symbol.iterator]();

console.log(iterator.next()); // { value: 1, done: false };
console.log(iterator.next()); // { value: 2, done: false };
console.log(iterator.next()); // { value: 3, done: false };
console.log(iterator.next()); // { value: undefined, done: true };

이터레이터의 next 메서드가 반환하는 이터레이터 리절트 객체의 value 프로퍼티는 현재 순회중인 이터러블의 값을 나타내며 done 프로퍼티는 이터러블의 순회 완료 여부를 나타낸다.

34.2 빌트인 이터러블

자바스크립트는 이터레이션 프로토콜을 준수한 객체인 빌트인 이터러블을 제공한다.

빌트인 이터러블	Symbol.iterator 메서드
Array	Array.prototype[Symbol.iterator]
String	String.prototype[Symbol.iterator]
Map	Map.prototype[Symbol.iterator]
Set	Set.prototype[Symbol.iterator]
TypedArray	TypedArray.prototype[Symbol.iterator]
arguments	argument[Symbol.iterator]
DOM 컬렉션	NodeList.prototype[Symbol.iterator] HTMLCollection.prototype[Symbol.iterator]

34.3 for ... of 문

for ... of 문은 내부적으로 이터레이터 next 메서드를 호출하여 이터러블을 순회하며 next 메서드가 반환한 이터레이터 리절트 객체의 value 프로퍼티 값을 for ... of 문의 변수에 할당한다.

그리고 이터레이터 리절트 객체의 done 프로퍼티 값이 false이면 이터러블의 순회를 계속하고 true이면 이터러블의 순회를 중단한다.

for ... of 문의 동작과 for문으로 표현한 for ... of 문

for (const item of [1,2,3]){
  console.log(item) // 1 2 3
}

const iterable = [1,2,3];

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

for(;;){
  const res = iterator.next();
  
  if(res.done) break;
  
  const item = res.value;
  console.log(item); // 1 2 3
}

34.4 이터러블과 유사 배열 객체

유사 배열 객체는 마치 배열처럼 인덱스로 프로퍼티 값에 접근할 수 있고 length 프로퍼티를 갖는 객체를 말한다.

유사 배열 객체는 length 프로퍼티를 갖기 때문에 for 문으로 순회할 수 있고 인덱스를 나타내는 숫자 형식의 문자열을 프로퍼티 키로 가지므로 마치 배열처럼 인덱스로 프로퍼티 값에 접근할 수 있다.

const arrayLike= {
  0: 1,
  1: 2,
  2: 3,
  length:3
};

// 유사 배열 객체는 length 프로퍼티를 갖기 때문에 for 문으로 순회할 수 있다.
for (let i = 0; i < arrayLike.length; i++){
  //유사 배열 객체는 마치 배열처럼 인덱스로 프로퍼티 값에 접근할 수 있다.
  console.log(arrayLike[i]); // 1 2 3
}

유사 배열 객체는 이터러블이 아닌 일반 객체다. 따라서 유사 배열 객체에는 Symbol.iterator 메서드가 없기 때문에 for ... of 문으로 순회할 수 없다.

단 arguments, NodeList, HTMLCollection은 유사배열이면서 이터러블이다.

모든 유사 배열 객체가 이터러블인 것은 아니다. 다만 ES6에서 도입된 Array.from 메서드를 사용하여 배열로 간단히 변환할 수 있다.

const arayLike = {
  0:1,
  1:2,
  2:3,
  length:3
};

//Array.from은 유사 배열 객체 또는 이터러블을 배열로 반환한다.
const arr = Array.from(arrayLike);
console.log(arr); // [1,2,3]

34.5 이터레이션 프로토콜의 필요성

이터러블은 for ... of문, 스프레드 문법, 배열 디스트럭처링 할당과 같은 데이터 소비자에 의해 사용되므로 데이터 공급자의 역할을 한다고 할 수 있다.

만약 다양한 데이터 공급자가 각자의 순회 방식을 갖는다면 데이터 소비자는 다양한 데이터 공급자의 순회 방식을 모두 지원해야 한다.

이처럼 이터레이션 프로토콜은 다양한 데이터 공급자가 하나의 순회 방식을 갖도록 규정하여 데이터 소비자가 효율적으로 다양한 데이터 공급자를 사용할 수 있도록 데이터 소비자와 데이터 공급자를 연결하는 인터페이스의 역할을 한다.

34.6 사용자 정의 이터러블

34.6.1 사용자 정의 이터러블 구현

피보나치 수열을 구현한 간단한 사용자 정의 이터러블을 구현해보자.

const fibonacci = {
  [Symbol.iterator]() {
    let [pre, cur] = [0,1];
    const max = 10; // 수열의 최대값 설정
    
    return {
      next() {
        [pre,cur] = [cur,pre + cur];
        return { value: cur, done: cur >=max};
      }
    };
  }
};

for(const num of fibonacci){
  console.log(num); // 1 2 3 5 8
}

34.6.2 이터러블을 생성하는 함수

const fibonacciFunc = function (max) {
  [Symbol.iterator]() {
    let [pre, cur] = [0,1];
    
    return {
      next() {
        [pre,cur] = [cur,pre + cur];
        return { value: cur, done: cur >=max};
      }
    };
  }
};

for(const num of fibonacciFunc(10)){
  console.log(num); // 1 2 3 5 8
}

34.6.3 이터러블이면서 이터레이터인 객체를 생성하는 함수

앞에서 살펴본 fibonacciFunc 함수는 이터러블을 반환한다. 만약 이터레이터를 생성하려면 이터러블의 Symbol.iterator 메서드를 호출해야 한다.

이를 위해서는 다음과 같이 만들면 된다.

const fibonacciFunc = function (max) {
  let [pre, cur] = [0,1];
     
  return {
    [Sumbol.iterator]() { return this };
    next() {
      [pre,cur] = [cur,pre + cur];
      return { value: cur, done: cur >=max};
    }
  }
};

let iter = fibonacciFunc(10);

for(const num of iter) {
  console.log(num); // 1 2 3 5 8
}

34.6.4 무한 이터러블과 지연 평가

앞의 함수에서 max를 떼보자.

const fibonacciFunc = function () {
  let [pre, cur] = [0,1];
     
  return {
    [Sumbol.iterator]() { return this };
    next() {
      [pre,cur] = [cur,pre + cur];
      return { value: cur };
    }
  }
};

for(const num of fibonacciFunc()) {
  if (num > 10000) break;
  console.log(num); // 1 2 3 5 8 ... 4181 6765
}

지연 평가는 데이터가 필요한 시점 이전까지는 미리 데이터를 생성하지 않다가 데이터가 필요한 시점이 되면 그때야 비로소 데이터를 생성하는 기법이다.

이처럼 지연평가를 사용하면 불필요한 데이터를 미리 생성하지 않고 필요한 데이터를 필요한 순간에 생성하므로 빠른 실행 속도를 기대할 수 있고 불필요한 메모리를 소비하지 않으며 무한도 표현할 수 있다는 장점이 있다.