es6学习4：Symbol

 参考学习：2.3 ES6 Symbol | 菜鸟教程

概述

ES6 引入了一种新的原始数据类型 Symbol ，表示独一无二的值，最大的用法是用来定义对象的唯一属性名。

ES6 数据类型除了 Number 、 String 、 Boolean 、 Object、 null 和 undefined ，还新增了 Symbol 。

基本用法

Symbol 函数栈不能用 new 命令，因为 Symbol 是原始数据类型，不是对象。可以接受一个字符串作为参数，为新创建的 Symbol 提供描述，用来显示在控制台或者作为字符串的时候使用，便于区分。（ JavaScript 的 Symbol 是唯一的。即使使用相同的描述字符串创建，也不会存在两个相等的 Symbol 对象。）

let sy = Symbol("KK");//创建一个新的Symbol对象
console.log(sy);   // Symbol(KK)
typeof(sy);        // "symbol"
let symbol1 = Symbol('description1');
console.log(symbol1); //Symbol(description1)

// 相同参数 Symbol() 返回的值不相等
let sy1 = Symbol("kk"); 
sy === sy1;       // false

使用场景

作为属性名

用法

由于每一个 Symbol 的值都是不相等的，所以 Symbol 作为对象的属性名(键)，可以保证属性不重名。

let sy = Symbol("key1");

//写法1:直接赋值
let syObject = {};
syObject[sy] = "kk";
console.log(syObject);//{Symbol(key1):"kk"}
console.log(syObject[sy]); //kk

//写法2
let syObject = {
    [sy] : "kk"
};
console.log(syObject); //{Symbol(key1):"kk"}
 
// 写法3
let syObject = {};
Object.defineProperty(syObject, sy, {value: "kk"});
console.log(syObject);   // {Symbol(key1): "kk"}

Symbol 作为对象属性名时不能用.运算符，要用方括号。因为.运算符后面是字符串，所以取到的是字符串 sy 属性，而不是 Symbol 值 sy 属性。

let sy = Symbol("key1");
let syObject = {};
syObject[sy] = "kk";
 
syObject[sy];  // "kk"
syObject.sy;   // undefined(无法使用描述访问)

注意点

Symbol 值作为属性名时，该属性是公有属性不是私有属性，可以在类的外部访问。但是不会出现在 for...in 、 for...of 的循环中，也不会被 Object.keys() 、 Object.getOwnPropertyNames() 返回。如果要读取到一个对象的 Symbol 属性，可以通过 Object.getOwnPropertySymbols() 和 Reflect.ownKeys() 取到。

let sy = Symbol("key1");
let syObject = {};
syObject[sy] = "kk";
console.log(syObject);//{Symbol(key1): "kk"}
 
for (let i in syObject) {
  console.log(i);
}    // 无输出，Symbol 类型的值默认情况下是不可枚举
 
Object.keys(syObject);                     // []
Object.getOwnPropertySymbols(syObject);    // [Symbol(key1)]
Reflect.ownKeys(syObject);                 // [Symbol(key1)]
const symbols = Object.getOwnPropertySymbols(syObject);
for (const symbol of symbols) {
  console.log(symbol, syObject[symbol]); // 输出：Symbol(key1) kk
}

唯一性优势

1. 库中避免命名冲突：

假设你正在构建一个允许用户扩展其功能的 JavaScript 库。如果使用常规字符串作为内部属性，则用户定义同名属性时存在命名冲突的风险。Symbol 完全消除了这种风险。

const myLibrary = {};

const PRIVATE_DATA = Symbol('privateData'); // 唯一的 Symbol

myLibrary.setData = function(data) {
  this[PRIVATE_DATA] = data;
};

myLibrary.getData = function() {
  return this[PRIVATE_DATA];
};

// 用户代码无法意外覆盖 PRIVATE_DATA
myLibrary.setData("secret");
console.log(myLibrary.getData()); // 输出：secret
console.log(myLibrary.PRIVATE_DATA); // undefined; 无法直接访问它

myLibrary.someOtherProperty = "test"; // 这不会与 Symbol 属性冲突

2.独特的事件处理程序：

在具有多个事件监听器的场景中，使用 Symbol 作为事件名称可以防止意外覆盖事件处理程序。

const element = document.createElement('div');//创建一个新的 <div> 元素
const myEvent = Symbol('myCustomEvent');

element.addEventListener(myEvent, () => console.log('My custom event!'));
element.dispatchEvent(new CustomEvent(myEvent)); // 触发事件

// 另一个事件处理程序，不会覆盖 `myEvent` 事件处理程序
element.addEventListener('click', () => console.log('click event'));

element.click(); // 触发 click 事件

使用 Symbol 作为事件类型避免了与其他事件（例如 'click'，'mouseover' 等）发生命名冲突。 即使你无意中也使用了 'myCustomEvent' 作为其他事件的名称，也不会与这个自定义事件冲突，因为 Symbol myEvent 和字符串 'myCustomEvent' 是完全不同的类型和值。 这保证了自定义事件的唯一性。

Symbol.for()

Symbol.for() 类似单例模式，首先会在全局搜索被登记的 Symbol 中是否有该字符串参数作为名称的 Symbol 值，如果有即返回该 Symbol 值，若没有则新建并返回一个以该字符串参数为名称的 Symbol 值，并登记在全局环境中供搜索。

let yellow = Symbol("Yellow");
let yellow1 = Symbol.for("Yellow");
yellow === yellow1;      // false
 
let yellow2 = Symbol.for("Yellow");
yellow1 === yellow2;     // true

Symbol.keyFor()

Symbol.keyFor() 返回一个已登记的 Symbol 类型值的 key ，用来检测该字符串参数作为名称的 Symbol 值是否已被登记。

let yellow1 = Symbol.for("Yellow");
Symbol.keyFor(yellow1);    // "Yellow"