33장 7번째 데이터 타입 Symbol - 모던 자바스크립트 Deepdive

33.1 심벌이란?

ES6에서 도입된 7번째 데이터 타입으로 변경 불가능한 원시 타입의 값이다. 다른 값과 중복되지 않는 유일무이한 값이기 때문에, 주로 이름의 충돌 위험이 없는 유일한 프로퍼티 키를 만들기 위해 사용된다.
🧤 객체 프로퍼티 키로 사용할 수 있는 값은 빈 문자열을 포함하는 모든 문자열 또는 심벌 값이다.

33.2 심벌 값의 생성

1. Symbol 함수

다른 데이터 타입과 다르게(new 생성자 함수와 함께 호출하여 인스턴스 생성가능) 심벌 값은 Symbol함수를 호출하여 생성한다.

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

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

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

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

const mySymbol = Symbol('mySymbol');

// 심벌도 래퍼 객체를 생성한다.
console.log(mySymbol.description); //mySymbol
console.log(mySymbol.toString()); // Symbol(mySymbol)

위 예제의 description 프로퍼티와 toString 메서드는 Symbol.prototype의 프로퍼티다.

3) 심벌 값은 암묵적으로 문자열이나 숫자 타입으로 변환되지 않지만, 불리언 타입으로는 암묵적으로 타입 변환된다.

const mySymbol = Symbol();

if(mySymbol) console.log(~) // true/false 확인이 가능하다.

2. Symbol.for / Symbol.keyFor 메서드

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

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

// 새로 생성
const s1 = Symbol.for('mySymbol');
// 검색하여 값 반환
const s2 = Symbol.for('mySymbol');

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

Symbol 함수는 호출될 때마다 유일무이한 심벌 값을 생성한다. 그런데 이 때 자바스크립트 엔진이 관리하는 심벌 값 저장소인 전역 심벌 레지스트리에서 심벌 값을 검색할 수 있는 키를 지정할 수 없으므로, 전역 심벌 레지스트리에 등록되어 관리되지 않는다. 하지만 Symbol.for 메서드를 사용하면 애플리케이션 전역에서 중복되지 않는 유일무이한 상수인 심벌 값을 단 하나만 생성하여 전역 심벌 레지스트리를 통해 공유할 수 있다.

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

const s1 = Symbol.for('mySymbol');
Symbol.keyFor(s1); // -> mySymbol

//비교
const s2 = Symbol('foo');
Symbol.keyFor(s2); // undefined -> 따로 관리되지 않는다.

33.3 심벌과 상수

예를 들어 4방향, 위/아래/왼/오를 나타내는 상수를 정의한다고 생각해 보자.
값에는 특별한 의미가 없고 상수 이름 자체에 의미가 있는 경우가 있다. 이때 문제는 상수 값 1,2,3,4가 변경될 수 있으며, 다른 변수 값과 중복될 수도 있다는 것이다. 이러한 경우 변경/중복될 가능성이 있는 무읨미한 상수 대신 중복될 가능성이 없는 유일무이한 심벌 값을 사용할 수 있다.

const Direction = {
  UP : 1,
  DOWN : 2,
  LEFT : 3,
  RIGHT: 4,
};

const myDirection = Direction.UP;

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

======================================
  
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은 명명된 숫자 상수(named numeric constant)의 집합으로 열거형(enumerated type)이라고 부른다. 자바스크립트는 enum을 지원 X, C,자바,파이썬 등 여러 프로그램밍 언어와 타입스크립트에서는 지원한다. 자바스크립트에서 enum을 흉내내어 사용하려면 다음과 같이 객체의 변경을 방지하기 위해 객체를 동결하는 Object.freeze메서드와 심벌 값을 사용한다.

//Direction 객체는 불변 객체이며 프로퍼티 값은 유일무이한 값이다.

const Direction = Object.freeze({
  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');
}

33.4 심벌과 프로퍼티 키

심벌 값으로 프로퍼티 키를 동적 생성하여 프로퍼티를 만들어 보자. 이 때, 대괄호를 사용해야 한다.

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

obj[Symbol.for('mySymbol')];

33.5 심벌과 프로퍼티 은닉

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

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

for (const key in obj){
  console.log(key);
}; // 아무것도 출력되지 않음.

console.log(Object.keys(obj)); // []

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

일반적으로 표준 빌트인 객체에 사용자 정의 메서드를 직접 추가하여 확장하는 것은 권장하지 않는다. 표준 빌트인 객체는 읽기 전용으로 사용하는 것이 좋다.

그이유는?
개발자가 직접 추가한 메서드와 미래에 표준 사양으로 추가될 메서드의 이름이 중복될 수 있기 때문이다. 하지만 중복될 가능성이 없는 심벌 값으로 프로퍼티 키를 생성하여 표준 빌트인 객체를 확장하면 표준 빌트인 객체의 기존 프로퍼티 키와 충돌하지 않는 것은 물론, 표준 사양의 버전이 올라감에 따라 추가될지 모르는 어떤 프로퍼티 키와도 충돌할 위험이 없어 안전하게 표준 빌트인 객체를 확장할 수 있다.

// 표준 빌트인 객체를 확장하는 아래와 같은 것은 권장NO!

Array.prototype.sum = function(){
  return this.reduce((acc,cur) => acc+cur,0);
};

[1,2].sum; // 3

===============
  
// 심벌 값 사용 -> 안전하다!
Array.prototype.[Symbol.for('sum')] = function(){
  return this.reduce((acc,cur) => acc+cur,0);
};

[1,2].[Symbol.for('sum')](); // 3
  

33.7 Well-known Symbol

자바스크립트가 기본 제공하는 빌트인 심벌 값이 있다. 빌트인 심벌 값은 Symbol 함수의 프로퍼티에 할당되어 있다. 브라우저 콘솔에서 Symbol 함수를 참조해보자.

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

예를 들어, Array, String, Map, Set, TypedArray, arguments, NodeList, HTMLCollection과 같이 for...of 문으로 순회 가능한 빌트인 이터러블은 Well-know Symbol인 Symbol.iterator를 키로 갖는 메서드를 가지며, Symbol.iterator 메서드를 호출하면 이터레이터를 반환하도록 ECMAScript 사양에 규정되어 있다. 빌트인 이터러블은 이 규정 즉, 이터레이션 프로토콜을 준수한다.