20190202 学习Symbol

概述

产生原因

ES6的对象属性名都是字符串，容易造成属性名的冲突，为避免冲突，引入Symbol机制，保证每个属性的名字都是独一无二的，从根本上防止属性名的冲突

原始数据类型之一

新的原始数据类型，表示独一无二的值
JavaScript语言的七种数据类型：

1. undefined
2. null
3. Boolean
4. String
5. Number
6. Object
7. Symbol

生成方式

Symbol值通过Symbol函数生成，生成后的对象属性名有两种类型，分别为字符串以及Symbol类型

let s = Symbol();
typeof s
// "symbol"

注意事项

1. Symbol()前面不可以使用new命令，否则会报错
   原因：生成的Symbol是一个原始类型的值，不是对象，不可以添加属性
2. Symbol函数可以接受一个字符串作为参数，表示对Symbol实例的描述
   目的：主要是为了在控制台显示，或者转为字符串时，比较容易区分
3. 如果Symbol的参数是一个对象，就会调用该对象的toString方法，将其转为字符串，然后才生成一个Symbol值
4. Symbol函数的参数只是表示对当前Symbol值的描述，因此相同参数的Symbol函数的返回值是不相等的

// 没有参数的情况
let s1 = Symbol();
let s2 = Symbol();

s1 === s2 // false

// 有参数的情况
let s1 = Symbol('foo');
let s2 = Symbol('foo');

s1 === s2 // false

5. Symbol值不能与其他类型的值进行运算，会报错
6. Symbol值可以显示转为字符串
7. Symbol可以转为布尔值，但是不能转为数值

let sym = Symbol();
Boolean(sym) // true
!sym  // false

if (sym) {
  // ...
}

Number(sym) // TypeError
sym + 2 // TypeError

作为属性名的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!"

注意：

1. Symbol值作为对象属性名时，不能使用点运算符

const mySymbol = Symbol();
const a = {};

a.mySymbol = 'Hello!';
a[mySymbol] // undefined
a['mySymbol'] // "Hello!"

2. 在对象内部，使用Symbol值定义属性时，必须把Symbol值放在方括号之中
   如果不放入方括号之中，则该属性的键名为字符串s，而不是s所代表的那个Symbol值
3. Symbol值作为属性名时，该属性是公开属性，而不是私有属性

属性名的遍历

Symbol 作为属性名，该属性不会出现在for...in、for...of循环中，也不会被Object.keys()、Object.getOwnPropertyNames()、JSON.stringify()返回，也不是私有属性

Object.getOwnPropertySymbols()

Object.getOwnPropertySymbols()方法，可以获取指定对象的所有 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)]

Reflect.ownKeys()

Reflect.ownKeys()方法可以返回所有类型的键名，包括常规键名和 Symbol 键名

let obj = {
  [Symbol('my_key')]: 1,
  enum: 2,
  nonEnum: 3
};

Reflect.ownKeys(obj)
//  ["enum", "nonEnum", Symbol(my_key)]

---

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

Symbol.for()，Symbol.keyFor()

Symbol.for()

接受一个字符串作为参数，然后搜索有没有以该参数作为名称的 Symbol 值.如果有，就返回这个 Symbol 值，否则就新建并返回一个以该字符串为名称的 Symbol 值
Symbol.for()与Symbol()两种方法，都会生成新的 Symbol。

Symbol.for()和Symbol()的区别

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

Symbol.keyFor()

返回一个已登记的Symbol类型值的key

let s1 = Symbol.for("foo");
Symbol.keyFor(s1) // "foo"

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

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

内置的Symbol值

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

Symbol.hasInstance

该属性指向一个内部方法
当其他对象使用instanceof运算符，判断是否为该对象的实例时，会自动调用这个方法

Symbol.isConcatSpreadable

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

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

Symbol.species

对象的Symbol.species属性，指向一个构造函数。创建衍生对象时，会使用该属性
用途：
子类使用继承的方法时，希望返回的是基类的实例，而不是子类的实例

Symbol.match

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

Symbol.replace

对象的Symbol.replace属性，指向一个方法，当该对象被String.prototype.replace方法调用时，会返回该方法的返回值
Symbol.replace方法会收到两个参数，第一个参数是replace方法正在作用的对象，第二个参数是替换后的值

Symbol.search

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

Symbol.split

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

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

Symbol.toPrimitive

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

Symbol.toStringTag

对象的Symbol.toStringTag属性，指向一个方法。在该对象上面调用Object.prototype.toString方法时，如果这个属性存在，它的返回值会出现在toString方法返回的字符串之中，表示对象的类型。

// 例一
({[Symbol.toStringTag]: 'Foo'}.toString())
// "[object Foo]"

// 例二
class Collection {
  get [Symbol.toStringTag]() {
    return 'xxx';
  }
}
let x = new Collection();
Object.prototype.toString.call(x) // "[object xxx]"

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']

第一个方法返回json对象，内容里面的键值对为被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将指向外层作用域的变量
需要使用get方法指定Symbol.unscopables属性