zero-wiki Help

34장 이터러블

1 이터레이션 프로토콜

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

ES6 이전의 순회 가능한 데이터 컬렉션, 배열, 문자열 DOM 컬렉션등 통일된 규약 없이 나름의 구조를 가지고 for문, for … in 문, forEach 메소드 등 다양한 방법으로 순회할 수 있었다.

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

이터러블 프로토콜

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

이터레이터 프로토콜

이터러블의 Symbol.iterator 메소드를 호출하면 이터레이터 프로토콜을 준수한 이터레이터를 반환한다. 이터레이터는 next 메소드를 소유하며 next 메소드를 호출하면 이터러블을 순회하며 value와 done 프로퍼티를 갖는 이터레이터 result 객체를 반환한다. 이러한 규약을 이터레이터 프로토콜이라 하며, 이터레이터 프로토콜을 준수한 객체를 이터레이터라 한다.

이터러이터는 이터러블의 요소를 탐색하기 위한 포인터 역할을 한다.

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 in array) { console.log(item); } // 0 1 2 // 이터러블인 배열은 스프레드 문법의 대상으로 사용할 수 있다. 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 iterator console.log(item); } // 이터러블 아닌 일반 객체는 배열 디스트럭처링 할당의 대상으로 사용할 수 없다. const [a, b] = obj// TypeError : obj is not iterator

하지만 일반 객체도 이터러블 프로토콜을 준수하도록 구현하면 이터러블이 된다.

1.2 이터레이터

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

// Symbol.iterator 메소드는 이터레이터를 반환한다. const iterator = array[Symbol.iterator](); // Symbol.iterator 메소드가 반환한 이터레이터는 next 메소드를 갖는다. console.log('next' in iterator); // true

이터레이터의 next 메소드는 이터러블의 각 요소를 순회하기 위한 포인터의 역할을 한다. 즉 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 메소드

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.prototype[Symbol.iterator]

DOM 컬렉션

NodeList.prototype[Symbol.iterator] HTMLCollection.prototype[Symbol.iterator]

3 fo … of 문

for … of 문은 이터러블을 순회하면서 이터러블의 요소를 변수에 할당한다.

for (변수 선언문 of 이터러블){ … }

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

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

for...in

for … in구문은 객체의 속성을 반복할 때 사용됩니다. 객체의 속성을 순회하며, 속성 이름을 가져올 수 있습니다.

const obj = { a: 1, b: 2, c: 3 }; for (const key in obj) { console.log(`${key}: ${obj[key]}`); } // a: 1 b: 2 c: 3

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

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

위 에제 for .. of 문의 내부 동작을 for 문으로 표현하면 다음과 같다.

// 이터러블 const iterable = [1, 2, 3]; // 이터러블의 Symbol.iterator 메소드를 호출하여 이터레이터를 생성한다. const iterator = iterable[Symbol.iterator](); for(;;){ // 이터레이터는 next 메소드를 호출하여 이터러블을 순회한다. // 이때 next 메소드는 이터레이터 리절트 객체를 반환한다. const res = iterator.next(); // next 메소드가 반환한 이터레이터 리절트 객체의 done 프로퍼티 값이 true이면 순회를 중단. if (res.done) break; // 이터레이터 리절트 객체의 value 프로퍼티 값을 item 변수에 할당한다. const item = res.value; console.log(item); // 1 2 3 }

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

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

// 유사 배열 객체 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 문으로 순회할 수 없다.

// 유사 배열 객체는 이터러블이 아니기 때문에 for ... of 문으로 순회할 수 없다. for(const item of arrayLike){ console.log(item) ; // 1 2 3 } // TypeError : arrayLike is not iterable

단 arguments, NodeList, HTMLCollection은 유사 배열 객체이면서 이터러블이다. 이들은 length 프로퍼티를 가지며 인덱스로 접근할 수 없다.

배열도 마찬가지로 Symbol.iterator 메소드를 구현하여 이터러블이 되었다. 하지만 모든 유사 배열 객체가 이터러블인 것은 아니다. 다만 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]

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

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

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

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

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

Untitled

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]; // 이터레이터 리절트 객체를 반환한다. return {value : cur, done: cur >= max}; } }; } }; // 이터러블인 fibonacci 객체를 순회할 때마다 next 메소드가 호출된다. for (const num of fibonacci){ console.log(num); // 1 2 3 5 8 }

사용자 정의 이터러블은 이터레이션 프로토콜을 준수하도록 Symbol.iterator 메소드를 구현하고 Symbol.iterator 메소드가 next 메소드를 갖는 이터레이터를 반환하도록 한다. 이후 next 메소드는 value와 done 프로퍼티를 가지는 이터레이터 리절트 객체를 반환한다. for … of 문은 done 프로퍼티가 true 가 될 때까지 반복하며 done 프로퍼티가 true가 되면 반복을 중지한다.

이터러블은 for…of 문뿐이 아니라 스프레드 문법, 배열 디스트럭처링 할당에도 사용할 수 있다.

// 이터러블 스프레드 문법의 대상이 될 수 있다. 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 이터러블을 생성하는 함수

앞에서 살펴본 fibonacci 이터러블은 내부에 수열의 최대값 max를 가지고 있다. 이 수열의 최대값은 고정된 값으로 외부에서 전달한 값으로 변경할 방법이 없다는 아쉬움이 있다.

// 피보나치 수열을 구현한 사용자 정의 이터러블을 반환한 함수 // 수열의 최대값을 인수로 전달받는다. const fibonacciFunc = function (max){ let [per, cur] = [0, 1]; // Symbol.iterator 메소드를 구현한 이터러블을 반환한다. 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); // 이터러블의 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 }

이터러블이면서 이터레이터인 객체를 생성하면 Symbol.iterator 메소드를 호출하지 않아도 된다. 다음 객체는 Symbol.iterator 메소드와 next 메소드를 소유한 이터러블이면서 이터레이터이다. Symbol.iterator 메소드는 this를 반환하므로 next 메소드를 갖는 이터레이터를 반환한다.

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

앞서 살펴본 fibonacciGenerator 함수를 이터러블이면서 이터레이터인 객체를 생성하여 반환하는 함수로 변경해보자

// 이터러블이면서 이터레이터인 객체를 반환하는 함수 const fibonacciGenerator = 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 = fibonacciGenerator(10); // iter는 이터러블이므로 for ... of 문으로 순회할 수 있다. for (const num of iter) { console.log(num); // 1 2 3 5 8 } // iter는 이터러블이면서 이터레이터다. iter = fibonacciGenerator(10); // iter는 이터레이터이므로 이터레이션 리절트 객체를 반환하는 next 메소드를 소유한다. 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: 5, done: false } console.log(iter.next()); // { value: 8, done: false } console.log(iter.next()); // { value: 13, done: true }

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

무한 이터러블을 생성하는 함수를 정의해보자. 이를 통해 무한 수열을 간단히 구현 할 수 있다.

// 이터러블이면서 이터레이터인 객체를 반환하는 함수 const fibonacciGenerator = 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 }; }, }; }; // fibonacciGenerator 함수는 무한 이터러블을 생성한다. for (const num of fibonacciGenerator()) { if (num > 10000) break; console.log(num); // 1 2 3 5 8 ... 4181 6765 } // 배열 디스트럭처링 할당을 통해 무한 이터러블에서 3개의 요소만 취득한다. const [f1, f2, f3] = fibonacciGenerator(); console.log(f1, f2, f3); // 1 2 3

이터레이션 프로토콜의 필요성에서 보았듯이 이터러블은 데이터 공급자의 역할을 한다. 이터러블은 기존의 변수들과 달리 지연 평가를 통해 데이터를 생성한다. 지연 평가는 데이터가 필요한 시점 이전까지는 미리 데이터를 생성하지 않다가 필요한 시점에서 생성하는 기법이다.

위 예제의 fibonacciGenerator 함수는 무한 이터러블을 사용한다 하지만 호출이 되기 이전까진 데이터를 생성하지 않는다. for … of 문이나 배열 디스트럭 처링 할당 등이 실행되기 이전까지 데이터를 생성하지 않는다. 순회 할 때 next 메소드가 호출할때 이때 데이터가 생성이 된다.

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

지연 평가의 단점

  1. 디버깅이 어려울 수 있다. 코드가 실행되는 시점을 늦춰 실행하기에 버그를 찾는게 느릴수 있습니다.

  2. 메모리 사용량이 증가할 수 있습니다. 계산이 필요할 때까지 값을 저장해야 하므로 메모리를 더 사용할 수 있습니다. 따라서 값이 필요한 경우에만 실행을 해야합니다.

  3. 코드의 가독성을 떨어트릴수 있습니다. 나중에 실행이 되기때문에 실행 흐름을 이해하기 어렵게 만들 수 있습니다.

Last modified: 08 January 2025