ES6 学习笔记(8) Symbol

1. 概述

• ES6 引入了一种新的原始数据类型Symbol，表示独一无二的值。它是 JavaScript 语言的第七种数据类型，
• 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

Symbol值不能与其他类型的值进行运算,会报错

  let sym = Symbol('My symbol');
  "your symbol is " + sym
  // TypeError: can't convert symbol to string
  `your symbol is ${sym}`
  // TypeError: can't convert symbol to string

• Symbol 值可以显式转为字符串。也可以转为布尔值 但是不能转为数值。

  let sym = Symbol('My symbol');
  String(sym) // 'Symbol(My symbol)'
  sym.toString() // 'Symbol(My symbol)'
  Boolean(sym) // true
  !sym  // false
  if (sym) {
    // ...
  }
  Number(sym) // TypeError
  sym + 2 // TypeError

2. 作为属性名的 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!"
  // 在对象的内部，使用 Symbol 值定义属性时，Symbol 值必须放在方括号之中。
  // Symbol 值作为属性名时，该属性还是公开属性，不是私有属性。

3. 实例:消除魔术字符串

---

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

  const shapeType = {
    triangle: Symbol()
  };  //  用于替换getArea里的 Triangle
  
 function getArea(shape, options) {
  let area = 0;
  switch (shape) {
    case 'Triangle': // 魔术字符串
      area = .5 * options.width * options.height;
      break;
    /* ... more code ... */
  }
  return area;
}
getArea('Triangle', { width: 100, height: 100 }); // 魔术字符串

4. 属性名的遍历

---

Symbol 作为属性名，该属性不会出现在for...in、for...of循环中，也不会被Object.keys()、Object.getOwnPropertyNames()、JSON.stringify()返回。但是，它也不是私有属性，有一个Object.getOwnPropertySymbols方法，可以获取指定对象的所有Symbol属性名。

Object.getOwnPropertySymbols方法返回一个数组，成员是当前对象的所有用作属性名的 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)]

Reflect.ownKeys方法可以返回所有类型的键名，包括常规键名和 Symbol 键名。返回数组
造成了一种非私有的内部方法的效果。

let size = Symbol('size');

class Collection {
  constructor() {
    this[size] = 0;
  }

  add(item) {
    this[this[size]] = item;
    this[size]++;
  }

  static sizeOf(instance) {
    return instance[size];
  }
}

let x = new Collection();
Collection.sizeOf(x) // 0

x.add('foo');
Collection.sizeOf(x) // 1

Object.keys(x) // ['0']
Object.getOwnPropertyNames(x) // ['0']
Object.getOwnPropertySymbols(x) // [Symbol(size)]

5. Symbol.for()，Symbol.keyFor()

---

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

  let s1 = Symbol.for('foo');
  let s2 = Symbol.for('foo');

  s1 === s2 // true

• Symbol.for()与Symbol()这两种写法，都会生成新的 Symbol。
  比如，如果你调用Symbol.for("cat")30 次，每次都会返回同一个 Symbol 值，但是调用Symbol("cat")30 次，会返回 30 个不同的 Symbol 值。
  Symbol.keyFor方法返回一个已登记的 Symbol 类型值的key。

7. 内置的 Symbol 值

---

• Symbol.hasInstance
  对象的Symbol.hasInstance属性，指向一个内部方法。当其他对象使用instanceof运算符，判断是否为该对象的实例时，会调用这个方法。比如，foo instanceof Foo在语言内部，实际调用的是Foo[Symbol.hasInstance](foo)。
• item.recentVacancyCount
  对象的Symbol.isConcatSpreadable属性等于一个布尔值，表示该对象用于Array.prototype.concat()时，是否可以展开
• Symbol.species
  对象的Symbol.species属性，指向一个构造函数。创建衍生对象时，会使用该属性。
• Symbol.match
  对象的Symbol.match属性，指向一个函数。当执行str.match(myObject)时，如果该属性存在，会调用它，返回该方法的返回值。
• Symbol.replace
  对象的Symbol.replace属性，指向一个方法，当该对象被String.prototype.replace方法调用时，会返回该方法的返回值。
• Symbol.search
  对象的Symbol.search属性，指向一个方法，当该对象被String.prototype.search方法调用时，会返回该方法的返回值。
• Symbol.split
  对象的Symbol.split属性，指向一个方法，当该对象被String.prototype.split方法调用时，会返回该方法的返回值。
• Symbol.iterator
  对象的Symbol.iterator属性，指向该对象的默认遍历器方法。
• Symbol.toPrimitive
  对象的Symbol.toPrimitive属性，指向一个方法。该对象被转为原始类型的值时，会调用这个方法，返回该对象对应的原始类型值。
• Symbol.toStringTag
  对象的Symbol.toStringTag属性，指向一个方法。在该对象上面调用Object.prototype.toString方法时，如果这个属性存在，它的返回值会出现在toString方法返回的字符串之中，表示对象的类型。也就是说，这个属性可以用来定制[object Object]或[object Array]中object后面的那个字符串。
  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环境排除。