Symbol

ES5 的对象属性名都是字符串，这容易造成属性名的冲突。如在对象中添加一个方法，这个方法名有可能导致重名，引起冲突

ES6 引入了一种新的原始数据类型 Symbol，表示独一无二的值。它是 JavaScript 语言的第七种数据类型

对象的属性名现在可以有两种类型，一种是原来就有的字符串，另一种就是新增的 Symbol 类型。凡是属性名属于 Symbol 类型，就都是独一无二的，可以保证不会与其他属性名产生冲突

基本使用#

声明方式:

1
    let s = Symbol()
2
    console.log(s, typeof s) // Symbol() 'symbol'

Symbol 函数前不能使用 new 命令，否则会报错。这是因为生成的 Symbol 是一个原始类型的值，不是对象。也就是说，由于 Symbol 值不是对象，所以不能添加属性。基本上，它是一种类似于字符串的数据类型

Symbol函数可以接受一个字符串作为参数，表示对 Symbol 实例的描述，主要是为了在控制台显示，或者转为字符串时，比较容易区分

1
    let s1 = Symbol("s1");
2
    let s2 = Symbol("s2");
3

4
    console.log(s1) // Symbol(s1)
5
    console.log(s2) // Symbol(s2)
6

7
    console.log(s1.toString()) // "Symbol(s1)"
8
    console.log(s2.toString()) // "Symbol(s2)"

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

1
    const obj = {
2
        name: "obj",
3
        toString: function() {
4
            return this.name
5
        }
6
    }
7

8
    let s = Symbol(obj)
9
    console.log(s) //Symbol(obj)

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

1
  // 没有参数的情况
2
  let s1 = Symbol()
3
  let s2 = Symbol()
4

5
  s1 === s2 // false
6

7
  // 有参数的情况
8
  let s1 = Symbol("s")
9
  let s2 = Symbol("s")
10

11
  s1 === s2 // false

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

1
    let s = Symbol("s")
2
    let result = s + 100
3
  // TypeError: Cannot convert a Symbol value to a number

Symbol.for()#

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

1
  Symbol.for("foo") // 创建一个 symbol 并放入 symbol 注册表中，键为 "foo"
2
  Symbol.for("foo") // 从 symbol 注册表中读取键为"foo"的 symbol
3
  Symbol.for("foo") === Symbol.for("foo") // true
4

5
  Symbol("bar") === Symbol("bar") // false，Symbol() 函数每次都会返回新的一个 symbol
6

7
  var sym = Symbol.for("mario")
8
  sym.toString()
9
  // "Symbol(mario)"，mario 既是该 symbol 在 symbol 注册表中的键名，又是该 symbol 自身的描述字符串

Symbol.for()与Symbol()这两种写法，都会生成新的 Symbol。它们的区别是，前者会被登记在全局环境中供搜索，后者不会。Symbol.for()不会每次调用就返回一个新的 Symbol 类型的值，而是会先检查给定的key是否已经存在，如果不存在才会新建一个值

Symbol.keyFor()#

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

1
  let s1 = Symbol.for("foo")
2
  Symbol.keyFor(s1) // "foo"
3

4
  let s2 = Symbol("foo")
5
  Symbol.keyFor(s2) // undefined

变量s2属于未登记的 Symbol 值，所以返回undefined

需要注意的是，Symbol.for()为 Symbol 值登记的名字，是全局环境的，可以在不同的 iframe 或 service worker 中取到同一个值

1
  iframe = document.createElement("iframe")
2
  iframe.src = String(window.location)
3
  document.body.appendChild(iframe)
4

5
  iframe.contentWindow.Symbol.for("foo") === Symbol.for("foo")  // true

内置的 Symbol 值#

除了定义自己使用的 Symbol 值以外，ES6 还提供了 11 个内置的 Symbol 值，指向语言内部使用的方法

Symbol.hasInstance#

对象的Symbol.hasInstance属性，指向一个内部方法。当其他对象使用instanceof运算符，判断是否为该对象的实例时，会调用这个方法。比如，foo instanceof Foo在语言内部，实际调用的是Foo[Symbol.hasInstance](foo)

1
    class MyClass {
2
        [Symbol.hasInstance](foo) {
3
            return foo instanceof Array;
4
        }
5
    }
6

7
    [1, 2, 3] instanceof new MyClass(); // true

上面代码中，MyClass是一个类，new MyClass()会返回一个实例。该实例的Symbol.hasInstance()方法，会在进行instanceof运算时自动调用，判断左侧的运算子是否为Array的实例

Symbol.isConcatSpreadable#

对象的Symbol.isConcatSpreadable属性等于一个布尔值，表示该对象用于Array.prototype.concat()时，是否可以展开

1
    let arr1 = ["c", "d"];
2
    ["a", "b"].concat(arr1, "e"); // ['a', 'b', 'c', 'd', 'e']
3
    arr1[Symbol.isConcatSpreadable]; // undefined
4

5
    let arr2 = ["c", "d"];
6
    arr2[Symbol.isConcatSpreadable] = false;
7
    ["a", "b"].concat(arr2, "e"); // ['a', 'b', ['c','d'], 'e']

上面代码说明，数组的默认行为是可以展开，Symbol.isConcatSpreadable默认等于undefined。该属性等于true时，也有展开的效果

类似数组的对象正好相反，默认不展开。它的Symbol.isConcatSpreadable属性设为true，才可以展开

1
    let obj = {
2
        length: 2,
3
        0: "c",
4
        1: "d"
5
    };
6
    ["a", "b"].concat(obj, "e"); // ['a', 'b', obj, 'e']
7

8
    obj[Symbol.isConcatSpreadable] = true;
9
    ["a", "b"].concat(obj, "e"); // ['a', 'b', 'c', 'd', 'e']

Symbol.species#

对象的Symbol.species属性，指向一个构造函数。创建衍生对象时，会使用该属性

1
    class MyArray extends Array {}
2

3
    const a = new MyArray(1, 2, 3);
4
    const b = a.map((x) => x);
5
    const c = a.filter((x) => x > 1);
6

7
    b instanceof MyArray; // true
8
    c instanceof MyArray; // true

上面代码中，子类MyArray继承了父类Array，a是MyArray的实例，b和c是a的衍生对象。您可能会认为，b和c都是调用数组方法生成的，所以应该是数组(Array的实例)，但实际上它们也是MyArray的实例

Symbol.match#

对象的Symbol.match属性，指向一个函数。当执行str.match(myObject)时，如果该属性存在，会调用它，返回该方法的返回值

1
    String.prototype.match(regexp);
2
    // 等同于
3
    regexp[Symbol.match](this);
4

5
    class MyMatcher {
6
        [Symbol.match](string) {
7
            return "hello world".indexOf(string);
8
        }
9
    }
10

11
    "e".match(new MyMatcher()); // 1

Symbol.replace#

对象的Symbol.replace属性，指向一个方法，当该对象被String.prototype.replace方法调用时，会返回该方法的返回值

1
    String.prototype.replace(searchValue, replaceValue);
2
    // 等同于
3
    searchValue[Symbol.replace](this, replaceValue);

例：

1
    const x = {};
2
    x[Symbol.replace] = (...s) => console.log(s);
3

4
    "Hello".replace(x, "World"); // ["Hello", "World"]

Symbol.replace方法会收到两个参数，第一个参数是replace方法正在作用的对象，上面例子是Hello，第二个参数是替换后的值，上面例子是World

Symbol.search#

对象的Symbol.search属性，指向一个方法，当该对象被String.prototype.search方法调用时，会返回该方法的返回值

1
    String.prototype.search(regexp);
2
    // 等同于
3
    regexp[Symbol.search](this);
4

5
    class MySearch {
6
        constructor(value) {
7
                this.value = value;
8
            }
9
            [Symbol.search](string) {
10
                return string.indexOf(this.value);
11
            }
12
    }
13
    "foobar".search(new MySearch("foo")); // 0

Symbol.split#

对象的Symbol.split属性，指向一个方法，当该对象被String.prototype.split方法调用时，会返回该方法的返回值

1
  String.prototype.split(separator, limit);
2

3
  separator[Symbol.split](this, limit);

例：

1
    class MySplitter {
2
        constructor(value) {
3
                this.value = value;
4
            }
5
            [Symbol.split](string) {
6
                let index = string.indexOf(this.value);
7
                if (index === -1) {
8
                    return string;
9
                }
10
                return [string.substr(0, index), string.substr(index + this.value.length)];
11
            }
12
    }
13

14
    "foobar".split(new MySplitter("foo"));
15
    // ['', 'bar']
16

17
    "foobar".split(new MySplitter("bar"));
18
    // ['foo', '']
19

20
    "foobar".split(new MySplitter("baz"));
21
    // 'foobar'

上面方法使用Symbol.split方法，重新定义了字符串对象的split方法的行为

Symbol.iterator#

对象的Symbol.iterator属性，指向该对象的默认遍历器方法

1
    const myIterable = {};
2
    myIterable[Symbol.iterator] = function * () {
3
        yield 1;
4
        yield 2;
5
        yield 3;
6
    };
7

8
    [...myIterable]; // [1, 2, 3]

对象进行for...of循环时，会调用Symbol.iterator方法，返回该对象的默认遍历器

1
    class Collection {
2
        *[Symbol.iterator]() {
3
            let i = 0;
4
            while (this[i] !== undefined) {
5
                yield this[i];
6
                ++i;
7
            }
8
        }
9
    }
10

11
    let myCollection = new Collection();
12
    myCollection[0] = 1;
13
    myCollection[1] = 2;
14

15
    for (let value of myCollection) {
16
        console.log(value);
17
    }
18
    // 1
19
    // 2

Symbol.toPrimitive#

对象的Symbol.toPrimitive属性，指向一个方法。该对象被转为原始类型的值时，会调用这个方法，返回该对象对应的原始类型值。 Symbol.toPrimitive被调用时，会接受一个字符串参数，表示当前运算的模式，一共有三种模式。

Number: 该场合需要转成数值
String: 该场合需要转成字符串

Default: 该场合可以转成数值，也可以转成字符串

1
  let obj = {
2
      [Symbol.toPrimitive](hint) {
3
          switch (hint) {
4
              case "number":
5
                  return 123;
6
              case "string":
7
                  return "str";
8
              case "default":
9
                  return "default";
10
              default:
11
                  throw new Error();
12
          }
13
      },
14
  };
15

16
  2 * obj; // 246
17
  3 + obj; // '3default'
18
  obj == "default"; // true
19
  String(obj); // 'str'

Symbol.toStringTag#

对象的Symbol.toStringTag属性，指向一个方法。在该对象上面调用Object.prototype.toString方法时，如果这个属性存在，它的返回值会出现在toString()方法返回的字符串之中，表示对象的类型。也就是说，这个属性可以用来定制[object Object]或[object Array]中object后面的那个字符串

1
    // 例一
2
    ({
3
        [Symbol.toStringTag]: "Foo"
4
    }.toString());
5
    // "[object Foo]"
6

7
    // 例二
8
    class Collection {
9
        get[Symbol.toStringTag]() {
10
            return "xxx";
11
        }
12
    }
13
    let x = new Collection();
14
    Object.prototype.toString.call(x); // "[object xxx]"

ES6 新增内置对象的Symbol.toStringTag属性值如下。

JSON[Symbol.toStringTag]: ‘JSON’
Math[Symbol.toStringTag]: ‘Math’
Module 对象 M[Symbol.toStringTag]: ‘Module’
ArrayBuffer.prototype[Symbol.toStringTag]: ‘ArrayBuffer’
DataView.prototype[Symbol.toStringTag]: ‘DataView’
Map.prototype[Symbol.toStringTag]: ‘Map’
Promise.prototype[Symbol.toStringTag]: ‘Promise’
Set.prototype[Symbol.toStringTag]: ‘Set’
%TypedArray%.prototype[Symbol.toStringTag]: ‘Uint8Array’等
WeakMap.prototype[Symbol.toStringTag]: ‘WeakMap’
WeakSet.prototype[Symbol.toStringTag]: ‘WeakSet’
%MapIteratorPrototype%[Symbol.toStringTag]: ‘Map Iterator’
%SetIteratorPrototype%[Symbol.toStringTag]: ‘Set Iterator’
%StringIteratorPrototype%[Symbol.toStringTag]: ‘String Iterator’
Symbol.prototype[Symbol.toStringTag]: ‘Symbol’
Generator.prototype[Symbol.toStringTag]: ‘Generator’
GeneratorFunction.prototype[Symbol.toStringTag]: ‘GeneratorFunction

Symbol.unscopables#

对象的Symbol.unscopables属性，指向一个对象。该对象指定了使用with关键字时，哪些属性会被with环境排除

1
    Array.prototype[Symbol.unscopables];
2
    // {
3
    //   copyWithin: true,
4
    //   entries: true,
5
    //   fill: true,
6
    //   find: true,
7
    //   findIndex: true,
8
    //   includes: true,
9
    //   keys: true
10
    // }
11

12
    Object.keys(Array.prototype[Symbol.unscopables]);
13
    // ['copyWithin', 'entries', 'fill', 'find', 'findIndex', 'includes', 'keys']

上面代码说明，数组有 7 个属性，会被with命令排除

1
    // 没有 unscopables 时
2
    class MyClass {
3
        foo() {
4
            return 1;
5
        }
6
    }
7

8
    var foo = function () {
9
        return 2;
10
    };
11

12
    with(MyClass.prototype) {
13
        foo(); // 1
14
    }
15

16
    // 有 unscopables 时
17
    class MyClass {
18
        foo() {
19
            return 1;
20
        }
21
        get[Symbol.unscopables]() {
22
            return {
23
                foo: true
24
            };
25
        }
26
    }
27

28
    var foo = function () {
29
        return 2;
30
    };
31

32
    with(MyClass.prototype) {
33
        foo(); // 2
34
    }

上面代码通过指定Symbol.unscopables属性，使得with语法块不会在当前作用域寻找foo属性，即foo将指向外层作用域的变量