【ES6】Symbol

1.概述

你使用了一个他人提供的对象，但又想为这个对象添加新的方法（mixin 模式），新方法的名字就有可能与现有方法产生冲突。

        

let s = Symbol();
typeof s //symbol

let s1 = Symbol('foo')
s1 //Symbol(foo)
s1.toString() // 'Symbol(foo)'

如果 Symbol 的参数是一个对象，就会调用该对象的toString方法，将其转为字符串，然后才生成一个 Symbol 值。

const obj = {
      toString() {
          return "abc";
       }
};
const sym = Symbol(obj);
sym // Symbol(abc)

Symbol函数的参数只是表示对当前 Symbol 值的描述，因此相同参数的Symbol函数的返回值是不相等的

        //没有参数的情况
        let s1 = Symbol();
        let s2 = Symbol();
        s1 === s2 // false

        // 有参数的情况
        let s1 = Symbol('foo');
        let s2 = Symbol('foo');
        s1 === s2 // false

Symbol 值不能与其他类型的值进行运算，会报错。

Symbol 值可以显式转为字符串，也可以转为布尔值，但是不能转为数值。

        let sym = Symbol('My symbol');
        String(sym) // 'Symbol(My symbol)'
        sym.toString() // 'Symbol(My symbol)'
 
        let sym = Symbol();
        Boolean(sym) // true
        !sym  // false
 
        Number(sym) // TypeError
        sym + 2 // TypeError

2.Symbol.prototype.description

        const sym=Symbol('foo')
        sym.description //'foo'

3.作为属性名的Symbol

        let mySymbol = Symbol();
        // 方法1
        let a = {};
        a[mySymbol] = 'Hello!';
        // 方法2
        let a = {
            [mySymbol]: 'Hello!'
        };
        // 方法3
        let a = {};
        Object.defineProperty(a,mySymbol,{value:'hello'})
 

        // 以上写法都得到同样结果
        a[mySymbol] // "Hello!"

注意，Symbol 值作为对象属性名时，不能用点运算符。点运算符后面总是字符串，导致a的属性名实际上是字符串而不是Symbol

        const mySymbol = Symbol();
        const a = {};
        a.mySymbol = 'Hello!';
        a[mySymbol] // undefined
        a['mySymbol'] // "Hello!"

在对象的内部，使用 Symbol 值定义属性时，Symbol 值必须放在方括号之中。

 

       let s = Symbol();
        let obj = {
            [s](arg) { ... }
        };
        obj[s](123);

4.实例：消除魔术字符串

        const shapeType = {
            triangle: 'Triangle'
        };
        function getArea(shape, options) {
        let area = 0;
        switch (shape) {
            case shapeType.triangle:
            area = .5 * options.width * options.height;
            break;
        }
            return area;
        }
        getArea(shapeType.triangle, { width: 100, height: 100 });
 

        const shapeType = {
            triangle: Symbol()
        };

5.属性名的遍历

Symbol作为属性名改属性不会出现在for...in、for...of中，也不会Object.keys、Object.getOwnPropertyNames()、JSON.stringify()返回

可以通过Object.getOwnPropertySymbols(),获取所有Symbol属性名

Reflect.ownKeys方法可以返回所有类型的键名，包括常规键名和 Symbol 键名。

        let obj = {
            [Symbol('my_key')]: 1,
            enum: 2,
            nonEnum: 3
        };
        Reflect.ownKeys(obj)
        //  ["enum", "nonEnum", Symbol(my_key)]

6.Symbol.for()，Symbol.keyFor()

重新使用同一个 Symbol 值，Symbol.for方法可以做到这一点。它接受一个字符串作为参数，然后搜索有没有以该参数作为名称的 Symbol 值。如果有，就返回这个 Symbol 值，否则就新建并返回一个以该字符串为名称的 Symbol 值。

        let s1 = Symbol.for('foo');
        let s2 = Symbol.for('foo');
        s1 === s2  // true

Symbol.keyFor()方法返回一个已登记的 Symbol 类型值的key。

        let s1 = Symbol.for("foo");
        Symbol.keyFor(s1) // "foo"
 
        let s2 = Symbol("foo");
        Symbol.keyFor(s2) // undefined

Symbol.for为 Symbol 值登记的名字，是全局环境，不管有没有在全局环境中运行

 

Symbol其他方法参考：http://es6.ruanyifeng.com/#docs/symbol