0%

Symbol 타입

1.Symbol 이란?

1997년 자바스크립트의 ECAMScript로 처음 표준화된 이래로 자바스크립트에는 6개의 타입 즉 String,Number,boolean,undefined,null,Object가 있었다.

심볼은(symbol)은 es6에서 새롭게 추가된 7번째 타입으로 변경이 불가능한 원시타입이다. 다른 값과 중복되지 않는 유일무이한 값이다. 따라서 주로 이름의 충돌 위험이 없는 유일한 프로퍼티 키를 만들기 위해 사용된다.

객체의 프로퍼티 키로 사용할 수 있는 값은 빈 문자열을 포함한 모든 문자열 또는 심볼값이다.

2.Symbol의 생성

##2.1. Symbol 함수

심볼 값은 Symbol 함수를 호출하여 생성한다. 다른 원시 값은, 즉 문자열,숫자,불리언 ,undefined,null은 타입의 값은 리터럴 표기법을 통해 값을 생성할 수 있지만 심볼값은 심볼을 함수를 호출해야 생성해야한다. 이때 생성된 심볼 값은 노출 되지 않으며 다른 값과 절대 중복 되지 않는 유일무이한 값이다.

1
2
3
4
5
6
//Symbol 함수를 호출하여 유일무이한 심볼값을 생성한다.
const mySymbol = Symbol();

//심볼 값은 노출되지 않는다.
console.log(mySymbol) // Symbol();
console.log(typeof mySymbol) //symbol

언뜻 보면 생성자 함수로 객체를 생성하는 것 처럼 보이지만 Symbol함수는 String, number, Boolean 생성자 함수와는 달리 new 연산자를 사용하지 않는다. new연산자와 함께 생성자 함수 또는 클래스를 호출하면 객체 (인스턴스)가 생성되지만 심볼 값은 변경이 불가능한 원시 값 이다.

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

Symbol 함수에는 선택적으로 문자열을 인수로 전달 할 수 있다. 이 문자열은 생성된 심볼 값에 대한 설명으로 디버깅 용도로만 사용되며 심볼 값 생성에 어떠한 영향을 주지 않는다. 즉 심볼 값에 대한 설명이 같더라도 생성되 값은 유일무이한 값이다.

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

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

심볼 값도 문자열,숫자,불리언과 같이 객체처럼 접근하면 암묵적으로 래퍼 객체를 생성한다. 아래 예제는 description 프로퍼티와 toString 메소드는 Symbol.prototype의 프로퍼티 이다.

1
2
3
4
5
// 심볼도 래퍼 객체를 생성한다.
const mySymbol = Symbol('mySymbol');

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

심볼 값은 암묵적으로 문자열이나 숫자 타입으로 변화되지 않는다.

1
2
3
4
5
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

단 불리언 타입으로는 암묵적으로 타입 변환이 된다. 이를 통해 if문 등에서 존재 확인이 가능하다.

1
2
3
4
5
6
7
const mySymbol = Symbol();

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

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

2.2. Symbol.for 메소드

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

  • 검색에 성공하면 새로운 심볼 값을 생성하지않고 검색된 심볼 값을 반환한다.
  • 검색 실패하면 새로운 심볼값을 생성하여 Symbol.for 메소드의 인수로 전달되는 전역 Symbol 레지스트리에 저장한 후, 생성된 심볼을 반환한다.
  • 1
    2
    3
    4
    5
    //전역 심볼 레지스트리에 mySymbol이라는 키로 저장된 심볼 값이 없으면 새로운 심볼 값을 생성한다.
    const s1 = Symbol.for('mySymbol');
    //전역 심볼 레지스트리에 mySymbol이라는 키로 저장된 심볼 값이 있으면 해당 심볼 값을 반환
    const s2 = Symbol.for(''mySymbol);
    console.log(s1 === s2) //true

    Symbol함수는 호출될때 마다 유일무이한 심볼 값을 생성한다. 이때 자바 스크립트 엔진이 관리하는 심볼 값 저장소인 전역 심볼 레지스트리에서 심볼 값을 검색 할 수 있는 키를 지정 할 수 없으므로 전역 심볼 레지스트리에 등록되어 관리되지않는다.
    하지만 Symbol.for메소드를 사용하면 애플리케이션 전역에서 중복되지않는 유일무이한 상수인 심볼 값을 단 하나만 생성하여 전역 심볼의 레지스크리를 통해 공유 할 수 있다.
    Symbol.keyFor 메소드를 사용하면 전역 심볼 레지스트리에 저장된 심볼 값의 키를 추출할 수 있다.

    1
    2
    3
    4
    //전역 심볼을 레지슽크리에 mySymbol이라는 키로 심볼 값이 없으면 새로운 심볼 값을 생성
    const s = Symbol.for('mySymbol');
    //전역 심볼 레지스트리에 저장된 심볼 값의 키를 추출
    console.log(Symbol.keyFor(s)) //mySymbol

    3. Symbol과 상수

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    //위,아래,오른쪽,왼쪽을 나타내는 상수
    //값 1,2,3,4에는 특별한 의미가 없고 상수 이름에 의미가 있다.
    const Direction ={
    UP:1,
    DOWN:2,
    LEFT:3,
    RIGHT:4
    };

    //변숭에 상수를 할당
    const myDirection = Direction.UP;
    if(myDirection === Diretion.UP){
    console.log('You are going up');
    }

    위 예제와 같이 값에는 특별한 의미가 없고 상수이름 자체에 의미가 있는 경우가 있다. 이때 문제는 상수 1,2,3,4가 다른 변수 값과 중복 될 수 있다는 것이다. 이러한 경우 중복될 가능성이 있는 무의미한 상수 대신 중복될 가능성이 없는 유일 무이한 심볼값을 사용 할 수 있다.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    //위,알래,오른쪽,왼쪽을 나태내는 상수.
    //중복될 기능성이 없는 심볼 값으로 상수값을 생성
    const Direction ={
    UP:Symbol('up'),
    DOWN:Symbol('down'),
    LEFT:Symbol('left'),
    RIGHT:Symbol('right')
    };

    //변수에 상수를 할당
    const Direction = Direction.UP;

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

    enum
    enum은 명명된 숫자 상수의 집합으로 열거형이라고 부른다. 자바스크립트는 enum을 지원하지는 않지만 C,Java,Python 등 많은 프로그래밍 언어와 자바 스크립트으 Superset(상위 확장)인 TYpeScript에서 enum을 지원하고 있다. 자바스크립트세서 enum을 흉내내어 사용하려면 아래와 같이 객체의 변경을 방지 하기 위해 객체를 동결 하는 Object.freeze 메소드와 심볼 값을 사용한다.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    //Javascript enum
    //Direction 객체는 불변객체이며 프로퍼티는 유일무이한 값이다.
    const Direction = Object.freeze({
    UP: Symbol('up'),
    DOWN: Symbol('down'),
    LEFT: Symbol('left'),
    RIGHT: Symbol('right')
    });
    //변수에 상수를 할당
    const myDirection = Diection.UP;

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

    4. Symbol과 프로퍼티 키

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

    심볼 값으로 프로퍼티 키를 동적으로 생성하여 만들어 보자. 심볼 값을 프로퍼티 키로 사용하려면 프로퍼티 키를 사용할 심볼 값에 대괄호를 사용해야한다. 프로퍼티에 접근 할때도 마찬가지로 대괄호를 사용해야한다.

    1
    2
    3
    4
    5
    const obj={
    //심볼 값으로 프로퍼티 키를 동적 생성
    [Symbol.for('mySymbol')]:1
    };
    console.log(obj[Symbol.for('mySymbol')]) //1

    심볼 값은 유일무이한 값이므로 심볼 값으로 프로퍼티 키를 만들면 다른 프로퍼티 키와 절대 충돌하지않는다. 기존 프로퍼티 키와 충돌하지않는 것은 물론,미래에 추가될 어떤 프로퍼티 키와도 충돌할 위험이 없다.

    5. Symbol과 프로퍼티 은닉

    심볼 값으로 동적으로 프로퍼티 키로 만든 프로퍼티는 for ..in 문이나 Object.keys,Object.getOwnPropertyNames 메소드로 찾을 수 없다. 이처럼 심볼 값을 동적으로 생성한 프로퍼티 키로 프로퍼티를 만들면 프로퍼티를 숨길 수 있다.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    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 메소드를 사용하면 심볼값으로 동적 생성한 프로퍼티 키로 만든 프로퍼티를 찾을 수있다.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    const obj ={
    //심볼 값으로 프로퍼티 키 동적 생성
    [Symbol('mySymbol')]:1
    };
    console.log(Object.getOwnPropertySymbols(obj)) //[Symbol(mySymbol)];

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

    6. Symbol 과 표준 빌트인 객체 확장

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

    1
    2
    3
    4
    5
    6
    // 표준 빌트인 객체를 확장하는 것은 권장하지않는다.
    //즉 ,Array.prototype은 읽기 전용으로 사용하는 것의 좋다.
    Array.prototype.sum = function(){
    return this.reduce((p,c)=>p+c,0);
    }
    console.log([1,2].sum()); //3

    그 이유는 개발자가 직접 추가한 메소드는 미래에 표준 사양으로 추가될 메소드가 이름이 중복 될 수있기 때문이다. 예를 들어 Array.prototype.find메소드가 Es6의 새롭게 도입되기 이전에 Array.prototype에 find을 집겁 추가 했다면 새롭게 도입된Es6.find 메소드와 이름이 중복되어 Es6의 Array.prototype.find 와 이름이 중복 되어 Es6의 Array.prototype.find 메소드를 이전에 추가했던 사용자 정의 find 메서드가 덮어 쓴다. 표준 빌트인 메소드를 사용자 정의 메소드가 된다면 문제가 된다.

    하지만 중복될 가능성이 없는 심볼 값으로 프로퍼티 키를 생성하여 표준 빌트린 객체를 확장하면 표준 빌트인 객체의 기존 프로퍼티 키와 충돌 되지 않는 것은 물론 , 버전이 올라감에 따라 추가 될지도 모르는 어떤 프로퍼티 키와도 충돌 될 위험없이 안전하게 표준 빌트인 객체를 확장 할 수 있다.

    1
    2
    3
    4
    5
    //심볼 값으로 프로퍼티 키를 동적 생성하면 다른 프로퍼티 키와 절대 충돌하지않는다.
    Array.prototype[Symbol.for('sum')] = function(){
    return this.reduce((p,c)=>p+c,0);
    };
    console.log([1,2][Symbol.for('sum')]()); //3

    7. Well known Symbol

    자바스크립트가 기본 제공하는 빌트인 심볼 값이 있다. 빌트인 심볼 값은 Symbol 함수의 프로퍼티에 할당되어있다. 브라우저 콘솔에서 Symbol 함수를 참조하여 보자.
    33-1

    자바스크립트가 기본 제공하는 빌트인 심볼 값을 Well-Known-Symbol이라 부른다. Well-Known-Symbol은 자바스크립트 엔진의 내부 알고리즘에 사용된다.

    예를 들어 배열, String객체, arguments 객체와 같이 for..of 문으로 순회가 가능한 빌트인 이터러블은 Well-Known-Symbol인 Symbol.iterator를 키로 갖는 메소드를 가지며, Symbol.iterator메소드를 호출하면 이터레이터를 반환하도록 ECAMAScript 사양에 규정되어 있다. 빌트인 이터러블은 이 규정을 준수하고 있다.

    만약에 빌트인 이터러블이 아닌 일반객체를 이터러블 처럼 동작하도록 구현하고 싶다면 이 규정(이터레이션 프로토콜)을 따르면 된다. 즉 ECMAScript 사양에 규정 되어 있는 대로 Well-Known-Symbol인 Symbol.iterator을 키로 깆는 메소드를 객체에 추가하고 이터레이터를 반환하도록 구현하면 그 객체는 이터러블이 된다.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    //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
    }

    빌트인 이터러블
    이터러블은 for…of문으로 순회할 수 있고 스프레드 문법의 피연산자가 될 수 도 있는 객체를 말한다. 자바스크립트가 기본 제공하는 빌트인 이터러블은 아래와 같다.

    빌트인 이터러블 프로퍼티 키가 Symbol.iterator인 메소드
    Array Array.prototype[Symbol.iterator]
    String String.prototype[Symbol.iterator]
    Map Map.prototype[Symbol.iterator]
    Set Set.prototype[Symbol.iterator]
    TypedArray TypedArray.prototype[Symbol.iterator]
    arguments arguments[Symbol.iterator]
    DOM 컬렉션 NodeList.prototype[Symbol.iterator], HTMLCollection.prototype[Symbol.iterator]

    이때 일반 객체에 추가해야하는 메소드의 키 Symbol.iterator은 기존 프로퍼티 키 또는 미래에 추가될 프로퍼티 키와 절대로 중복되지 않을 것이다.

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