7번째 데이터 타입 Symbol

JunseongLee·2022년 8월 18일

모던 자바스크립트 Deep Dive 스터디

목록 보기

3/7

심벌이란?

자바스크립트에는 String, Number, Boolean, Undefined, Null, Object 6개의 타입이 있었다.
심벌 symbol은 ES6에서 도 입된 7번째 데이터 타입으로 변경 불가능한 원시 타입의 값이다. 심벌 값은 다른 값과 중복되지 않는 값이다. 유일한 프로퍼티 키를 만들기 위해 사용한다.
프로퍼티 키로 사용할 수 있는 값은 빈 문자열을 포함한 모든 문자열 또는 심벌 값이다.

심벌 값의 생성

Symbol 함수

심벌 값은 Symbol 함수를 호출하여 생성한다. 다른 원시값인 String, Number, Boolean, Undefined, Null 타입의 값은 리터럴 표기법을 통해 값을 생성할 수 있지만 심벌 값은 Symbol 함수를 호출하여 생성해야 한다. 이때 생성된 심벌 값은 외부로 노출되지 않아 확인할 수 없으며, 다른 값과 절대 중복되지 않는 값이다.

// Symbol 함수를 호출하여 유일무이한 심벌 값을 생성한다.
const mySymbol = Symbol();
console.log(typeof mySymbol); // symbol

// 심벌 값은 외부로 노출되지 않아 확인할 수 없다.
console.log(mySymbol); // Symbol();

Symbol 함수는 String, Number, Boolean 생성자 함수와 달리 new 연산자와 함께 호출하지 않는다. new 연산자와 함께 생성자 함수 또는 클래스를 호출하면 객체(인스턴스)가 생성되지만 심벌 값은 변경 불가능한 원시 값이다.

new Symbol(); // TypeError: Symbol is not a constructor

Symbol 함수에 선택적으로 전달가능한 문자열은 생성된 심벌 값에 대한 설명으로 디버깅 용도로만 사용되며, 설명이 같더라도 생성된 심벌은 유일한 값이다.

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

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

// 심벌 값도 String, Number, Boolean과 같이 객체처럼 접근하면 암묵적으로 래퍼 객체를 생성한다.
// description 프로퍼티와 toString 메서드는 Symbol.prototype의 프로퍼티다.
console.log(mySymbol.description); // mySymbol
console.log(mySymbol.toString()); // Symbol(mySymbol)

// 심벌 값은 암묵적으로 문자열이나 숫자 타입으로 변환되지 않는다.
consoel.log(mySymbol + "") // TypeError: Cannot convert a Symbol value to a string
console.log(+mySymbol)     // TypeError: Cannot convert a SYmbol value to a string

// Boolean 타입으로는 암묵적으로 타입 변환된다.
console.log(!!mySymbol); // true
// if 문 등에서 존재 확인이 가능하다.
if(mySymbol) console.log("mySymbol is not empty.");

Symbol.for / Symbol.keyFor 메서드

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

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

// 전역 심벌 레지스트리에 저장된 심벌 값의 키를 추출
Symbol.keyFor(s1); // mySymbol

// Symbol 함수를 호출하여 생성한 심벌 값은 전역 심벌 레지스트리에 등록되어 관리되지 않는다.
const s3 = Symbol("foo");
// 전역 심벌 레지스트리에 저장된 심벌 값의 키를 추출
Symbol.keyFor(s3); // undefined

심벌과 상수

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

const myDirection = Direction.UP;

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

// JavaScript enum
const Direction = Object.freeze{
  ...// 후략

심벌과 프로퍼티 키

심벌 값으로 프로퍼티 키를 만들면 다른 프로퍼티 키와 절대 충돌하지 않는다

// 심벌 값으로 프로퍼티 키를 동적 생성
const obj = {
  [Symbol.for("mySymbol")]: 1
};

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

심벌과 프로퍼티 은닉

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

// 심벌 값으로 프로퍼티 키를 생성
const obj = {
  [Symbol("mySymbol")]: 1
};

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

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

// ES6에서 도입된 Object.getOwnPropertySymbols 메서드는 인수로 전달한 객체의 심벌 프로퍼티 키를 배열로 반환한다.
console.log(Object.getOwnPropertySymbols(obj)); // [Symbol(mySymbol)]

// 심벌 값도 찾을 수 있다.
const symbolKey1 = Object.getOwnPropertySymbols(obj)[0];
console.log(obj[symbolKey1]); // 1

Well-known Symbol

자바스크립트가 기본 제공하는 빌트인 심벌 값은 Symbol 함수의 프로퍼티에 할당되어 있고, Well-known Symbol이라 부르며, 자바스크립트 엔진의 내부 알고리즘에 사용된다.
Array, String, Map, Set, TypedArray, arguments, NodeList, HTMLCollection과 같이 for...of문으로 순회 가능한 빌트인 이터러블은 Well-known Symbol인 Symbol.iterator를 키로 갖는 메서드를 가지며, Symbol.iterator 메서드를 호출하면 이터레이터를 반환하도록 ECMAScript 사양에 규정 ( 이터레이션 프로토콜 ) 되어 있다.
빌트인 이터러블이 아닌 일반 객체를 이터러블처럼 동작하도록 구현하려면, 이터레이션 프로토콜을 따르면 된다. Well-known Symbol인 Symbol.iterator를 키로 갖는 메서드를 객체에 추가하고 이터레이터를 반환하도록 구현하면 그 객체는 이터러블이 된다.

// 1~5 범위의 정수로 이루어진 이터러블
const iterable = {
  // Symbol.iterator 메서드를 구현하여 이터러블 프로토콜을 준수
  [Symbol.iterator]() {
    let cur = 1;
    const max = 5;
    // Symbol.itertor 메서드는 next 메서드를 소유한 이터레이터를 반환
    return {
      next() {
        return { value: cur++, done: cur > max + 1 };
      }
    };
  }
};

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