ES6之Symbol

JavaScript 原本有六种数据类型，分别是undefined、null、Boolean、String、Number、Object。ES6 引入了一种新的原始数据类型Symbol，它表示独一无二的值。

Symbol函数前不能使用new命令，否则会报错。这是因为生成的 Symbol 是一个原始类型的值，不是对象，也不能添加属性。

let s = Symbol();

typeof s	// "symbol"

Symbol函数可以接受一个字符串作为参数，表示对 Symbol 实例的描述，主要是为了在控制台显示，或者转为字符串时，能够分清到底是哪一个值。如果 Symbol 的参数是一个对象，就会调用该对象的toString方法，将其转为字符串，然后才生成一个 Symbol 值。

let s1 = Symbol('foo');

s1 				// Symbol(foo)
s1.toString() 	// "Symbol(foo)"

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

let s1 = Symbol('foo');

s1.description // "foo"

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

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

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

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

let sym = Symbol('My symbol');

sym + 2 		// TypeError
String(sym) 	// 'Symbol(My symbol)'
sym.toString() 	// 'Symbol(My symbol)'
Boolean(sym) 	// true
Number(sym) 	// TypeError

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 值也必须放在方括号之中。否则键名就是字符串，而不是其代表的Symbol 值。
还有一点需要注意，Symbol 值作为属性名时，该属性还是公开属性，不是私有属性。

Symbol 作为属性名，遍历对象时，该属性不会出现在for…in、for…of循环中，也不会被Object.keys()、Object.getOwnPropertyNames()、JSON.stringify()返回。但是，它也不是私有属性，有一个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)]

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

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

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

Symbol.for()方法接受一个字符串作为参数，然后搜索有没有以该参数作为名称的 Symbol 值。如果有，就返回这个 Symbol 值，否则就新建一个以该字符串为名称的 Symbol 值，并将其注册到全局。（登记机制）

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

s1 === s2 // true

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

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

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