JavaScript - Symbol

Symbol

• ES6에서 도입된 7번째 데이터 타입
• 변경 불가능한 원시 타입의 값
• 주로 이름의 충돌 위험이 없는 유일한 프로퍼티 키를 만들기 위해 사용
  • 기존에 작성된 코드에 영향을 주지 않고 새로운 프로퍼티를 추가할 수 있으므로, 하위 호환성이 보장됨

Symbol 값의 생성

Symbol 함수

• Symbol 함수를 호출하여 심벌 값을 생성함
  • Symbol 함수는 new 연산자와 함께 호출하지 않음
  • Symbol 함수를 호출하면, 유일무이한 심벌 값을 생성함
  • 이 때 생성한 심벌 값은 외부로 노출되지 않아 확인할 수 없음

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

// 심벌 값은 외부로 노출되지 않아 확인 X
console.log(mySymbol); // Symbol()
// Symbol 함수는 new 연산자와 함께 호출 X
new Symbol(); // TypeError: Symbol is not a constructor

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

const mySumbol1 = Symbol('mySymbol');
const mySumbol2 = Symbol('mySymbol');

console.log(mySumbol1 === mySumbol2); // false

• 심벌 값을 객체처럼 접근하면(마침표 연산자) 암묵적으로 래퍼 객체를 생성함
  • Symbol.prototype의 프로퍼티
    • Symbol.prototype.description
    • Symbol.prototype.toString

const mySymbol = Symbol('mySymbol');

console.log(mySymbol.description); // mySymbol
console.log(mySymbol.toString()); // Symbol(mySymbol);

• 심벌 값의 타입 변환
  • 암묵적으로 문자열이나 숫자 타입으로 변환되지 않음
  • 암묵적으로 불리언 타입으로 타입 변환됨

const mySymbol = Symbol();

// TypeError: Cannot convert a Symbol value to a string
console.log(mySymbol + '');
// TypeError: Cannot convert a Symbol value to a number
console.log(+mySymbol);

console.log(!!mySymbol); // true

Static Methods of Symbol

• Symbol.for(key)
  • 인수로 전달 받은 문자열을 키로 사용하여 키와 심벌 값의 쌍들이 저장되어 있는 전역 심벌 레지스트리에 해당 키와 일치하는 심벌 값을 검색함
    • 검색에 성공하면, 새로운 심벌 값을 생성하지 않고 검색된 심벌 값을 반환함
    • 검색에 실패하면, 새로운 심벌 값을 생성하여 인수로 전달받은 문자열을 키로 전역 심벌 레지스트리에 저장한 후 생성된 심벌 값을 반환함

// 전역 레지스트리에 mySymbol 키로 새로운 심벌 값 생성
const s1 = Symbol.for('mySymbol');
// 전역 레지스트리에 mySymbol 키로 저장된 심벌 값 반환
const s2 = Symbol.for('mySymbol');

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

• Symbol 함수를 호출할 때마다 유일무이한 심벌 값을 생성함

  • 이때 전역 심벌 레지스트리에서 심벌 값을 검색할 키를 지정할 수 없으므로 전역 심벌 레지스트리에 등록되어 관리되지 않음

• 반면에, Symbol.for 메서드를 사용하면 전역에서 중복되지 않는 유일무이한 심벌 값을 단 하나만 생성하여 전역 레지스트리를 통해 공유할 수 있음

• Symbol.keyFor(Symbol)

  • 전역 심벌 레지스트리에 저장된 심벌 값의 키를 추출함

// Symbol.for 메서드를 호출하여 새로 생성된 심벌 값은 전역 심벌 레지스트리에 등록 O
const s1 = Symbol.for('mySymbol');
Symbol.keyFor(s1); // mySymbol

const s2 = Symbol('foo');
// Symbol 함수를 호출하여 생성한 심벌 값은 전역 심벌 레지스트리에 등록 X
Symbol.keyFor(s2); // undefined

Symbol 활용

Symbol과 상수

• 변경/중복될 가능성이 있는 무의미한 상수 대신 중복될 가능성이 없는 유일무이한 심벌 값을 사용할 수 있음

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

Symbol과 프로퍼티 키

• 객체의 프로퍼티 키

  • 빈 문자열을 포함한 모든 문자열로 만들 수 있음
  • 심벌 값으로 만들 수 있음
  • 동적으로 생성할 수 있음

• 심벌 값을 프로퍼티 키로 사용할 때,

  • 프로퍼티 키로 사용할 심벌 값에 대괄호를 사용해야 함
  • 프로퍼티에 접근할 때도 대괄호를 사용해야 함
  • 다른 프로퍼티 키와 절대 충돌하지 않음

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

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

Symbol과 프로퍼티 은닉

• 심벌 값을 프로퍼티 키로 사용하여 생성한 프로퍼티는 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(obs)); // [Symbol(mySymbol)]

Symbol과 표준 빌트인 객체 확장

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

  • 이유: 개발자가 직접 추가한 메서드와 미래에 표준 사양으로 추가될 메서드의 이름이 중복될 수 있기 때문임
    • 중복될 경우, 표준 빌트인 메서드를 사용자 정의 메서드가 덮어써서 문제가 됨

• 심벌 값으로 프로퍼티 키를 생성하여 표준 빌트인 객체를 안전하게 확장할 수 있음

  • 표준 빌트인 객체의 기존 프로퍼티와 충돌하지 않음
  • 미래에 표준 사양으로 추가될지 모르는 어떤 프로퍼티 기와도 충돌할 위험이 없음

Array.prototype[Symbol.for('sum')] = function () {
  return this.reduce((acc, cur) => acc + cur, 0);
}
[1, 2][Symbol.for('sum')](); // 3

Well-known Symbol

• JavaScript가 기본 제공하는 빌트인 심벌 값
• JavaScript 엔정의 내부 알고리즘에 사용됨
  • 예) Array, String, Map, Set, TypedArray, arguments, NodeList, HTMLCollection과 같은 빌트인 이터러블은 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
}