Symbol(es6)

ES6总结系列之 Symbol 篇

---

ES6 引入了一种新的原始数据类型Symbol，表示独一无二的值。可以从根本上防止属性名的冲突，Symbol 值通过Symbol函数生成

let s = Symbol();

typeof s
// "symbol"

1.Symbol是第七种数据类型，前六种为：underfined, null,String, Boolean, Number, Object

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

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

let s1 = Symbol('foo');
let s2 = Symbol('bar');

s1 // Symbol(foo)
s2 // Symbol(bar)

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

4.Symbol参数只是描述，相同参数返回的值是不相等的

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

s1 === s2 // false

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

s1 === s2 // false

5.Symbol 值不能与其他类型的值进行运算，会报错。

let sym = Symbol('My symbol');

"your symbol is " + sym
// TypeError: can't convert symbol to string

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

const obj = {
  toString() {
    return 'abc';
  }
};
const sym = Symbol(obj);
sym // Symbol(abc)

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

let sym = Symbol('My symbol');

String(sym) // 'Symbol(My symbol)'
sym.toString() // 'Symbol(My symbol)'

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

if (sym) {
  // ...
}

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

8.读取描述一般要将symbol转化为字符串，ES2019提供了一个实例属性description，直接返回Symbol 的描述

const sym = Symbol('foo');

sym.description // "foo"

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

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

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

因为点运算符后面总是字符串，所以不会读取mySymbol作为标识名所指代的那个值，导致a的属性名实际上是一个字符串，而不是一个 Symbol 值。

10.同理，对象的内部，使用 Symbol 值定义属性时，Symbol 值必须放在方括号之中。

let s = Symbol();

let obj = {
  [s]: function (arg) { ... }
};

obj[s](123);

11.Symbol 值作为属性名时，该属性还是公开属性，不是私有属性。

12.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)]

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

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

s1 === s2 // true

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

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

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

Symbol()写法没有登记机制
比如，如果你调用Symbol.for("cat")30 次，每次都会返回同一个 Symbol 值,但是调用Symbol("cat")30 次，会返回 30 个不同的 Symbol 值。

总结要点

1. Symbol是第七种数据类型
2. Symbol函数前不能使用new命令
3. Symbol函数接收的参数，主要是为了在控制台或转化为字符串时容易区分
4. Symbol参数只是描述，相同参数返回的值是不相等的
5. Symbol 值不能与其他类型的值进行运算，会报错
6. 对象作为Symbol参数时，会先调用该对象的toString转为字符串
7. Symbol 值可以显式转为字符串，也可以转为布尔值，但是不能转为数值。
8. 读取描述一般要将symbol转化为字符串，ES2019提供了一个实例属性description，直接返回Symbol 的描述
9. 读取或定义一个Symbol值为属性名时，要用中括号[]，不能用点.
10. Symbol(描述)没有登记机制，Symbol.for(描述)有登记机制
11. 可用Object.getOwnPropertySymbols()方法，获取指定对象的所有 Symbol 属性名。

---

• 个人Github，欢迎star^_^
• ES6总结系列参考自阮一峰《ECMAScript6入门》