이터러블과 이터레이터
[Archive] 이 글은 2022년에 다른 플랫폼에서 작성한 글을 이전한 것입니다.
내용 중 일부는 현재 기준과 맞지 않을 수 있습니다.
프로토콜
이터레이이션 프로토콜은 ES6에서 도입되었다.
순회가 가능한 데이터 자료구조를 만들기 위해 ECMAScript 사양에 정의해 약속한 규칙.
ES6 이전의 순회 가능한 데이터 자료구조들(배열, 문자열, 유사 배열 객체, DOM 컬렉션)은 통일된 규약 없이 각자 나름의 구조를 가지고 for문, for… in문, forEach 메서드 등을 통해 순회가 가능했다.
하지만 순회 가능한 데이터 자료구조를 이터레이션 프로토콜을 준수하는 이터러블로 통일할 필요가 있음을 느끼고,
ES6에 들어서며 for…of문, 스프레드 문법, 배열 디스트럭처링 할당의 대상으로 사용할 수 있도록 순회 가능 데이터 자료구조들을 일원화했다.
Well-known Symbol인 Symbol.iterator를 프로터피 키로 사용한 메서드를 직접 구현하거나, 프로토타입 체인을 통해 상속받은 Symbol.iterator 메서드를 호출해 이터레이터 프로토콜을 준수한 이터레이터를 반환문을 사용하는 방법이 있다.
사용 이점
데이터 공급자가 각자의 순회방식을 갖는다면 데이터 소비자는 그에 맞는 순회방식을 모두 지원해야 한다.
효율적으로 사용하기 위해, 데이터 공급자가 이터레이션 프로토콜을 준수하도록 만들면 데이터 소비자는 이터레이션 프로토콜만 지원하도록 구현하면 된다.
이터레이션 프로토콜은 데이터 소비자와 데이터 공급자를 연결하는 인터페이스 역할.
사용자 정의 객체의 생성에서, 이터레이션 프로토콜을 준수할 수 있도록 신경쓰며 작성해야 한다.
이터러블
이터러블 프로토콜을 준수하는 객체를 이터러블이라고 한다.
이터러블은 (1)Symbol.iterator를 프로퍼티 키로 사용한 메서드를 직접 구현하거나,
(2)프로토타입 체인을 통해 상속받은 객체를 말한다.
(1) Symbol.iterator를 프로퍼티 키로 사용한 메서드 구현
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
// 사용자 정의 임의 객체 생성
let range = {
from: 1,
to: 5,
};
// 1) for..of 최초 호출 시, Symbol.iterator가 호출됨.
range[Symbol.iterator] = function () {
// 2) 이후 for..of는 반환된 이터레이터 객체만을 대상으로 동작하는데, 이때 다음 값도 정해짐.
return {
current: this.from,
last: this.to,
// 3) for..of 반복문에 의해 반복마다 next()가 호출.
next() {
// 4) next()는 값을 객체 {done:.., value :...}형태로 반환해야 함.
if (this.current <= this.last) {
return { done: false, value: this.current++ };
} else {
return { done: true };
}
},
};
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
const fibonacci = {
[Symbol.iterator]() {
let [pre, cur] = [0, 1];
const max = 10;
return {
next() {
[pre, cur] = [cur, pre + cur];
if (cur >= max) return { done: true };
return { value: cur, done: false };
}
};
},
};
(2) 프로토타입 체인을 통해 상속받은 객체
1
2
3
4
5
6
7
8
9
10
const array = [1, 2, 3];
// Symbol.iterator가 존재.
// array가 빌트인 이터러블 Array의 Array.prototype[Symbol.iterator]를 가져옴.
console.log(Symbol.iterator in array); // true
// for...of문을 사용할 수 있음.
for (const item of array) {
console.log(item); // 1 2 3
}
이터러블 객체에 대해서만 for…of문, 스프레드 문법, 배열 디스트럭처링 할당의 대상으로 사용할 수 있다.
1
2
3
// 스프레드 문법
const arr = [1, 2, 3];
console.log([...arr, 4]); // [1, 2, 3, 4]
1
2
3
4
// 배열 디스트럭처링 할당
const arr = [1, 2, 3];
const [a, b] = arr;
console.log(a, b); // 1 2
2021년 1월 TC39 프로세스 stage 4(Finished)단계에 제안되어있는 스프레드 프로퍼티 제안은 일반 객체에도 스프레드 문법의 사용을 허가한다.
1
2
const obj = { a: 1, b: 2 };
console.log({ ...obj }); // {a: 1, b: 2}
이터레이터
이터러블의 Symbol.iterator 메서드를 호출하면 이터레이터 프로토콜을 준수한 이터레이터를 반환한다.
이터레이터는 next메서드를 소유하며 next메서드를 호출하면 이터러블을 순회하며 value와 done 프로퍼티를 갖는 이터레이터 리절트 객체를 반환한다.
이터레이터 프로토콜을 준수한 객체를 이터레이터라고 한다.
이터레이터는 이터러블의 요소를 탐색하기 위한 포인터 역할을 한다.
iterator도 iterable일 수 있다.
1
2
const it = [1,2][Symbol.iterator]();
it[Symbol.iterator]() === it; // true
이터러블 확인 함수
이터레이터 검사를 통해 이터러블인지 확인하는 함수의 동작을 살펴본다.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
const isIterable = (v) => {
if (v !== null && typeof v[Symbol.iterator] === 'function') {
return true;
}
return false;
};
isIterable([]); // true
isIterable([1, 2]); // true
isIterable(''); // true
isIterable(new Map()); // true
isIterable(new Set()); // true
isIterable({}); // false
isIterable({ a: 1, b: 2 }); // false
기타 - Javascript의 순회 방식 정리
1. 전통적인 for 문
1
2
3
4
5
const arr = ["my", "name", "is", "Lee"];
for (let i = 0; i < arr.length; i++) {
console.log(arr[i]);
}
- 가장 저수준의 반복문
- 인덱스와 값을 모두 직접 제어 가능
- 이터러블 여부와 무관하게 동작
배열뿐 아니라 length를 기준으로 하는 모든 자료구조에 사용할 수 있으며,
성능과 제어 측면에서는 여전히 가장 직접적인 방법이다.
2. for…in 문 – 열거(enumeration)
1
2
3
for (const key in arr) {
console.log(key);
}
for…in은 순회(iteration)가 아니라 객체의 열거 가능한(enumerable) 프로퍼티 키를 나열한다.
- 프로퍼티 키를 문자열로 반환
- 심벌 키는 열거하지 않음
- 프로토타입 체인 상의 enumerable 프로퍼티도 포함될 수 있음
이러한 특성 때문에 배열에 사용하는 것은 일반적으로 권장되지 않는다.
3. for…of 문 – 이터러블 순회
1
2
3
for (const value of arr) {
console.log(value);
}
for…of는 이터러블 객체에 대해 내부적으로 이터레이터의 next() 메서드를 호출하며 순회한다.
- 값(value) 을 직접 반환
- 이터레이션 프로토콜을 준수한 객체만 사용 가능
- 배열, 문자열, Map, Set 등은 기본적으로 이터러블
즉, for…of는 이터러블 추상화 위에서 동작하는 고수준 반복문이다.
4. 유사 배열 객체와 for…of
배열처럼 인덱스와 length를 가진 객체라고 해서 모두 for…of를 사용할 수 있는 것은 아니다.
1
const arrayLike = { 0: "a", 1: "b", length: 2 };
위 객체는 유사 배열이지만 iterable이 아니므로 for…of를 사용할 수 없다.
이 경우 Array.from 등을 통해 이터러블로 변환해야 한다.
1
2
3
for (const v of Array.from(arrayLike)) {
console.log(v);
}