Symbol

首页 > ES6标准入门读书笔记 > Symbol

本文共--字阅读约--分钟 | 浏览: -- Last Updated: 2020-07-22

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

let s = Symbol();

typeof s
// "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 值。

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

注意，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 值可以显式转为字符串。Symbol 值也可以转为布尔值，但是不能转为数值。

let sym1 = Symbol('My symbol');

"your symbol is " + sym1
// TypeError: can't convert symbol to string
`your symbol is ${sym1}`
// TypeError: can't convert symbol to string

let sym2 = Symbol('My symbol');

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

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

if (sym3) {
  // ...
}

Number(sym3) // TypeError
sym3 + 2 // TypeError

作为属性名的 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 值作为对象属性名时，不能用点运算符。

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

// 这里的mySymbol 相当于是字符串属性名 而不是代表上面的Symbol类型的mySymbol
a.mySymbol = 'Hello!'; 

// 这里相当于是想取a的属性，属性名是mySymbol变量，即上面的Symbol类型 故无值
a[mySymbol] // undefined

// 这里相当于是 a.mySymbol = 'Hello!' 的set对应的get
a['mySymbol'] // "Hello!"

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

let s = Symbol();

let obj = {
  [s]: function (arg) { ... },
  // 或简写   
  [sym](arg){...}
};

obj[s](123);

属性名的遍历

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

Symbol.for()，Symbol.keyFor()

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

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

s1 === s2 // true

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

s1 === s2 // false

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

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

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

let s2 = Symbol("foo"); // 没有for 就是没登记
Symbol.keyFor(s2) // 没登记都返回undefined