ES6 中的 Symbol

作者: small_zeo | 来源:发表于2021-06-26 23:09 被阅读0次

    ES6 引入了一种新的原始数据类型 Symbol ,表示独一无二的值,最大的用法是用来定义对象的唯一属性名。
    ES6 数据类型除了 Number 、 String 、 Boolean 、 Object、 null 和 undefined ,还新增了 Symbol 。

    概念

    Symbol 函数栈不能用 new 命令,因为 Symbol 是原始数据类型,不是对象。可以接受一个字符串作为参数,为新创建的 Symbol 提供描述,用来显示在控制台或者作为字符串的时候使用,便于区分。

    语法

    直接使用 Symbol() 创建新的 symbol 类型,并用一个可选的字符串作为其描述。

    let sy = Symbol("KK");
    console.log(sy);   // Symbol(KK)
    typeof(sy);        // "symbol"
     
    // 相同参数 Symbol() 返回的值不相等
    let sy1 = Symbol("kk"); 
    sy === sy1;       // false
    

    description (可选) 字符串类型。对symbol的描述,可用于调试但不是访问symbol本身.

    const symbol1 = Symbol();
    const symbol2 = Symbol(42);
    const symbol3 = Symbol('foo');
    
    console.log(typeof symbol1);
    // expected output: "symbol"
    
    console.log(symbol2 === 42);
    // expected output: false
    
    console.log(symbol3.toString());
    // expected output: "Symbol(foo)"
    
    console.log(Symbol('foo') === Symbol('foo'));
    // expected output: false
    

    应用场景

    1. 作为属性名
      由于每一个 Symbol 的值都是不相等的,所以 Symbol 作为对象的属性名,可以保证属性不重名。
    let sy = Symbol("key1");
     
    // 写法1
    let syObject = {};
    syObject[sy] = "kk";
    console.log(syObject);    // {Symbol(key1): "kk"}
     
    // 写法2
    let syObject = {
      [sy]: "kk"
    };
    console.log(syObject);    // {Symbol(key1): "kk"}
     
    // 写法3
    let syObject = {};
    Object.defineProperty(syObject, sy, {value: "kk"});
    console.log(syObject);   // {Symbol(key1): "kk"}
    

    JavaScript 内置了一个 symbol ,那就是 ES6 中的 Symbol.iterator。拥有 Symbol.iterator 函数的对象被称为 可迭代对象 ,就是说你可以在对象上使用 for/of 循环。
    由于任何两个 symbol 都是不相等的,在 JavaScript 里可以很方便地用来模拟私有属性。symbol` 不会出现在 Object.keys() 的结果中,因此除非你明确地 export 一个 symbol,或者用 Object.getOwnPropertySymbols() 函数获取,否则其他代码无法访问这个属性。

    function getObj() {
        const symbol = Symbol('test');
        const obj = {};
        obj[symbol] = 'test';
        return obj;
    }
    
    const obj = getObj();
    
    Object.keys(obj); // []
    
    // 除非有这个 symbol 的引用,否则无法访问该属性
    obj[Symbol('test')]; // undefined
    
    // 用 getOwnPropertySymbols() 依然可以拿到 symbol 的引用
    const [symbol] = Object.getOwnPropertySymbols(obj);
    obj[symbol]; // 'test'
    

    symbol 不会出现在 JSON.stringify() 的结果里

    const symbol = Symbol('test');
    const obj = { [symbol]: 'test', test: symbol };
    
    JSON.stringify(obj); // "{}"
    
    1. 定义常量
      Symbol 的值是唯一的,所以不会出现相同值得常量,即可以保证 switch 按照代码预想的方式执行。
    const COLOR_RED = Symbol("red");
    const COLOR_YELLOW = Symbol("yellow");
    const COLOR_BLUE = Symbol("blue");
     
    function ColorException(message) {
       this.message = message;
       this.name = "ColorException";
    }
    function getConstantName(color) {
        switch (color) {
            case COLOR_RED :
                return "COLOR_RED";
            case COLOR_YELLOW :
                return "COLOR_YELLOW ";
            case COLOR_BLUE:
                return "COLOR_BLUE";
            default:
                throw new ColorException("Can't find this color");
        }
    }
     
    try {
       
       var color = "green"; // green 引发异常
       var colorName = getConstantName(color);
    } catch (e) {
       var colorName = "unknown";
       console.log(e.message, e.name); // 传递异常对象到错误处理
    }
    

    相关文章

      网友评论

        本文标题:ES6 中的 Symbol

        本文链接:https://www.haomeiwen.com/subject/gtktultx.html