모던 자바스크립트 Deep Dive : 34장 이터러블

EdLee·2022년 11월 21일

javascript

목록 보기
26/37

34장 이터러블

1. 이터레이션 프로토콜

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

이터러블 프로토콜
Well-known Symbol인 Symbol.iterator 프로퍼티 키로 사용한 메서드를 직접 구현하거나 프로토타입 체인을 통해 상속받은 Symbol.iterator 메서드를 호출하면 이터레이터 프로토콜을 준수한 이터레이터를 반환한다. 이러한 규약을 이터러블 프로토콜이라 하며, 이터러블 프로토콜을 준수한 객체를 이터러블이라 한다. 이터러블은 for...of 문으로 순회할 수 있으며 스프레드 문법과 배열 디스트럭처링 할당의 대상으로 사용할 수 있다.

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

1.1 이터러블

  • 이터러블 프로토콜을 준수한 객체
  • 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의 Symbol.iterator 메서드를 상속받는 이터러블
  • 따라서 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 문 순회, 스프레드 문법과 배열 디스트럭처링 대상으로도 사용 불가능
const obj = { a: 1, b: 2 };

// 일반 객체는 Symbol.iterator 메서드를 구현하거나 상속받지 않는다.
// 따라서 일반 객체는 이터러블 프로토콜을 준수한 이터러블이 아니다.
console.log(Symbol.iterator in obj); // false

// 이터러블이 아닌 일반 객체는 for...of 문으로 순회할 수 없다.
for (const item of obj) { // -> TypeError: obj is not iterable
  console.log(item);
}

// 이터러블이 아닌 일반 객체는 배열 디스트럭처링 할당의 대상으로 사용할 수 없다.
const [a, b] = obj; // -> TypeError: obj is not iterable

1.2 이터레이터

  • 이터러블의 Symbol.iterator 메서드를 호출하면 이터레이터를 반환한다
// 배열은 이터러블 프로토콜을 준수한 이터러블이다.
const array = [1, 2, 3];

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

// Symbol.iterator 메서드가 반환한 이터레이터는 next 메서드를 갖는다.
console.log('next' in iterator); // true
  • 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 }

2. 빌트인 인터러블

빌트인 이터러블Symbol.iterator 메서드
ArrayArray.prototype[Symbol.iterator]
StringString.prototype[Symbol.iterator]
MapMap.prototype[Symbol.iterator]
SetSet.prototype[Symbol.iterator]
TypedArrayTypedArray.prototype[Symbol.iterator]
argumentsarguments.prototype[Symbol.iterator]
DOM 컬렉션NodeList.prototype[Symbol.iterator]
HTMLCollection.prototype[Symbol.iterator]

3. for ... of 문

  • for ... of 문은 이터러블을 순회하면서 이터러블의 요소를 변수에 할당
for (변수선언문 of 이터러블) { ... }
  • for ... in문과 유사해 보인다
for (변수선언문 in 객체) { ... }

차이점
for ... in : 객체의 프로토타입 체인 상에 존재하는 모든 프로토타입의 프로퍼티 중에서 프로퍼티 어트리뷰트 [[Enumerable]]의 값이 true인 프로퍼티를 순회하며 열거. 이 때 프로퍼티 키가 심벌인 프로퍼티는 열거하지 않는다.

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

for (const item of [1, 2, 3]) {
  // item 변수에 순차적으로 1, 2, 3이 할당된다.
  console.log(item); // 1 2 3
}
  • 위 예제의 내부 동작을 풀어쓰면
// 이터러블
const iterable = [1, 2, 3];

// 이터러블의 Symbol.iterator 메서드를 호출하여 이터레이터를 생성한다.
const iterator = iterable[Symbol.iterator]();

for (;;) {
  // 이터레이터의 next 메서드를 호출하여 이터러블을 순회한다. 이때 next 메서드는 이터레이터 리절트 객체를 반환한다.
  const res = iterator.next();
  console.log(res) // {value: 1, done: false}, {value: 2, done: false}, {value: 3, done: false}, {value: undefined, done: true}

  // next 메서드가 반환한 이터레이터 리절트 객체의 done 프로퍼티 값이 true이면 이터러블의 순회를 중단한다.
  if (res.done) break;

  // 이터레이터 리절트 객체의 value 프로퍼티 값을 item 변수에 할당한다.
  const item = res.value;
  console.log(item); // 1 2 3
}

4. 이터러블과 유사 배열 객체

  • 유사 배열 객체 : 마치 배열처럼 인덱스로 프로퍼티 값에 접근할 수 있고, 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]); // 1 2 3
}
  • 하지만 유사 배열 객체는 이터러블이 아닌 일반 객체
for (const item of arrayLike) {
  console.log(arrayLike[i]); // TypeError
}

// Array.from 활용해 유사 배열 객체를 배열로 변환 하면 해결!
const arr = Array.from(arrayLike);
console.log(arr); // [1, 2, 3]
  • 단, arguments, NodeList, HTMLCollection은 유사 배열 객체이면서 이터러블이다

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

  • Array, String, DOM 컬렉션 등 다양한 컬렉션이 각자 다른 순회 방식을 가진다면, 이를 순회하도록 하는 메소드들은 각기 그 순회 방법을 모두 지원해야 한다
  • 이런 비효율을 막기 위해, 순회 방식 자체를 이터레이션 표준 하나로 묶은 것

6. 사용자 정의 이터러블

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

  • 피보나치 수열의 예제
// 피보나치 수열을 구현한 사용자 정의 이터러블
const fibonacci = {
  // Symbol.iterator 메서드를 구현하여 이터러블 프로토콜을 준수한다.
  [Symbol.iterator]() {
    let [pre, cur] = [0, 1]; // "36.1. 배열 디스트럭처링 할당" 참고
    const max = 10; // 수열의 최대값

    // Symbol.iterator 메서드는 next 메서드를 소유한 이터레이터를 반환해야 하고
    // next 메서드는 이터레이터 리절트 객체를 반환해야 한다.
    return {
      next() {
        [pre, cur] = [cur, pre + cur]; // "36.1. 배열 디스트럭처링 할당" 참고
        // 이터레이터 리절트 객체를 반환한다.
        return { value: cur, done: cur >= max };
      }
    };
  }
};

// 이터러블인 fibonacci 객체를 순회할 때마다 next 메서드가 호출된다.
for (const num of fibonacci) {
  console.log(num); // 1 2 3 5 8
}

// 직접 순회 방식
// 이터러블의 Symbol.iterator 메서드는 이터레이터를 반환한다.
const iterator = iterable[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: 5, done: true }

// 이터러블은 스프레드 문법의 대상이 될 수 있다.
const arr = [...fibonacci];
console.log(arr); // [ 1, 2, 3, 5, 8 ]

// 이터러블은 배열 디스트럭처링 할당의 대상이 될 수 있다.
const [first, second, ...rest] = fibonacci;
console.log(first, second, rest); // 1 2 [ 3, 5, 8 ]

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

  • 위 예제에서 수열의 최대값을 외부에서 전달할 수 있도록 수정
const fibonacciFunc = function(max) {
  let [pre,cur] = [0,1];
  
  return {
    [Symbol.iterator]() {
      return{
        next(){
          [pre,cur] = [cur,pre+cur];
          return { value: cur, done: cur >= max };
        }
      }
    }
  };
};
// 이터러블을 반환하는 함수에 수열의 최대값을 인수로 전달하면서 호출한다.
// fibonacciFunc(10)은 이터러블을 반환한다.
for(const num of fibonacciFunc(10)){
  console.log(num); // 1 2 3 5 8
}

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

  • 앞서 살펴본 fibonacciFunc 함수로 이터레이털르 생성하려면, Symbol.iterator 메서드를 호출해야만 한다
const iterable = fibonacciFunc(5);
const iterator = iterable[Symbol.iterator]();

console.log(iterator.next());
  • 이터러블 이면서 이터레이터인 객체를 생성하면, Symbol.iterator 메서드를 호출할 필요가 없다
  • 다음 예제를 참고
{
  [Symbol.iterator]() {return this; },
  next() {
    return { value: any, done: boolean };
  }
}
  • fibonacciFunc 예제를 수정해보자
// 이터러블이면서 이터레이터인 객체를 반환하는 함수 
const fibonacciFunc = function (max) {
  let [pre, cur] = [0,1];
  
  // Symbol.iterator 메서드와 next 메서드를 소유한 이터러블이면서 이터레이터인 객체를 반환
  return {
    [Symbol.iterator]() { return this; },
    // next 메서드는 이터레이터 리절트 객체를 반환
    next(){
      [pre, cur] = [cur, pre + cur];
      return { value : cur, done : cur >= max };
    }
  };
};

// iter는 이터러블이면서 이터레이터다. 
let iter = fibonacciFunc(10);

// iter는 이터러블이므로 for...of 문으로 순회할 수 있다. 
for (const num of iter){
  console.log(num); // 1 2 3 5 8
}

// iter는 이터레이터이므로 이터레이션 리절트 객체를 반환하는 next 메서드를 소유한다. 
console.log(iter.next()); // {value : 1, done : false}

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 };
    }
  };
};

for (const num of fibonacciFunc()){
  if (num > 10000) break;
  console.log(num);
}

// 무한 이터러블에서 3개의 요소만 취득 
const [f1, f2, f3] = fibonacciFunc();
  • 지연 평가란? : 데이터가 필요한 시점 이전까지는 미리 데이터를 생성하지 않다가 데이터가 필요한 시점이 되면 그때야 비로소 데이터를 생성하는 기법
profile
EdLee
이전 포스트

모던 자바스크립트 Deep Dive : 36장 디스트럭처링 할당

다음 포스트

모던 자바스크립트 Deep Dive : 37장 Set과 Map

0개의 댓글