ES6 新特征之Symbol

ES6 中除了 JavaScript 中几种基本的数据类型，Number、String、Boolean、Object、null、undefined 以外，还新引入了一种新的原始数据类型 Symbol，表示独一无二的值，属于类字符串数据类型，可以用来定义对象的唯一属性名。

基本使用

ES5 的对象属性名都是字符串，这容易造成属性名的冲突。而 ES6 中新引入的 Symbol 类型可以解决这个问题。Symbol 值是通过 Symbol 函数来生成的，可以用来定义对象的唯一属性名。属于 Symbol 类型的属性名，都是独一无二的，可以保证不会与其他属性名产生冲突。

示例：

let sym = Symbol();
console.log(typeof sym);  // 输出：symbol

上述代码中，变量 sym 就是一个独一无二的值。使用 typeof 运算符可以知道，sym 是 Symbol 数据类型

需要注意的是，Symbol 函数前不能使用 new 命令，否则会报错。因为 Symbol 是原始数据类型，不是对象。

Symbol 函数可以接受一个字符串作为参数，为新创建的 Symbol 提供描述，用来显示在控制台或者作为字符串的时候使用，便于区分。

示例：

let sym1 = Symbol(11);
let sym2 = Symbol('xkd');

console.log(sym1); // 输出：Symbol(11)
console.log(sym2); // 输出：Symbol(xkd)
console.log(sym1 === sym2);  // 输出：false

上述代码中，sym1 和 sym2 是两个 Symbol 值，如果不加参数，则它们的输出都为Symbol()，不利于区分。

但是相同的参数 Symbol() 返回的值也是不相等的，我们来看一下：

let sym1 = Symbol('xkd');
let sym2 = Symbol('xkd');

console.log(sym1 === sym2); // 输出：false

Symbol不能参与运算

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

示例：

例如下面代码中使用字符串类型数据 hello 与 Symbol 类型数据 sym 相加，会报错：

let sym = Symbol('xkd');
console.log('hello' + sym);

// 报错信息：TypeError: Cannot convert a Symbol value to a string

类型转换

Symbol 类型的值可以转换为字符串或者布尔类型的值。

示例：

将 Symbol 值显示转换为字符串：

let sym = Symbol('xkd');
console.log(typeof String(sym));    // 输出：string
console.log(typeof sym.toString()); // 输出：string

将 Symbol 值显示转换为布尔值：

let symbol = Symbol();
console.log(typeof Boolean(symbol));
// 输出: boolean

Symbol.prototype.description

在创建 Symbol 时可以添加一个描述，我们通过 description 属性可以获取描述内容。这个属性是 ES2019 中新增的实例属性。

示例：

例如下面代码中，'你好，侠课岛！'就是 sym 的描述：

const sym = Symbol('你好，侠课岛！');
console.log(sym.description);
// 输出: 你好，侠课岛！

作为对象属性名

Symbol 可以作为标识符，用于对象的属性名，这样可以确保对象中不会出现同名的属性。

示例：

let sym = Symbol();
let obj = {};
obj[sym] = 'xkd';
console.log(obj);  // 输出：{ [Symbol()]: 'xkd' }

上述代码其实还有两种写法，第一种写法为：

let sym = Symbol();
let obj = {
    [sym]: 'xkd'
};
console.log(obj);  // 输出：{ [Symbol()]: 'xkd' }

第二种写法为：

let sym = Symbol();
let obj = {};
Object.defineProperty(obj, sym, {value: 'xkd'});
console.log(obj);  // 输出：{ [Symbol()]: 'xkd' }

以上三种写法都能得到一样的结果。

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

示例：

const sym = Symbol();
const obj = {};

obj.sym = 'xkd';
console.log(obj[sym]);   // 输出：undefined
console.log(obj['sym']); // 输出：xkd

属性遍历

在遍历对象时，Symbol 作为属性名不会出现在 for...in、for...of 循环中，也不会被 Object.keys()、Object.getOwnPropertyNames()、JSON.stringify() 返回。它们会把 Symbol 过滤掉，但是我们可以有两种方法可以获取所有的 Symbol 属性名。

• 方法一：使用 Object.getOwnPropertySymbols 方法：

const obj = {};
let sym1 = Symbol('111');
let sym2 = Symbol('222');
obj[sym1] = '111';
obj[sym2] = '222';
console.log(Object.getOwnPropertySymbols(obj));
// 输出: [ Symbol(111), Symbol(222) ]

• 方法二：使用 Reflect.ownKeys 方法：

const obj = {};
let sym1 = Symbol('111');
let sym2 = Symbol('222');
obj[sym1] = '111';
obj[sym2] = '222';
console.log(Reflect.ownKeys(obj));
// 输出: [ Symbol(111), Symbol(222) ]

Symbol.for()方法

Symbol.for() 方法是唯一一个能让两个 Symbol 相等的方法，寻找全局环境下某个描述下面的这个 Symbol，如果找到了那么就返回这个 Symbol，否则就会生成一个新的 Symbol，也就是返回当前索引 Symbol。

示例：

let symbol1 = Symbol.for('xkd');
let symbol2 = Symbol.for('xkd');
console.log(symbol1 === symbol2);
// 输出：true

Symbol.keyFor()方法

Symbol.keyFor() 方法可以返回已登记的 Symbol 的 key。

示例：

let syb1 = Symbol.for("xkd");
console.log(Symbol.keyFor(syb1));
// 输出: xkd

let syb2 = Symbol("xkd");
console.log(Symbol.keyFor(syb2));
// 输出: undefined