33장 7번째 데이터 타입 Symbol

심벌이란

ES6 이전까지 자바스크립트에는 string, number, boolean, undefined, null, object까지 6개의 타입이 있었다.

심벌은 ES6에 도입된 7번째 데이터 타입으로, 변경 불가능한 윈시 타입의 값이다. 심벌 값은 다른 값과 중복되지 않는 유일무이한 값으로, 이름의 충돌 위험이 없는 유일한 프로퍼티 키를 만들기 위해 사용한다.

심벌 값의 생성 및 검색

심벌 값은 Symbol 함수를 호출해 생성한다.

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

// 값을 확인할 수 없다.
console.log(mySymbol); // Symbol()

이 때 생성된 심벌 값은 외부로 노출되지 않아 확인할 수 없고 다른 값과 중복되지 않는다. 이런 특성 때문에 Symbol을 사용하면 JavaScript에서도 private member를 흉내낼 수 있다.

const obj = (() => {
  const _privateMember1 = Symbol('private1');
  const _privateMember2 = Symbol('private1');
  return {
    [_privateMember1]: '외부에서 보이긴 하지만 접근 불가',
    [_privateMember2]: 10,
    publicMember: 20,
    publicMember: 30
  }
})();

console.log(obj); // {publicMember: 30, Symbol(private1): '외부에서 보이긴 하지만 접근 불가', Symbol(private1): 10}
console.log(obj[Symbol('private1')]); // undefined
console.log(obj[_privateMember1]); // ReferenceError: _privateMember1 is not defined

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

const mySymbol1 = Symbol('mySymbol');
const mySymbol2 = Symbol('mySymbol');

console.log(mySymbol1 === mySymbol2); // false
console.log(mySymbol1.description); // mySymbol
console.log(mySymbol2.description); // mySymbol

📚 Symbol.for()

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

검색에 성공하면 검색된 심벌 값을 반환하고, 실패하면 새로운 심벌 값을 생성해 생성한 값을 반환한다.

// 심벌 값을 생성
const s1 = Symbol.for('mySymbol');

// 검색된 심벌 값을 반환
const s2 = Symbol.for('mySymbol');

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

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

📚 Symbol.keyFor()

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

// Symbol.for 호출
const s1 = Symbol.for('mySymbol');
console.log(Symbol.keyFor(s1)); // mySymbol

// Symbol 호출
const s2 = Symbol('foo');
console.log(Symbol.keyFor(s2)); // undefined

Symbol.for 메서드를 사용하면 전역 심벌 레지스트리에 mySymbol이라는 키로 저장된 심벌 값이 없으면 새로운 심벌 값을 생성하지만, Symbol 함수를 호출해 생성된 심벌 값은 전역 심벌 레지스트리에 등록되어 관리되지 않아 Symbol.keyFor(s2);의 값이 undefined가 출력된다.

심벌과 상수

위, 아래, 왼쪽, 오른쪽을 나타내는 상수를 정의하는 예제를 보자.

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

const myDirection = Direction.UP;

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

값에는 특별한 의미가 없고, 상수 이름 자체에 의미가 있는 경우가 있다. 이때 문제는 상수 값 1, 2, 3, 4는 변경될 수 있고 다른 변수 값과 중복될 수도 있다는 것이다.

이러한 경우에 상수 대신 심벌 값을 사용할 수 있다.

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

// ...

심벌과 프로퍼티 키

심벌 값을 프로퍼티 키로 사용하려면 프로퍼티 키로 사용할 심벌 값에 대괄호를 사용해야 한다. 프로퍼티에 접근할 때도 마찬가지다.

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

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

심벌 값으로 프로퍼티 키를 만들면 다른 프로퍼티 키와 절대 충돌하지 않는다. 기존 프로퍼티 키와 충돌하지 않는 것은 물론, 미래에 추가될 어떤 프로퍼티 키와도 충돌할 위험이 없다.

이처럼 심벌은 중복되지 않는 상수 값을 생성하는 것은 물론 기존에 작성된 코드에 영향을 주지 않고 새로운 프로퍼티를 추가하기 위해, 즉 하위 호환성을 보장하기 위해 도입되었다.
또한 심벌은 외부로 노출되지 않는 특성 때문에 JavaScript에서도 심벌을 이용해 private member를 흉내낼 수 있다.

참고: Javascript ES6+ Symbol - 정재남님 강의