34장 이터러블(iterable)

* 아래 내용은 이웅모 저자님의   모던 자바스크립트 Deep Dive 책(위키북스)을 정리한 내용입니다.

   저작권에 문제가 된다면 삭제하도록 하겠습니다.

 

34.1 이터레이션 프로토콜

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

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

 

이터러블 프로토콜 - Symbol.iterator를 프로퍼티 키로 사용한 메서드를 직접 구현하거나 프로토타입 체인을 통해 상속받은 Symbol.iterator 메서드를 호출하면 이터레이터 프로토콜을 준수한 이터레이터를 반환하는 규칙. 

 

이터레이터 프로토콜 - next 메서드를 소유하며 next 메서드를 호출하면 이터러블을 순회하면 value 와 done 프로퍼티를 갖는 이터레이터 리절트 객체를 반환하는 규칙. 

 

34.1.1 이터러블

이터러블 프로토콜을 준수한 객체를 이터러블 이라고 한다. 다음과 같은 코드로 확인이 가능하다.

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

// 배열, 문자열, Map, Set 등은 이터러블이다.
isIterable([]);        // -> true
isIterable('');        // -> true
isIterable(new Map()); // -> true
isIterable(new Set()); // -> true
isIterable({});        // -> false

 

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

일반 객체는 이터러블이 아니므로 for ... of 문으로 순회할 수 있으며 배열 디스트럭처링 할당의 대상으로 사용할 수 없다.(스프레드 문법은 허용)

일반 객체도 사용자 정의로 이터러블 프로토콜을 준수하도록 구현하면 이터러블이 된다.(34.6절 참조)

 

34.1.2 이터레이터

이터레이터 프로토콜을 준수한 객체를 이터레이터라고 한다.

이터레이터의 next 메서드는 이터러블을 순차적으로 순회하며 순회결과를 나타내는 이터레이터 리절트 객체를 반환한다.

// 배열은 이터러블 프로토콜을 준수한 이터러블이다.
const array = [1, 2, 3];

// Symbol.iterator 메서드는 이터레이터를 반환한다. 이터레이터는 next 메서드를 갖는다.
const iterator = array[Symbol.iterator]();

// next 메서드를 호출하면 이터러블을 순회하며 순회 결과를 나타내는 이터레이터 리절트 객체를
// 반환한다. 이터레이터 리절트 객체는 value와 done 프로퍼티를 갖는 객체다.
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 }

 

34.2 빌트인 이터러블

Array, String, Map, Set, TypedArray, arguments, DOM 컬렉션이 빌트인 이터러블이다.

 

34.3 for ... of 문

for ... of 문은 내부적으로 이터레이터의 next 메서드를 호출하여 이터러블을 순회하며 이터레이터 리절트 객체의 value프로퍼티값을 for ... of 문의 변수에 할당한다. 이터레이터 리절트 객체의 done 값이 true이면 계속 순회하고, false이면 순회를 중단한다.

for (const item of [1, 2, 3]) {
  // item 변수에 순차적으로 1, 2, 3이 할당된다.
  console.log(item); // 1 2 3
}

 

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

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

유사 배열 객체는 이터러블이 아닌 일반 객체이므로 Symbol.iterator가 없다.

ES6에서 이터러블이 도입되면서 arguments, NodeList, HTMLCollection같은 유사 배열 객체에 Symbol.iterator가 추가되면서  유사 배열 객체이면서 이터러블이 되었다.

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

// 유사 배열 객체
const arrayLike = {
  0: 1,
  1: 2,
  2: 3,
  length: 3
};

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

 

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

ES6 이전에는 순회 가능한 여러 자료구조들(배열, 문자열, DOM컬렉션 등)이 통일된 규칙없이 각자의 구조로 순회할 수 있었다.

ES6에서는 순회 가능한 데이터 컬렉션을 이터레이션 프로토콜을 준수하는 이터러블로 통일하여 for ... of 문, 스프레드 문법, 배열 디스트럭쳐링 할당의 대상으로 사용할 수 있도록 일원화 했다.

 

다양한 데이터 공급자가 각자의 순회 방식을 갖는다면 데이터 소비자는 순회 방식을 모두 지원해야 한다. 하지만 다양한 데이터 공급자가 이터레이션 프로토콜을 준수하도록 규정하면 데이터 소비자는 이터레이션 프로토콜만 지원하도록 구현하면 된다.

이처럼 이터레이션 프로토콜은 데이터 소비자와 데이터 공급자를 연결하는 인터페이스 역할을 한다.

 

34.6 사용자 정의 이터러블

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

이터레이션 프로토콜을 준수하도록 Symbol.iterator 메서드를 구현하고 Symbol.iterator 메서드가 next 메서드를 갖는 이터레이터를 반환하도록 한다. 이터레이터의 next 메서드는 done과 value 프로퍼티를 가지는 이터레이터 리절트 객체를 반환한다.

// 1 ~ 5 범위의 정수로 이루어진 이터러블
const iterable = {
  // Symbol.iterator 메서드를 구현하여 이터러블 프로토콜을 준수
  [Symbol.iterator]() {
    let cur = 1;
    const max = 5;
    // Symbol.iterator 메서드는 next 메서드를 소유한 이터레이터를 반환
    return {
      next() {
        return { value: cur++, done: cur > max + 1 };
      }
    };
  }
};

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

 

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

위의 코드를 조금 수정해서 인자로 최대값을 전달 받는 이터러블을 생성하는 함수를 작성할 수 있다.

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

for (const num of iterableFunc(6)) {
  console.log(num); 		// 1 2 3 4 5 6
}

 

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

다음 객체는 Symbol.iterator 메서드와 next 메서드를 소유한 이터러블이면서 이터레이터다. 

// 이터러블이면서 이터레이터인 객체. 이터레이터를 반환하는 Symbol.iterator 메서드와
// 이터레이션 리절트 객체를 반환하는 next 메서드를 소유한다.
{
  [Symbol.iterator]() { return this; },
  next() {
    return { value: any, done: boolean };
  }
}

 

34.6.2의 함수를 수정하여 이터러블이면서 이터레이터인 객체를 생성하여 반환하는 함수로 변경 할 수 있다.

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

let iter = iterableFunc(5);

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

iter = iterableFunc(5);

console.log(iter.next());		// { value : 1, done : false }
console.log(iter.next());		// { value : 2, done : false }
console.log(iter.next());		// { value : 3, done : false }
console.log(iter.next());		// { value : 4, done : false }
console.log(iter.next());		// { value : 5, done : false }
console.log(iter.next());		// { value : 6, done : true }

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

// 무한 이터러블을 생성하는 함수
const fibonacciFunc = function () {
  let [pre, cur] = [0, 1];

  return {
    [Symbol.iterator]() { return this; },
    next() {
      [pre, cur] = [cur, pre + cur];
      // 무한을 구현해야 하므로 done 프로퍼티를 생략한다.
      return { value: cur };
    }
  };
};

// fibonacciFunc 함수는 무한 이터러블을 생성한다.
for (const num of fibonacciFunc()) {
  if (num > 10000) break;
  console.log(num); // 1 2 3 5 8...4181 6765
}

// 배열 디스트럭처링 할당을 통해 무한 이터러블에서 3개의 요소만 취득한다.
const [f1, f2, f3] = fibonacciFunc();
console.log(f1, f2, f3); // 1 2 3

위 코드의 이터러블은 지연 평가를 통해 데이터를 생성한다. 지연 평가는 데이터가 필요한 시점 이전까지는 데이터를 생성하지 않다가 데이터가 필요한 시점되면 그때야 비로소 데이터를 생성하는 기법이다.

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

 

 

Reference

- 이웅모 ,  모던 자바스크립트 Deep Dive , 위키북스 , 2020