[모던 자바스크립트 Deep Dive] 33장: 7번째 데이터 타입 Symbol

⭐️ 노션에서 보기

심벌(Symbol)이란?

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

심벌 값의 생성

• Symbol 함수를 호출하여 생성

    // Symbol 함수를 호출하여 유일무이한 심벌 값을 생성한다.
    const mySymbol = Symbol();
    console.log(typeof mySymbol); // symbol
  
    // 심벌 값은 외부로 노출되지 않아 확인할 수 없다.
    console.log(mySymbol);        // Symbol()

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

• 선택적으로 디버깅용 설명 문자열을 인수로 전달 가능 (심벌 값 생성에 어떠한 영향도 주지 않음)

    // 심벌 값에 대한 설명이 같더라도 유일무이한 심벌 값을 생성한다.
    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)

• 암묵적 타입 변환

  • 암묵적으로 문자열이나 숫자 타입으로 변환되지 않지만,

  • 불리언 타입으로는 암묵적으로 타입 변환 됨

    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 문 등에서 존재 확인을 위해 사용할 수 있다.
    if (mySymbol) console.log('mySymbol is not empty.');

Symbol.for / Symbol.keyFor 메서드

• 인수로 전달받은 문자열을 키로 사용하여 키와 심벌 값의 쌍들이 저장되어 있는 전역 심벌 레지스트리(global symbol registry)에서 해당 키와 일치하는 심벌 값을 검색

  • 검색 성공 → 새로운 심벌 값 생성 x / 검색된 심벌 값 반환

  • 검색 실패 → 새로운 심벌 값 생성 / 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

심벌과 상수

• AS-IS

// 위, 아래, 왼쪽, 오른쪽을 나타내는 상수를 정의한다.
// 이때 값 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.');
}

• TO-BE

// 위, 아래, 왼쪽, 오른쪽을 나타내는 상수를 정의한다.
// 중복될 가능성이 없는 심벌 값으로 상수 값을 생성한다.
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을 흉내 내어 사용하려면 객체의 변경을 방지하기 위해 객체를 동결하는 Object.freeze 메서드와 심벌 값을 사용

  
    // JavaScript enum
    // 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.');
    }

심벌과 프로퍼티 키

• 심벌 값을 프로퍼티 키로 사용하려면 대괄호 사용 (프로퍼티에 접근할 때도 마찬가지)

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

• 심벌 값으로 프로퍼티 키를 만들면 다른 프로퍼티 키와 절대 충돌하지 않음 (유일무이한 값)

심벌과 프로퍼티 은닉

• 심벌 값을 프로퍼티 키로 사용하여 생성한 프로퍼티는 for…in 문이나 Object.keys, Object.getOwnPropertyNames 메서드로 사용할 수 없음

  → 심벌 값을 이용하면 외부에 노출할 필요가 없는 프로퍼티를 은닉할 수 있음

• 하지만 Object.getOwnPropertySymbols 메서드를 사용하면 찾을 수 있음 (ES6 도입)

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

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

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

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

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

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

• 일반적으로 표준 빌트인 객체에 사용자 정의 메소드를 직접 추가하여 확장하는 것은 권장하지 않음

  • 개발자가 직접 추가한 메서드가 미래에 표준 사양으로 추가될 메서드의 이름이 중복될 수 있기 때문 (해당 경우에는 표준 사양 메서드를 사용자 정의 메서드가 덮어 씀)

    // 표준 빌트인 객체를 확장하는 것은 권장하지 않는다.
    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

Well-known Symbol

• 자바스크립트가 기본 제공하는 빌트인 심벌 값

• 자바스크립트 엔진의 내부 알고리즘에 사용

• eg) Symbol.iterator

  • Well-known Symbol인 Symbol.iterator를 키로 갖는 메서드를 객체에 추가하고 이터레이터를 반환하도록 구현하면 그 객체는 이터러블이 됨

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

  • 이터레이션 프로토콜을 준수하기 위해 일반 객체에 추가해야 하는 메서드의 키 Symbol.iterator는 기존 프로퍼티 키 또는 미래에 추가될 프로퍼티 키와 절대로 중복되지 않을 것임

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