Symbol

​ ES6引入了一种新的原始数据类型Symbol，表示独一无二的值。它是JavaScript的第七种数据类型，前六种是undefined、null、布尔值(Boolean)、字符串(String)、数值(Number)、对象(Object)。

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

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

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

let s1 = Symbol('foo');
let s2 = Symbol('bar');
s1 // Symbol(foo)
s2 // Symbol(bar)
s1.toString() // "Symbol(foo)"
s2.toString() // "Symbol(bar)"

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

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

// 没有参数的情况
let s1 = Symbol();
let s2 = Symbol();
s1 === s2 // false
// 有参数的情况
let s1 = Symbol('foo');
let s2 = Symbol('foo');
s1 === s2 // false  s1和s2都是Symbol函数的返回值，而且参数相同，但是它们是不相等的。
"your symbol is " + sym  // TypeError: can't convert symbol to string

​ Symbol值不能与其他类型的值进行运算，会报错。但是Symbol值可以显式转为字符串,也可以转为布尔值，但是不能转为数值。

Symbol.prototype.description

​ ES2019提供了一个实例属性description，直接返回Symbol的描述。

const sym = Symbol('foo'); // 创建Symbol的时候，可以添加一个描述
String(sym) // "Symbol(foo)" 但读取这个描述需要将Symbol显式转为字符串
sym.toString() // "Symbol(foo)" 但读取这个描述需要将Symbol显式转为字符串
sym.description // "foo" 使用实例属性description，直接返回Symbol的描述

作为属性名的 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!" 以上写法都得到同样结果
//上面代码通过方括号结构和Object.defineProperty，将对象的属性名指定为一个Symbol值。

​ 注意，Symbol值作为对象属性名时，不能用点运算符。Symbol值作为属性名时，该属性还是公开属性，不是私有属性。

const mySymbol = Symbol();
const a = {};
a.mySymbol = 'Hello!';
a[mySymbol] //undefined。因为点运算符后面总是字符串，所以不会读取mySymbol作为标识名所指代的那个值
a['mySymbol'] //"Hello!"。导致a的属性名实际上是一个字符串，而不是一个Symbol值

​ 同理，在对象的内部，使用Symbol值定义属性时，Symbol值必须放在方括号之中。还可以用于定义一组常量，保证这组常量的值都是不相等的，最大的好处就是其他任何值都不可能有相同的值了。

实例：消除魔术字符串

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

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

function getArea(shape, options) {
  let area = 0;
  switch (shape) {
    case 'Triangle': // 魔术字符串
      area = .5 * options.width * options.height;
      break;
  }
  return area;
}
getArea('Triangle', { width: 100, height: 100 }); // 魔术字符串
//上面代码中，字符串Triangle就是一个魔术字符串。不利于将来的修改和维护-------------------
const shapeType = {
  triangle: 'Triangle' //把Triangle写成shapeType对象的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 });
//分析发现shapeType.triangle等于哪个值并不重要，只要确保不会跟其他shapeType属性的值冲突即可
//因此，这里就很适合改用Symbol值。--------------------------------------------------
const shapeType = {
  triangle: Symbol()
};

属性名的遍历

​ Symbol作为属性名，遍历对象的时候，该属性不会出现在for...in、for...of循环中，也不会被Object.keys()、Object.getOwnPropertyNames()、JSON.stringify()返回。但它也不是私有属性，有一个Object.getOwnPropertySymbols()方法，可以获取指定对象的所有Symbol属性名。该方法返回一个数组，成员是当前对象的所有用作属性名的Symbol值(Symbol键名)。

const obj = {};
let a = Symbol('a');
let b = Symbol('b');
obj[a] = 'Hello';
obj[b] = 'World';
const objectSymbols = Object.getOwnPropertySymbols(obj);
objectSymbols // [Symbol(a), Symbol(b)]

​ 另一个新的API，Reflect.ownKeys()方法可以返回所有类型的键名，包括常规键名和Symbol键名。

​ 由于以Symbol值作为键名，不会被常规方法遍历得到。我们可以利用这个特性，为对象定义一些非私有的、但又希望只用于内部的方法。

Symbol.for()，Symbol.keyFor()

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

let s1 = Symbol.for('foo');
let s2 = Symbol.for('foo');
s1 === s2 // true。s1和s2都是Symbol值，但它们都是由同样参数的Symbol.for方法生成的，所以实际上是同一个值

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

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

​ 注意，Symbol.for()为Symbol值登记的名字是全局环境的，不管有没有在全局环境运行。这个全局登记特性可以用在不同的 iframe 或 service worker 中取到同一个值。

实例：模块的 Singleton 模式

​ Singleton模式指的是调用一个类，任何时候返回的都是同一个实例。

​ 对于Node来说，模块文件可以看成是一个类，为了保证每次执行这个模块文件，返回的都是同一个实例，可以把实例放到顶层对象global，并使用Symbol.for()方法生成键名，那么外部将无法引用这个值，当然也就无法改写。

内置的 Symbol 值

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

• Symbol.hasInstance：指向一个内部方法。当其他对象使用instanceof运算符判断是否为该对象的实例时，会调用这个方法。比如，foo instanceof Foo在语言内部，实际调用的是FooSymbol.hasInstance。
• Symbol.isConcatSpreadable：等于一个布尔值，表示该对象用于Array.prototype.concat()时是否可以展开。
• Symbol.species：指向一个构造函数。创建衍生对象时会使用该属性，定义了Symbol.species属性，创建衍生对象时就会使用这个属性返回的函数作为构造函数。作用在于，实例对象在运行过程中需要再次调用自身的构造函数时，会调用该属性指定的构造函数。主要的用途是，有些类库是在基类的基础上修改的，子类使用继承的方法时，可能希望返回基类的实例，而不是子类的实例。
• Symbol.match：指向一个函数。当执行str.match(myObject)时，如果该属性存在，会调用它，返回该方法的返回值。
• Symbol.replace：指向一个方法，当该对象被String.prototype.replace方法调用时，会返回该方法的返回值。Symbol.replace方法会收到两个参数，第一个参数是replace方法正在作用的对象，第二个参数是替换后的值。
• Symbol.search：指向一个方法，当该对象被String.prototype.search方法调用时，会返回该方法的返回值。
• Symbol.split：对象的Symbol.split属性指向一个方法，当该对象被String.prototype.split方法调用时，会返回该方法的返回值。
• Symbol.iterator：指向该对象的默认遍历器方法。对象进行for...of循环时会调用Symbol.iterator方法，返回该对象的默认遍历器。
• Symbol.toPrimitive：指向一个方法。该对象被转为原始类型的值时会调用这个方法，返回该对象对应的原始类型值。Symbol.toPrimitive被调用时，会接受一个字符串参数，表示当前运算的模式，一共有三种模式。
  • Number：该场合需要转成数值
  • String：该场合需要转成字符串
  • Default：该场合可以转成数值，也可以转成字符串
• Symbol.toStringTag：指向一个方法。在该对象上面调用Object.prototype.toString方法时，如果这个属性存在，它的返回值会出现在toString方法返回的字符串中，表示对象的类型。就是说，这个属性可以用来定制[object Object]或[object Array]中object后面的那个字符串。
• Symbol.unscopables：指向一个对象。该对象指定了使用with关键字时哪些属性会被with环境排除。