[ 모던 자바스크립트 ] 34. 이터러블

1) 이터레이션 프로토콜

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

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

 

◾ 이터러블 프로토콜

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

 

◾ 이터레이터 프로토콜

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

 

 

이터러블

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

// 이터러블인지 확인하는 함수
const isIterable = v => v !== null && typeof v[Symbol.iterator] === 'function';

isIterable([]);          // -> true
isIterable('');          // -> true
isIterable(new Map());   // -> true
isIterable(new Set());   // -> true
isIterable({});          // -> false

 

 

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

const array = [1, 2, 3];

// Symbol.iterator 메서드를 상속 받음
console.log(Symbol.iterator in array);   // true

// for ... of 문으로 순회 가능
for (const item of array) {
	console.log(item);   // 1 2 3
}

// 스프레드 문법의 대상으로 사용 가능
console.log([...array]);   // [1, 2, 3]

// 디스트럭처링 할당의 대상으로 사용 가능
const [a, ...rest] = array;
console.log(a, rest);   // 1, [2, 3]

 

일반 객체는 이터러블 프로토콜을 준수한 이터러블이 아니다. 따라서 일반 객체는 for … of 문으로 순회할 수 없으며 스프레드 문법과 배열 디스트럭처링 할당의 대상으로 사용할 수 없다.

 

😎 for ... of 문은 이터러블 객체만 순회 가능하지만, for ... in 문의 경우 열거형 속성을 가진 객체는 모두 순회가 가능하다. 즉, 일반 객체 또한 for ... in 문을 통한 순회는 가능하다.  

 

단, 스프레드 프로퍼티 제안(stage 4)은 일반 객체에 스프레드 문법의 사용을 허용한다.

GitHub - tc39/proposal-object-rest-spread: Rest/Spread Properties for ECMAScript

const obj = { a: 1, b: 2 };
console.log({...obj});   // {a: 1, b: 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 프로퍼티는 이터러벌의 순회 완료 여부를 나타낸다.

 

 

😎 이터러블 표식을 없애면 순회가 불가능하다. 

let arr = [1, 2, 3];
for (const a of arr) console.log(a); // 정상작동 1,2,3
console.log(arr[Symbol.iterator]); // [Function: values]

arr[Symbol.iterator] = null; // 이렇게 하면 순회가 되지 않는다
for (const a of arr) console.log(a); // Uncaught TypeError: arr is not iterable

 

---

 

3) for … of 문

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

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

 

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

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

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

 

---

 

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

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

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

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

for (const item of arrayLike) {
	console.log(item);
}   
// -> TypeError: arrayLike is not iterable

 

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

ES6에서 도입된 Array.from 메서드를 통해 유사 배열 객체를 배열로 간단히 변환할 수 있다.

 

---

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

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

 

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

다양한 데이터 공급자가 이터레이션 프로토콜을 준수하도록 규정하면 데이터 소비자는 이터레이션 프로토콜만 지원하도록 구현하면 된다.

 

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

 

---

6) 사용자 정의 이터러블

사용자 정의 이터러블 구현

이터레이션 프로토콜을 준수하지 않는 일반 객체도 이터레이션 프로토콜을 준수하도록 구현하면 사용자 정의 이터러블이 된다.

const fibonacci = {
	// Symbol.iterator 메서드를 구현하여 이터러블 프로토콜을 준수한다.
	[Symbol.iterator]() {
		let [pre, cur] = [0, 1];
		const max = 10;

		// Symbol.iterator 메서드는 next 메서드를 소유한 이터레이터를 반환해야 하고
		// next 메서드는 이터레이트 리절트 객체를 반환해야 한다.
		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
}

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

 

 

이터러블을 생성하는 함수

수열의 최대값을 외부에서 전달할 수 있도록 수정

const fibonacci = function (max) {
	let [pre, cur] = [0, 1];

	// Symbol.iterator 메서드를 구현한 이터러블을 반환한다.
	return {
		[Symbol.iterator]() {
			return {
				next() {
					[pre,cur] = [cur, pre + cur];
					return { value: cur, done: cur >= max };
				}
			};
		}
	};
};

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

 

 

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

앞서 살펴본 함수는 이터레이터를 생성하기 위해 이터러블의 Symbol.iterator 메서드를 호출해야 한다.

이터러블이면서 이터레이터인 객체를 생성하면 Symbol.iterator 메서드를 호출하지 않아도 된다.

{
	[Symbol.iterator]() { return this; },
	next() {
		return { value: any, done: boolean };
	}
}

const fibonacciFunc = function (max) {
	let [pre, cur] = [0, 1];

	// Symbol.iterator 메서드를 구현한 이터러블을 반환한다.
	return {
		[Symbol.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
}

iter = fibonacciFunc(10);

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

 

 

무한 이터러블과 지연 평가

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 > 1000) break;
	console.log(num);   // 1 2 3 5 8 ... 610 987
}

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

위의 이터러블은 지연 평가를 통해 데이터를 생성한다.

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

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

 

 

---

출처: 이웅모, 『모던 자바스크립트 Deep Dive』 - 위키북스