6、Symbol和Symbol属性

ES5 的对象属性名都是字符串，这容易造成属性名的冲突。比如，你使用了一个他人提供的对象，但又想为这个对象添加新的方法（mixin 模式），新方法的名字就有可能与现有方法产生冲突。如果有一种机制，保证每个属性的名字都是独一无二的就好了，这样就从根本上防止属性名的冲突。这就是 ES6 引入Symbol的原因。
ES6 引入了一种新的原始数据类型Symbol，表示独一无二的值。它是 JavaScript 语言的第七种数据类型，前六种是：undefined、null、布尔值（Boolean）、字符串（String）、数值（Number）、对象（Object）。
Symbol 值通过Symbol函数生成。这就是说，对象的属性名现在可以有两种类型，一种是原来就有的字符串，另一种就是新增的 Symbol 类型。凡是属性名属于 Symbol 类型，就都是独一无二的，可以保证不会与其他属性名产生冲突。

创建Symbol

    let firstName = Symbol("first name");
    let person = {};
    person[firstName] = "Nicholas";
    console.log("first name" in person); // false
    console.log(person[firstName]); // stringify
    console.log(firstName); // Symbol(first name)

Symbol函数接受一个可选参数，其可以让你添加一段文本描述即将创建的Symbol，这段描述不可用于属性访问，但是建议你在每次创建Symbol时都添加这样一段描述，以便于阅读代码和调试Symbol程序。

Symbol的描述被存储在内部的[[Description]]属性中，只有当调用Symbol的toString()方法时才可以读取这个属性。在执行console.log()时隐式调用了firstName的toString()方法，所以它的描述会被打印到日志中，但不能直接在代码里访问[[Description]]。

Symbol的辨识方法

    let symbol = Symbol("test symbol");
    console.log(typeof symbol);

Symbol的使用方法

所有使用可计算属性名的地方，都可以使用Symbol。前面我们看到的都是在括号中使用Symbol，事实上，Symbol也可以用于可计算对象字面量属性名、Object.defineProperty()方法和Object.defineProperties()方法的调用过程中。

    let firstName = Symbol("first name");

        //使用一个可计算对象字面量属性
    let person = {
        [firstName]: "Nicholas"
    };

        //将属性设置为只读
    Object.defineProperty(person, firstName, { writable: false });

    let lastName = Symbol("last name");

    Object.defineProperties(person, {
        [lastName]: {
            value: "Zakas",
            writable: false
        }
    });

    console.log(person[firstName]);
    console.log(person[lastName]);

在此示例中，首先通过可计算对象字面量属性语法为person对象创建了一个Symbol属性firstName。后面一行代码将这个属性设置为只读。随后，通过Object.defineProperties()方法创建一个只读的Symbol属性lastName，此处再次使用了对象字面量属性，但却是作为Object.defineProperties()方法的第二个参数使用。

Symbol共享体系

有时我们可能希望在不同的代码中共享同一个Symbol，例如，在你的应用中有两种不同的对象类型，但是你希望它们使用同一个Symbol属性来表示一个独特的标识符。一般而言，在很大的代码库中或跨文件追踪Symbol非常困难而且容易出错，出于这些原因，ECMAScript 6提供了一个可以随时访问的全局Symbol注册表。
如果想创建一个可共享的Symbol，要使用Symbol.for()方法。它只接受一个参数，也就是即将创建的Symbol的字符串标识符，这个参数同样也被用作Symbol的描述，就像这样：

    let uid = Symbol.for("uid");
    let objce = {};

    Object[uid] = "12345";

    console.log(Object[uid]); //12345
    console.log(uid);   //Symbol(uid)

Symbol.for()方法首先在全局Symbol注册表中搜索键为”uid”的Symbol是否存在，如果存在，直接返回已有的Symbol；否则，创建一个新的Symbol，并使用这个键在Symbol全局注册表中注册，随即返回新创建的Symbol。
后续如果再传入同样的键调用Symbol.for()会返回相同的Symbol，像这样：

    let uid = Symbol.for("uid");
    let Object = {
        [uid]: "123456"
    };

    console.log(Object[uid]);
    console.log(uid);

    let uid2 = Symbol.for("uid");

    console.log(uid === uid2);
    console.log(Object[uid2]);
    console.log(uid2);

可以使用Symbol.keyFor()方法在Symbol全局注册表中检索与Symbol有关的键

    let uid = Symbol.for("uid");
    console.log(Symbol.keyFor(uid));  // "uid"

    let uid2 = Symbol.for("uid");
    console.log(Symbol.keyFor(uid2)); // "uid"

    let uid3 = Symbol("uid");
    console.log(Symbol.keyFor(uid3)); // undefined

Symbol与类型强制转换

自动转型是JavaScript中的一个重要语言特性，利用这个特性能够在特定场景下将某个数据强制转换为其他类型。然而，其他类型没有与Symbol逻辑等价的值，因而Symbol使用起来不是很灵活，尤其是不能将Symbol强制转换为字符串和数字类型，否则如果不小心将其作为对象属性，最终会导致不一样的执行结果。
在本章的示例中，我们使用console.log()方法来输出Symbol的内容，它会调用Symbol的String()方

    let uid = Symbol.for("uid");
        desc = String(uid);

    console.log(desc); //Symbol(uid)

String()函数调用了uid.toString()方法，返回字符串类型的Symbol描述里的内容。但是，如果你尝试将Symbol与一个字符串拼接，会导致程序抛出错误：

    let uid = Symbol.for("uid");
        desc = uid+""; //报错

将uid与空字符串拼接，首先要将uid强制转换为一个字符串，而Symbol不可以被转换为字符串，故程序直接抛出错误。同样，也不能将Symbol强制转换为数字类型。将Symbol与每一个数学运算符混合使用都会导致程序抛出错误，就像这样：

var uid = Symbol.for("uid"),
    sum = uid/1;

这个示例尝试将Symbol除1，程序直接抛出错误。而且无论使用哪一个数学操作符，都无法正常运行（逻辑操作符除外，因为Symbol与JavaScript中的非空值类似，其等价布尔值为true）。

Symbol属性检索

Object.keys()方法和Object.getOwnPropertyNames()方法可以检索对象中所有的属性名：前一个方法返回所有可枚举的属性名；后一个方法不考虑属性的可枚举性一律返回。然而为了保持ECMAScript 5函数的原有功能，这两个方法都不支持Symbol属性，而是在ECMAScript 6中添加一个Object.getOwnProperty-Symbols()方法来检索对象中的Symbol属性。Object.getOwnPropertySymbols()方法的返回值是一个包含所有Symbol自有属性的数组，就像这样：

    let uid = Symbol.for("uid");

    let object = {
        [uid]: "123456"
    }

    let symbols = Object.getOwnPropertySymbols(object);

    console.log(symbols.length); // 1
    console.log(symbols[0]); // Symbol(uid)
    console.log(object[symbols[0]]); // 123456

在这段代码中，object对象有一个名为uid的Symbol属性，Object.getOwn-PropertySymbols()方法返回了包含这个属性的数组。
所有对象一开始都没有自己独有的属性，但是对象可以从原型链中继承Symbol属性。ECMAScript 6通过一些well-known Symbol预定义了这些属性。

通过well-known Symbol暴露内部操作

ECMAScript 5的一个中心主旨是将JavaScript中的一些“神奇”的部分暴露出来，并详尽定义了这些开发者们在当时模拟不了的功能。ECMAScript 6延续了这个传统，新标准中主要通过在原型链上定义与Symbol相关的属性来暴露更多的语言内部逻辑。
ECMAScript 6开放了以前JavaScript中常见的内部操作，并通过预定义一些well-known Symbol来表示。每一个这类Symbol都是Symbol对象的一个属性，例如Symbol.match。
这些well-known Symbol包括：
· Symbol.hasInstance　一个在执行instanceof时调用的内部方法，用于检测对象的继承信息。
· Symbol.isConcatSpreadable　一个布尔值，用于表示当传递一个集合作为Array.prototype.concat()方法的参数时，是否应该将集合内的元素规整到同一层级。
· Symbol.iterator　一个返回迭代器（将在第8章讲解）的方法。
· Symbol.match　一个在调用String.prototype.match()方法时调用的方法，用于比较字符串。
· Symbol.replace　一个在调用String.prototype.replace()方法时调用的方法，用于替换字符串的子串。
· Symbol.search　一个在调用String.prototype.search()方法时调用的方法，用于在字符串中定位子串。
· Symbol.species　用于创建派生类（将在第9章讲解）的构造函数。
· Symbol.split　一个在调用String.prototype.split()方法时调用的方法，用于分割字符串。
· Symbol.toPrimitive　一个返回对象原始值的方法。· Symbol.toStringTag　一个在调用Object.prototype.toString()方法时使用的字符串，用于创建对象描述。
· Symbol.unscopables　一个定义了一些不可被with语句引用的对象属性名称的对象集合。在接下来的几个小节中，我们将探讨一些常用的well-known Symbol，其他的则根据本书后续内容，分别在对应的上下文中讲解。重写一个由well-known Symbol定义的方法，会导致对象内部的默认行为被改变，从而一个普通对象会变为一个奇异对象（exotic object）。但实际上其不会对你的代码产生任何影响，只是在规范中描述对象的方式改变了。

以下均为阮一峰教程原文

内置的 Symbol 值

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

Symbol.hasInstance

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

class MyClass {
  [Symbol.hasInstance](foo) {
    return foo instanceof Array;
  }
}
[1, 2, 3] instanceof new MyClass() // true

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

class Even {
  static [Symbol.hasInstance](obj) {
    return Number(obj) % 2 === 0;
  }
}
// 等同于
const Even = {
  [Symbol.hasInstance](obj) {
    return Number(obj) % 2 === 0;
  }
};
1 instanceof Even // false
2 instanceof Even // true
12345 instanceof Even // false

Symbol.isConcatSpreadable

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

let arr1 = ['c', 'd'];
['a', 'b'].concat(arr1, 'e') // ['a', 'b', 'c', 'd', 'e']
arr1[Symbol.isConcatSpreadable] // undefined
let arr2 = ['c', 'd'];
arr2[Symbol.isConcatSpreadable] = false;
['a', 'b'].concat(arr2, 'e') // ['a', 'b', ['c','d'], 'e']

上面代码说明，数组的默认行为是可以展开，Symbol.isConcatSpreadable默认等于undefined。该属性等于true时，也有展开的效果。
类似数组的对象正好相反，默认不展开。它的Symbol.isConcatSpreadable属性设为true，才可以展开。

let obj = {length: 2, 0: 'c', 1: 'd'};
['a', 'b'].concat(obj, 'e') // ['a', 'b', obj, 'e']
obj[Symbol.isConcatSpreadable] = true;
['a', 'b'].concat(obj, 'e') // ['a', 'b', 'c', 'd', 'e']

Symbol.isConcatSpreadable属性也可以定义在类里面。

class A1 extends Array {
  constructor(args) {
    super(args);
    this[Symbol.isConcatSpreadable] = true;
  }
}
class A2 extends Array {
  constructor(args) {
    super(args);
  }
  get [Symbol.isConcatSpreadable] () {
    return false;
  }
}
let a1 = new A1();
a1[0] = 3;
a1[1] = 4;
let a2 = new A2();
a2[0] = 5;
a2[1] = 6;
[1, 2].concat(a1).concat(a2)
// [1, 2, 3, 4, [5, 6]]

上面代码中，类A1是可展开的，类A2是不可展开的，所以使用concat时有不一样的结果。
注意，Symbol.isConcatSpreadable的位置差异，A1是定义在实例上，A2是定义在类本身，效果相同。

Symbol.species

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

class MyArray extends Array {
}
const a = new MyArray(1, 2, 3);
const b = a.map(x => x);
const c = a.filter(x => x > 1);
b instanceof MyArray // true
c instanceof MyArray // true

上面代码中，子类MyArray继承了父类Array，a是MyArray的实例，b和c是a的衍生对象。你可能会认为，b和c都是调用数组方法生成的，所以应该是数组（Array的实例），但实际上它们也是MyArray的实例。
Symbol.species属性就是为了解决这个问题而提供的。现在，我们可以为MyArray设置Symbol.species属性。

class MyArray extends Array {
  static get [Symbol.species]() { return Array; }
}

上面代码中，由于定义了Symbol.species属性，创建衍生对象时就会使用这个属性返回的函数，作为构造函数。这个例子也说明，定义Symbol.species属性要采用get取值器。默认的Symbol.species属性等同于下面的写法。

static get [Symbol.species]() {
  return this;
}

现在，再来看前面的例子。

class MyArray extends Array {
  static get [Symbol.species]() { return Array; }
}
const a = new MyArray();
const b = a.map(x => x);
b instanceof MyArray // false
b instanceof Array // true

上面代码中，a.map(x => x)生成的衍生对象，就不是MyArray的实例，而直接就是Array的实例。
再看一个例子。

class T1 extends Promise {
}
class T2 extends Promise {
  static get [Symbol.species]() {
    return Promise;
  }
}
new T1(r => r()).then(v => v) instanceof T1 // true
new T2(r => r()).then(v => v) instanceof T2 // false

上面代码中，T2定义了Symbol.species属性，T1没有。结果就导致了创建衍生对象时（then方法），T1调用的是自身的构造方法，而T2调用的是Promise的构造方法。
总之，Symbol.species的作用在于，实例对象在运行过程中，需要再次调用自身的构造函数时，会调用该属性指定的构造函数。它主要的用途是，有些类库是在基类的基础上修改的，那么子类使用继承的方法时，作者可能希望返回基类的实例，而不是子类的实例。

Symbol.match

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

String.prototype.match(regexp)
// 等同于
regexp[Symbol.match](this)
class MyMatcher {
  [Symbol.match](string) {
    return 'hello world'.indexOf(string);
  }
}
'e'.match(new MyMatcher()) // 1

Symbol.replace

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

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

下面是一个例子。

const x = {};
x[Symbol.replace] = (...s) => console.log(s);
'Hello'.replace(x, 'World') // ["Hello", "World"]

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

Symbol.search

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

String.prototype.search(regexp)
// 等同于
regexp[Symbol.search](this)
class MySearch {
  constructor(value) {
    this.value = value;
  }
  [Symbol.search](string) {
    return string.indexOf(this.value);
  }
}
'foobar'.search(new MySearch('foo')) // 0

Symbol.split

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

String.prototype.split(separator, limit)
// 等同于
separator[Symbol.split](this, limit)

下面是一个例子。

class MySplitter {
  constructor(value) {
    this.value = value;
  }
  [Symbol.split](string) {
    let index = string.indexOf(this.value);
    if (index === -1) {
      return string;
    }
    return [
      string.substr(0, index),
      string.substr(index + this.value.length)
    ];
  }
}
'foobar'.split(new MySplitter('foo'))
// ['', 'bar']
'foobar'.split(new MySplitter('bar'))
// ['foo', '']
'foobar'.split(new MySplitter('baz'))
// 'foobar'

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

Symbol.iterator

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

const myIterable = {};
myIterable[Symbol.iterator] = function* () {
  yield 1;
  yield 2;
  yield 3;
};
[...myIterable] // [1, 2, 3]

对象进行for...of循环时，会调用Symbol.iterator方法，返回该对象的默认遍历器，详细介绍参见《Iterator 和 for…of 循环》一章。

class Collection {
  *[Symbol.iterator]() {
    let i = 0;
    while(this[i] !== undefined) {
      yield this[i];
      ++i;
    }
  }
}
let myCollection = new Collection();
myCollection[0] = 1;
myCollection[1] = 2;
for(let value of myCollection) {
  console.log(value);
}
// 1
// 2

Symbol.toPrimitive

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

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

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

  let obj = {
  [Symbol.toPrimitive](hint) {
    switch (hint) {
      case 'number':
        return 123;
      case 'string':
        return 'str';
      case 'default':
        return 'default';
      default:
        throw new Error();
     }
   }
  };
  2 * obj // 246
  3 + obj // '3default'
  obj == 'default' // true
  String(obj) // 'str'
  

  Symbol.toStringTag

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

  // 例一
  ({[Symbol.toStringTag]: 'Foo'}.toString())
  // "[object Foo]"
  // 例二
  class Collection {
  get [Symbol.toStringTag]() {
    return 'xxx';
  }
  }
  let x = new Collection();
  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环境排除。

  Array.prototype[Symbol.unscopables]
  // {
  //   copyWithin: true,
  //   entries: true,
  //   fill: true,
  //   find: true,
  //   findIndex: true,
  //   includes: true,
  //   keys: true
  // }
  Object.keys(Array.prototype[Symbol.unscopables])
  // ['copyWithin', 'entries', 'fill', 'find', 'findIndex', 'includes', 'keys']
  

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

  // 没有 unscopables 时
  class MyClass {
  foo() { return 1; }
  }
  var foo = function () { return 2; };
  with (MyClass.prototype) {
  foo(); // 1
  }
  // 有 unscopables 时
  class MyClass {
  foo() { return 1; }
  get [Symbol.unscopables]() {
    return { foo: true };
  }
  }
  var foo = function () { return 2; };
  with (MyClass.prototype) {
  foo(); // 2
  }
  

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