[ 모던 자바스크립트 ] 33. 7번째 데이터 타입 Symbol (+enum)

1) 심벌이란?

심벌은 ES6에서 도입된 7번째 데이터 타입으로 변경 불가능한 원시 타입의 값이다.

심벌 값은 다른 값과 중복되지 않는 유일무이한 값이다. 따라서 주로 이름의 충돌 위험이 없는 유일한 프로퍼티 키를 만들기 위해 사용한다.

 

---

 

2) 심벌 값의 생성

Symbol 함수

심벌 값은 Symbol 함수를 호출하여 생성한다. (리터럴 X)

이때 생성된 심벌 값은 외부로 노출되지 않아 확인할 수 없으며, 다른 값과 절대 중복되지 않는 유일무이한 값이다.

new 연산자와 함께 호출하지 않는다.

const mySymbol = Symbol();
console.log(typeof mySymbol);   // symbol
console.log(mySymbol);          // Symbol()

 

Symbol 함수에는 선택적으로 문자열을 인수로 전달할 수 있다. 이 문자열을 생성된 심벌 값에 대한 설명으로 디버깅 용도로만 사용되며, 심벌 값 생성에 어떠한 영향도 주지 않는다.

const mySymbol1 = Symbol('mySymbol');
const mySymbol2 = Symbol('mySymbol');
console.log(mySymbol1 === mySymbol2);   // false

 

심벌 값도 문자열, 숫자, 불리언과 같이 객체처럼 접근하면 암묵적으로 래퍼 객체를 생성한다.

const mySymbol = Symbol('mySymbol');
console.log(mySymbol.description);   // mySymbol
console.log(mySymbol.toString());    // Symbol(mySymbol)

 

심벌 값은 암묵적으로 문자열이나 숫자 타입으로 변환되지 않는다.

단, 불리언 타입으로는 암묵적으로 타입 변환된다. 이를 통해 if문 등에서 존재 확인이 가능하다.

const mySymbol = Symbol();

console.log(mySymbol + '');   // TypeError: Cannot convert a Symbol value to a string
console.log(+mySymbol);       // TypeError: Cannot convert a Symbol value to a number

console.log(!!mySymbol);      // true
if (mySymbol) console.log('mySymbol is not empty.');   // mySymbol is not empty.

 

 

Symbol.for / Symbol.keyFor 메서드

전역 심벌 레지스트리

전역 심벌 레지스트리(Global Symbol Registry)는 JavaScript와 ECMAScript 6부터 도입된 심볼(Symbol) 타입과 관련된 기능 중 하나입니다. 심볼은 유일성이 보장된 값으로, 주로 객체의 프로퍼티 키로 사용됩니다. 전역 심볼 레지스트리는 심볼을 전역적으로 공유하고 관리하는 메커니즘을 제공합니다.

전역 심볼 레지스트리에 접근하려면 Symbol.for(key) 메서드를 사용합니다. 이 메서드는 주어진 키(key)로 전역 심볼을 검색하거나 생성합니다. 키에 해당하는 심볼이 이미 존재하면 반환하고, 그렇지 않으면 새로운 전역 심볼을 생성하여 레지스트리에 추가합니다.

이러한 전역 심볼은 서로 다른 부분의 코드에서 동일한 키를 사용하여 동일한 심볼에 접근할 수 있도록 도와줍니다. 이는 모듈 간이나 다양한 부분의 코드에서 공유되는 심볼을 효과적으로 관리할 수 있게 해줍니다.

전역 심볼은 주로 라이브러리, 프레임워크, 또는 여러 모듈 간의 통신에서 고유한 키로 심볼을 공유하고자 할 때 활용됩니다.

 

Symbol.for 메서드는 인수로 전달받은 문자열은 키로 사용하여 키와 심벌 값의 쌍들이 저장되어 있는 전역 심벌 레지스트리에서 해당 키와 일치하는 심벌 값을 검색한다.

• 검색에 성공하면 새로운 심벌 값을 생성하지 않고 검색된 심벌 값을 반환한다.
• 검색에 실패하면 새로운 심벌 값을 생성하여 Symbol.for 메서드의 인수로 전달된 키로 전역 심벌 레지스트리에 저장한 후, 생성된 심벌 값을 반환한다.

// 전역 심벌 레지스트리에 mySymbol이라는 키로 저장된 심벌 값이 없으면 새로운 심벌 값을 생성
const s1 = Symbol.for('mySymbol');
// 전역 심벌 레지스트리에 mySymbol이라는 키로 저장된 심벌 값이 있으면 해당 심벌 값을 반환
const s2 = Symbol.for('mySymbol');

console.log(s1 === s2);   // true

 

Symbol.for 메서드를 사용하면 애플리케이션 전역에서 중복되지 않는 유일무이한 상수인 심벌 값을 단 하나만 생성하여 전역 심벌 레지스트리를 통해 공유할 수 있다.

 

Symbol.keyFor 메서드를 사용하면 전역 심벌 레지스트리에 저장된 심벌 값의 키를 추출할 수 있다.

// 전역 심벌 레지스트리에 mySymbol이라는 키로 저장된 심벌 값이 없으면 새로운 심벌 값을 생성
const s1 = Symbol.for('mySymbol');
Symbol.keyFor(s1);   // -> 'mySymbol'

// Symbol 함수를 호출하여 생성한 심벌 값은 전역 심벌 레지스트리에 등록되어 관리되지 않는다.
const s2 = Symbol('foo');
Symbol.keyFor(s2);   // -> undefined

 

---

 

3) 심벌과 상수

변경/중복될 가능성이 있는 무의미한 상수 대신 중복될 가능성이 없는 유일무이한 심벌 값을 사용할 수 있다.

// 위, 아래, 왼쪽, 오른쪽을 나타내는 상수를 정의한다. 
// 중복될 가능성이 없는 심벌 값으로 상수 값을 생성한다. 
const Direction = {
	UP: Symbol('up'),
	DOWN: Symbol('down'),
	LEFT: Symbol('left'),
	RIGHT: Symbol('right')
};

const myDirection = Direction.UP;

if (myDirection === Direction.UP) {
	console.log('You are going up.');
}

 

🥨 enum

enum은 명명된 숫자 상수의 집합으로 열거형이라고 부른다.

자바스크립트는 enum을 지원하지 않지만 C, 자바, 파이썬 등 여러 프로그래밍 언어와 자바스크립트의 상위 확장인 타입스크립트는 enum을 지원한다.

자바스크립트에서 enum을 흉내 내어 사용하려면 다음과 같이 객체의 변경을 방지하기 위해 객체를 동결하는 Object.freeze 메서드와 심벌 값을 사용한다.

const Direction = Object.freeze({
	UP: Symbol('up'),
	DOWN: Symbol('down'),
	LEFT: Symbol('left'),
	RIGHT: Symbol('right')
});

 

---

 

4) 심벌과 프로퍼티 키

심벌 값은 유일무이한 값이므로 심벌 값으로 프로퍼티 키를 만들면 다른 프로퍼티 키와 절대 충돌하지 않는다.

기존 프로퍼티 키와 충돌하지 않는 것은 물론, 미래에 추가될 어떤 프로퍼티 키와도 충돌할 위험이 없다.

const obj = {
	[Symbol.for('mySymbol')]: 1
};

obj[Symbol.for('mySymbol')];   // -> 1

 

---

5) 심벌과 프로퍼티 은닉

심벌 값을 프로퍼티 키로 사용하여 생성한 프로퍼티는 for … in 문이나 Object.keys, Object.getOwnPropertyNames 메서드로 찾을 수 없다. 이처럼 심벌 값을 프로퍼티 키로 사용하여 프로퍼티를 생성하면 외부에 노출할 필요가 없는 프로퍼티를 은닉할 수 있다.

하지만 ES6에서 도입된 Object.getOwnPropertySymbols 메서드를 사용하면 심벌 값을 프로퍼티 키로 사용하여 생성한 프로퍼티를 찾을 수 있다.

 

---

 

6) 심벌과 표준 빌트인 객체 확장

중복될 가능성이 없는 심벌 값으로 프로퍼티 키를 생성하여 표준 빌트인 객체를 확장하면 표준 빌트인 객체의 기존 프로퍼티 키와 충돌하지 않는 것은 물론, 표준 사양의 버전이 올라감에 따라 추가될지 모르는 어떤 프로퍼티 키와도 충돌할 위험이 없어 안전하게 표준 빌트인 객체를 확장할 수 있다.

 

---

 

7) Well-known Symbol

빌트인 심벌 값은 Symbol 함수의 프로퍼티에 할당되어 있다.

Symbol 함수의 프로퍼티

 

 

자바스크립트가 기본 제공하는 빌트인 심벌 값을 ECMAScript 사양에서는 Well-known Symbol이라 부른다. Well-known Symbol은 자바스크립트 엔진의 내부 알고리즘에 사용된다.

 

예를 들어, for … of 문으로 순회 가능한 빌트인 이터러블은 Well-known Symbol인 Symbol.iterator를 키로 갖는 메서드를 가지며, Symbol.iterator 메서드를 호출하면 이터레이터를 반환하도록 ECMAScript 사양에 규정되어 있다.

 

만약 빌트인 이터러블이 아닌 일반 객체를 이터러블처럼 동작하도록 구현하고 싶다면 Well-known Symbol인 Symbol.iterator를 키로 갖는 메서드를 객체에 추가하고 이터레이터를 반환하도록 구현하면 된다.

const iterable = {
	[Symbol.iterator]() {
		let cur = 1;
		const max = 5;
		return {
			next() {
				return { value: cur++, done: cur > max + 1 };
			}
		};
	}
};

for (const num of iterable) {
	console.log(num);   // 1 2 3 4 5
}

이때 Symbol.iterator는 기존 프로퍼티 키 또는 미래에 추가될 프로퍼티 키와 절대로 중복되지 않을 것이다.

 

이처럼 심볼은 중복되지 않는 상수 값을 생성하는 것은 물론 기존에 작성된 코드에 영향을 주지 않고 새로운 프로퍼티를 추가하기 위해, 즉 하위 호환성을 보장하기 위해 도입되었다.

 

 

---

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