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

Posted Sep 17, 2022

By your_full_name 11 min read

33.1 심벌이란?

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

33.2 심벌 값의 생성

33.2.1 `Symbol` 함수

Symbol 함수를 호출하여 심벌 값 생성

리터럴 표기법 불가
생성된 심벌 값은 외부로 노출되지 않으며 다른 값과 절대 중복되지 않음

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

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

선택적으로 문자열을 인수로 전달 가능

생성된 심벌 값에 대한 설명으로, 디버깅 용도로만 사용
심벌 값 생성에 영향을 주지 않음

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

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

  
  const mySymbol = Symbol();
        
  // 불리언 타입으로는 암묵적으로 타입 변환된다.
  console.log(!!mySymbol); // true
        
  // if 문 등에서 존재 확인을 위해 사용할 수 있다.
  if (mySymbol) console.log('mySymbol is not empty.');

33.2.2 `Symbol.for`/`Symbol.keyFor` 메서드

`Symbol.for` 메서드

인수로 전달받은 문자열을 키로 사용 → 전역 심벌 레지스트리에서 해당 키와 일치하는 심벌 값 검색

검색 성공: 검색된 심벌 값 반환
검색 실패: 새로운 심벌 값을 생성 → 인수로 전달된 키로 전역 심벌 레지스트리에 저장 → 생성된 심벌 값 반환

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

Symbol 함수 호출 시 생성되는 심벌 값 ⇒ 키가 없어 전역 심벌 레지스트리에서 관리되지 않음 Symbol.for 메서드 사용 ⇒ 심벌 값을 생성해 전역 심벌 레지스트리를 통해 공유 가능

`Symbol.keyFor` 메서드

전역 심벌 레지스트리에 저장된 심벌 값의 키 추출 가능

  
  // 전역 심벌 레지스트리에 mySymbol이라는 키로 저장된 심벌 값이 없으면 
  // 새로운 심벌 값을 생성
  const s1 = Symbol.for('mySymbol');
  // 전역 심벌 레지스트리에 저장된 심벌 값의 키를 추출
  Symbol.keyFor(s1); // -> mySymbol
    
  // Symbol 함수를 호출하여 생성한 심벌 값은 
  // 전역 심벌 레지스트리에 등록되어 관리되지 않는다.
  const s2 = Symbol('foo');
  // 전역 심벌 레지스트리에 저장된 심벌 값의 키를 추출
  Symbol.keyFor(s2); // -> undefined

33.3 심벌과 상수

기존의 문제

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

상수 값 1, 2, 3, 4가 변경될 수 있음
다른 변수 값과 중복될 수 있음

심벌을 통한 문제 해결

  
// 위, 아래, 왼쪽, 오른쪽을 나타내는 상수를 정의한다.
// 중복될 가능성이 없는 심벌 값으로 상수 값을 생성한다.
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

명명된 숫자 상수(named numeric constant)의 집합으로, 열거형(enumerated type)이라 부름
C, 자바, 파이썬, 타입스크립트 등에서 지원

심벌을 이용해 enum을 흉내 낼 수 있다.

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

33.4 심벌과 프로퍼티 키

심벌 값에 대괄호를 사용하여 프로퍼티 키로 사용 가능

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

심벌 값으로 프로퍼티 키를 만들면 기존의 키, 미래에 추가될 키와도 충돌할 위험이 없다.

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)); // []
  console.log(Object.getOwnPropertyNames(obj)); // []

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

  
  const obj = {
    // 심벌 값으로 프로퍼티 키를 생성
    [Symbol('mySymbol')]: 1
  };
    
  // getOwnPropertySymbols 메서드는 인수로 전달한 객체의 심벌 프로퍼티 키를 배열로 반환
  console.log(Object.getOwnPropertySymbols(obj)); // [Symbol(mySymbol)]
    
  // getOwnPropertySymbols 메서드로 심벌 값도 찾을 수 있다.
  const symbolKey1 = Object.getOwnPropertySymbols(obj)[0];
  console.log(obj[symbolKey1]); // 1

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

표준 빌트인 객체에 사용자 정의 메서드를 추가하는 것은 권장되지 않음

미래에 표준 사양으로 추가될 메서드 이름이 중복될 수 있기 때문

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

자바스크립트가 기본 제공하는 빌트인 심벌 값
자바스크립트 엔진의 내부 알고리즘에 사용
for...of문으로 순회할 수 있는 빌트인 이터러블이 준수하는 이터레이션 프로토콜
- ECMAScript 사양에 규정
- Well-known Symbol인 Symbol.iterator를 키로 갖는 메서드를 가짐
- 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
  }

book_notes

모던 자바스크립트 Deep Dive

This post is licensed under CC BY 4.0 by the author.