[Modern JavaScript Deep Dive] Iterable

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

ES6 이전 순회 가능한 데이터 컬렉션, 배열, 문자열, 유사배열객체, DOM컬렉션 등은 통일된 규약 없이 나름의 구조를 가지고 for 문 , for in 문 forEach 메서드등 다양한 방법으로 순회할 수 있었습니다. ES6에서는 순회 가능한 데이터 컬렉션을 이터레이션 프로토콜을 준수하는 이터러블로 통일하여 for...of문 , 스프레드문법, 배열 distructuring 할당의 대상으로 사용할 수 있도록 일원화 했습니다.

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

- 이터레이터 프로토콜: 이터러블의 Symbol.iterator메서드를 호출하면 이터레이터 프로토콜을 준수한 이터레이터를 반환한다. 이 이터레이터는 next 메서드를 소유하며 next 메서드를 호출하면 이터러블을 순회함며 value 와 done 프로퍼티를 갖는 이터레이터 result 객체 를 반환한다. 이러한 규약을 이터레이터 프로토콜이라고하며, 이터레이터 프로토콜을 준수한 객체를 이터레이터라고 한다. 이터레이터는 이터러블의 요소를 탐색하기 위한 포인터 역할을 한다.

이터러블

이터러블 프로토콜을 준수한 객체를 이터러블이라고 합니다. 이터러블은 Symbol.iterator를 프로퍼티 키로 사용한 메서드를 직접 구현하거나 프로토타입 체인을 통해 상속받은 객체를 말합니다.

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

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

예를 들어 배열은 Array.prototype의 Symbo.iterator 메서드를 상속받는 이터러블이다. 이터러블은 for ...of 문으로 순회할 수 있으며, 스프레드 문법과 배열 디스트럭처링 할당의 대상으로 사용할 수 있다.

const array = [1,2,3]
console.log(Symbol.iterator in array); // true;
for (const item of array) {
    console.log(item);
}
console.log([...array]) // 이터러블인 배열은 스프레드 문법의 대상으로 사용할 수 있다.
console.log([a, ...rest]) // 이터러블인 배열은 배열 디스트럭처링 할당의 대상으로 사용할 수 있다.

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

const obj = {a: 1, b: 2};
console.log(Symbol.iterator in obj); // false
for (const item of obj) { // type error: obj is not iterable
    console.log(item);
}

단 TC39 프로세스의 stage4단계에 제안되어 있는 스프레드 프로퍼티 제안은 일반 객체에 스프레드 문법을 허용한다.

const obj = {a: 1, b : 2 } ;
console.log({...obj}) // {a: 1, b: 2}
// 스프레드 프로퍼티 제안은 객체 리터럴 내부에서 스프레드 문법의 사용을 허용합니다.

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

const array = [1,2,3];
const iterator = array[Symbol.iterator]();
console.log('next' in iterator); // true       

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

const array = [1,2,3]; // 배열은 이터러블 프로토콜을 준수한 이터러블인데, 여기서 Symbol.iterator을 키로갖는 함수를 호출하면 이터레이터를 반환한다. 객체는 이터러블이아니다!
const iterator = array[Symbol.iterator]();
console.log(iterator.next()); // {value : 1, done: false} -> iterator result object
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 프로퍼티는 이터러블의 순회 완료 여부를 나타냅니다.

다음으로 빌트인 이터러블을 알아봅시다.

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 -> arguments[Symbol.iterator]
DOM 컬렉션 -> NodeList.prototype[Symbol.iterator], HTMLCollection.prototype[Symbol.iterator]

for ... of 문은 이터러블을 순회하면서(즉 일반객체는 안됨) 이터러블의 요소를 변수에 할당합니다.

for of 문은 for in 문과 유사한데, for ... in 문은 객체의 프로토타입 체인 상에 존재하는 모든 프로토타입의 프로퍼티 중에서 프로터피 어트리뷰트 [[Enmerable]]의 값이 true인 프로퍼티를 순회하며 열거합니다. 이때 프로퍼티 키가 심벌인 프로퍼티는 열거하지 않습니다.

for (변수 선언문 of 이터러블) {...}
for (let a of "hyunjin") console.log(a);

for (변수 선언문 in 객체) {...}

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

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

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
}

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

유사 배열 객체
const arrayLike = {
  0: 1,
  1: 2,
  2: 3,
  length: 3
}
for (let i = 0 ; i < arrayLike.length ; i++) {
    console.log(arrayLike[i]);
}

for ... of 문, 스프레드 문법, 배열 디스트럭처링 할당 등은 Array, String, Map, Set, TypedArray (Uint8Array, Int8Array, Uint8Clamped, Int16Array, Uint16Array, Int32Array, Uint32Array, Float32Array, Float64Array) , DOM컬렉션 (NodeList, HTMLCollection) ,arguments와 같이 다양한 데이터 소스를 사용할 수 있습니다. ES6에서는 순회가능한 데이터 컬렉션을 이터레이션 프로토콜을 준수하는 이터러블로 통일하여 for ... of 문, 스프레드 문법, 배열 디스트럭처링 할당의 대상으로 사용할 수 있도록 일원화했습니다.

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

즉 이터러블을 지원하는 데이터 소비자는 내부에서 Symbol.iterator 메서드를 호출해 이터레이터를 생성하고 이터레이터의 next 메서드를 호출하여 이터러블을 순회하며 이터레이터 리절트 객체를 반환합니다. 그리고 그 객체의 value/done 값을 취득합니다.

이터러블은 데이터 공급자의 역할을 합니다. 배열이나 문자열 등은 모든 데이터를 메모리에 미리 확보한 다음 데이터를 공흡합니다. 하지만 이터러블은 지연 평가를 통해 데이터를 생성합니다. 지연 평가는 데이터가 필요한 시점까지는 미리 데이터를 생성하지 않다가 데이터가 필요한 시점이 되면 그때 비로서 데이터를 생성하는 기법입니다. 즉 평가 결과가 필요할 때까지 평가를 늦추는 기법이 지연 평가입니다.

const fibonacciFunc = function () {
    let [pre, cur] = [0,1]
    return {
        [Symbol.iterator]() { return this; }
          next() {
            [pre, cur] = [cur, pre + cur]
              return {value: cur};
        }
    }
}
// fibonacciFunc 함수는 무한 이터러블을 생성합니다.
for (const num of fibonacciFunc()) {
    if (num > 10000) break;
      console.log(num);

}
// 지연평가 여기서 3개만 실행하는거
const [f1, f2, f3] = fibonacciFunc();
console.log(f1,f2,f3); // 1 2 3

위 예제의 fibonacciFunc 함수는 무한 이터러블을 생성합니다. 하지만 fibonacciFunc 함수가 생성한 무한 이터러블은 데이터를 공급하는 메커니즘을 구현한 것으로 데이터 소비자인 for ... of 문이나 배열 디스트럭처링 할당 등이 실행되기 전까지 데이터를 생성하지 않습니다.for of 문의 경우 이터러블을 순회할 때 내부에서 이터레이터의 next 메서드를 호출하는데 바로 이때 데이터가 생성됩니다. next 메서드가 호출되기 이전까지는 데이터를 생성하지 않습니다. 즉, 데이터가 필요할 때까지 데이터 생성을 지연하다가 데이터가 필요한 순간 데이터를 생성합니다. 

 

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