[JavaScript] 심벌이란?

심벌에 대해 알아보자

 

 

[ 심벌 (Symbol) ]

심벌은 ES6에서 도입된 7번째 데이터 타입으로 변경 불가능한 원시 타입의 값이다.

심벌 값은 다른 값과 중복되지 않은 유일무이한 값이기 때문에 이름의 충돌 위험이 없는 유일한 프로퍼티 키를 만들기 위해 사용한다. 

 

1. 다른 값과 중복되지 않는 유일무이한 값
2. 변경 불가능한 원시 타입의 값
3. 주로 이름의 충돌 위험이 없는 유일한 프로퍼티 키를 만들기 위해서 사용

 

 

---

 

 [ 심벌 값 생성 ] 

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

이때 생성된 심벌 값은 외부로 노출되지 않아 확인할 수 없으며, 다른 값과 절대 중복되지 않은 유일무이한 값이다.

 

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

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

 

생성자 함수로 객체를 생성하는 것과 비슷해 보이지만 Symbol 함수는 String, Number, Boolean 생성자 함수와는 달리 new 연산자와 함께 호출하지 않는다. 

 

Symbol 함수에는 선택적으로 문자열을 인수로 전달할 수 있다.

인수로 전달된 문자열은 심벌 값에 대한 설명으로 심벌 값 생성에 어떠한 영향도 주지 않는다. 

 

// 심벌 값에 대한 설명이 같더라도 유일무이한 심벌 값을 생성한다.
const mySymbol1 = Symbol('mySymbol');
const mySymbol2 = Symbol('mySymbol');

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

 

심벌 값은 암묵적으로 문자열이나 숫자 타입으로 변환되지는 않지만, 불리언 타입으로는 암죽적으로 타입 변환이 가능하다. 

 

이를 통해 if 문 등에서 존재 확인이 가능하다. 

 

const mySymbol = Symbol();

// 불리언 타입으로는 암묵적으로 타입 변환된다.
console.log(!!mySymbol); // true

// if 문 등에서 존재 확인을 위해 사용할 수 있다.
if (mySymbol) console.log('mySymbol is not empty.');

 

※ mySymbol이 true이면 비어있지 않는 것이다.

 

[ Symbol.for / Symbol.keyFor 메서드 ] 

 

★ Symbol.for

 

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

 

• 검색에 성공하면 새로운 심벌 값을 생성하지 않고 검색된 심벌 값을 반환한다.
• 검색에 실패하면 새로운 심벌 값을 생성하여 Symbol.for 메서드의 인수로 전달된 키로 전역 심벌 레지스트리에 저장한 후, 생성도니 심벌 값을 반환한다.

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

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

 

 

※ Symbol 함수와 Symbol.for 메서드의 차이

 

Symbol 함수는 호출될 때마다 유일무이한 심벌 값을 생성한다. 이때 자바스크립트 엔진이 관리하는 심벌 값 저장소인 전역 심벌 레지스트리에서 심벌 값을 검색할 수 있는 키를 지정할 수 없으므로 전역 심벌 레지스트리에 등록되어 관리되지 않는다. 

 

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

 

 

즉. Symbol.for 메서드를 사용하면 전역 심벌 레지스트리에 저장된 심벌 값의 키를 추출할 수 있다.

 

// 전역 심벌 레지스트리에 mySymbol이라는 키로 저장된 심벌 값이 없으면 새로운 심벌 값을 생성
const s1 = Symbol.for('mySymbol');
// 전역 심벌 레지스트리에 저장된 심벌 값의 키를 추출
Symbol.keyFor(s1); // -> mySymbol

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

 

[ 심벌과 상수 ]

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

Direction.UP = 0;
Direction.HI = "Hi";

console.log(Direction); // { UP: 0, DOWN: 2, LEFT: 3, RIGHT: 4, HI: 'Hi' }

위의 예제는 위, 아래. 왼쪽, 오른쪽을 나타내는 상수를 정의한 것이다. 

 

Direction에 Hi라는 상수를 추가하면 객체가 변경된다. 

 

위 예제와 같이 값에는 특별한 의미가 없고 상수 이름 자체에 이름이 있는 경우가 있다.

이때 문제는 상수 값 1, 2, 3, 4가 변경될 수 있으며, 다른 변수 값과 중복될 수 있고, 새로운 상수를 추가하면 객체가 변경된다.

 

이런 경우 변경되거나 중복될 가능성이 있는 무의미한 상수 대신 중복될 가능성이 없는 유일무이한 심벌 값을 사용할 수 있다.

 

 

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

const direction = Direction1.UP;

console.log(direction === Direction1.UP); // true

Direction1.HI = "Hi"; // HI는 여전히 추가된다.

console.log( Direction1 ); 

// Direction1 = {
  UP: Symbol(up),
  DOWN: Symbol(down),
  LEFT: Symbol(left),
  RIGHT: Symbol(right),
  HI: 'Hi'
}

 

위 예제의 경우 중복될 가능성이 없는 심벌 값으로 상수 값을 생성한다.

하지만, 여전히 상수를 추가하면 객체가 변경된다. 

 

 

※ enum

enum은 명명된 숫자 상수의 집합으로 열거형(enumerated type)이라고 부른다.

자바스크립트는 enum을 지원하지 않지만, 자바스크립트의 상위 확장인 타입스크립트에서는 enum을 지원한다.

 

자바스크립트에서  enum처럼 객체의 변경을 방지하기 위해서는 객체를 동결하는 Object.freeze 메서드와 심벌 값을 사용한다.

 

const Direction2 = Object.freeze({
  UP: Symbol("up"),
  DOWN : Symbol("down"),
  LEFT : Symbol("left"),
  RIGHT: Symbol("right")
});

Direction2.HI = "Hi"; // HI가 객체에 추가되지 않는다.

console.log( Direction2 );

 

 

출력 결과 :

 

---

 

[ 심벌과 프로퍼티 키 ]

객체의 프로퍼티 키는 빈 문자열을 포함하는 모든 문자열 또는 심벌 값으로 만들 수 있으며, 동적으로 생성할 수도 있다.

 

심벌 값을 프로퍼티 키로 사용하려면 프로퍼티 키로 사용할 심벌 값에 대괄호를 사용해야 한다!!

 

또한, 프로퍼티에 접근할 때도 마찬가지로 대괄호를 사용해야 한다.

 

 

심벌 값은 유일무이한 값이므로 심벌 값으로 프로퍼티 키를 만들면 다른 프로퍼티 키와 절대 충돌하지 않는다. 

 

기존 프로퍼티 키와 충돌하지 않는 것은 물론, 미래에 추가될 어떤 프로퍼티 키와도 충돌할 위험이 없다. 

 

 

---

 

 

[ 심벌과 프로퍼티 은닉 ]

 

심벌 값을 프로퍼티 키로 사용하여 생성한 프로퍼티는 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
};

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

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

# 33-14

```javascript
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