ES6 Symbol

411 阅读5分钟

背景

ES6 引入了一种新的基本数据类型 Symbol,表示独一无二的值。它是 JavaScript 语言的第七种数据类型,前 6 种是:Undefined、Null、布尔值(Boolean)、字符串(String)、数值(Number)、对象(Object)。先来两个 Doc 地址,Symbol 说明Symbol 文档。这两个地址可以详细查看介绍和方法等,有些是英文哦,不少我就看不懂。

Symbol(a primitive value)

symbol 值需要通过 Symbol()函数会返回,该类型具有静态属性和静态方法。它的静态属性会暴露几个内建的成员对象;它的静态方法会暴露全局的 symbol 注册,且类似于内建对象类,这就是说,对象的属性名现在可以有两种类型,一种是原来就有的字符串,另一种就是新增的 Symbol 类型。凡是属性名属于 Symbol 类型,就都是独一无二的,可以保证不会与其他属性名产生冲突。,所以通过 Symbol()函数返回的值是不相等的。 但作为构造函数来说它并不完整,刚才讲到 Symbol 是一个原始类型的值,不是对象,所以它不支持语法:"new Symbol()"。下面看一组示例:

Symbol示例

然后贴上阮一峰大神关于 Symbol的讲解,本文很多都是参照和 copy,然后加上个人实验,想详细了解,可以查看大神的讲解。

Symbol 的特性

  1. 返回值的数据类型是 symbol,不能 new。

    let s = Symbol();
    typeof s; // "symbol"
    
  2. Symbol()函数不能 new,可以接收一个字符串作为参数,表示对 Symbol 实例的描述,主要是为了在控制台显示,或者转为字符串时,比较容易区分。

    const symbol1 = Symbol("yangchao1");
    const symbol2 = Symbol("yangchao2");
    
    console.log(symbol1, symbol2); //Symbol(yangchao1) Symbol(yangchao2)
    
    console.log(symbol1.toString(), symbol2.toString()); //Symbol(yangchao1) Symbol(yangchao2)
    

    上面代码中,s1 和 s2 是两个 Symbol 值。如果不加参数,它们在控制台的输出都是 Symbol(),不利于区分。有了参数以后,就等于为它们加上了描述,输出的时候就能够分清,到底是哪一个值。

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

    const obj = {
      toString() {
        return "abc";
      }
    };
    const sym = Symbol(obj);
    sym; // Symbol(abc)
    
  3. Symbol()函数只是表示对当前 Symbol 值的描述,因此相同参数的 Symbol 函数的返回值是不相等的。

    //无参
    Symbol() === Symbol(); //false
    //有参
    Symbol("yangchao") === Symbol("yangchao"); //false
    
  4. Symbol 值不能与其他类型的值进行运算,可以转换成字符串,也可以转换成布尔值,但是不能转为数值。

    Symbol示例

  5. 作为属性名的 Symbol 由于每一个 Symbol 值都是不相等的,这意味着 Symbol 值可以作为标识符,用于对象的属性名,就能保证不会出现同名的属性。这对于一个对象由多个模块构成的情况非常有用,能防止某一个键被不小心改写或覆盖。

    let mySymbol = Symbol();
    
    // 第一种写法
    let a = {};
    a[mySymbol] = "Hello!";
    
    // 第二种写法
    let a = {
      [mySymbol]: "Hello!"
    };
    
    // 第三种写法
    let a = {};
    Object.defineProperty(a, mySymbol, { value: "Hello!" });
    
    // 以上写法都得到同样结果
    a[mySymbol]; // "Hello!"
    

    上面代码中,sym 的描述就是字符串 foo。 但是,读取这个描述需要将 Symbol 显式转为字符串,即下面的写法。

    const sym = Symbol("foo");
    
    String(sym); // "Symbol(foo)"
    sym.toString(); // "Symbol(foo)"
    

    上面代码通过方括号结构和 Object.defineProperty,将对象的属性名指定为一个 Symbol 值。

    注意,Symbol 值作为对象属性名时,不能用点运算符。

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

    上面代码中,因为点运算符后面总是字符串,所以不会读取 mySymbol 作为标识名所指代的那个值,导致 a 的属性名实际上是一个字符串,而不是一个 Symbol 值。

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

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

    上面代码中,如果 s 不放在方括号中,该属性的键名就是字符串 s,而不是 s 所代表的那个 Symbol 值。 采用增强的对象写法,上面代码的 obj 对象可以写得更简洁一些。

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

    Symbol 类型还可以用于定义一组常量,保证这组常量的值都是不相等的。常量使用 Symbol 值最大的好处,就是其他任何值都不可能有相同的值了,因此可以保证上面的 switch 语句会按设计的方式工作。还有一点需要注意,Symbol 值作为属性名时,该属性还是公开属性,不是私有属性。

Symbol 的基础使用

  1. 创建 Symbol 的时候,可以添加一个描述。

    const sym = Symbol("foo");
    

    上面的用法不是很方便。ES2019 提供了一个实例属性 description,直接返回 Symbol 的描述。

    const sym = Symbol("foo");
    
    sym.description; // "foo"
    
  2. 实例:消除魔术字符串

    魔术字符串指的是,在代码之中多次出现、与代码形成强耦合的某一个具体的字符串或者数值。风格良好的代码,应该尽量消除魔术字符串,改由含义清晰的变量代替。

    function getArea(shape, options) {
      let area = 0;
      switch (shape) {
        case "Triangle": // 魔术字符串
          area = 0.5 * options.width * options.height;
          break;
        /* ... more code ... */
      }
    
      return area;
    }
    
    getArea("Triangle", { width: 100, height: 100 }); // 魔术字符串
    

    上面代码中,字符串 Triangle 就是一个魔术字符串。它多次出现,与代码形成“强耦合”,不利于将来的修改和维护。

    常用的消除魔术字符串的方法,就是把它写成一个变量。

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

    上面代码中,我们把 Triangle 写成 shapeType 对象的 triangle 属性,这样就消除了强耦合。

    如果仔细分析,可以发现 shapeType.triangle 等于哪个值并不重要,只要确保不会跟其他 shapeType 属性的值冲突即可。因此,这里就很适合改用 Symbol 值。

    const shapeType = {
      triangle: Symbol()
    };
    

    上面代码中,除了将 shapeType.triangle 的值设为一个 Symbol,其他地方都不用修改。

总结

Symbol 内容比较多,本文暂时就讲到这里,下一篇继续讲 Symbol 的基础方法和使用。地址: ES6-Symbol-2