js Symbol使用 | 北鱼IT

文章索引

在 JavaScript 中，Symbol 是一种独特且很有用的数据类型，引入于 ES6 (ECMAScript 2015)。它主要用于创建唯一的标识符，通常用来避免命名冲突，尤其是在对象属性或大型代码库中。让我为你详细解释一下它的概念和用法。

什么是 `Symbol`？

Symbol 是一种基本数据类型（primitive type），和其他类型（如 string、number、boolean 等）类似。它的核心特性是独一无二：每次调用 Symbol() 函数时，都会生成一个全新的、独一无二的值，即使描述字符串相同，结果也不相等。

例如：

const sym1 = Symbol('id');
const sym2 = Symbol('id');
console.log(sym1 === sym2); // false

const sym1 = Symbol('id');

const sym2 = Symbol('id');

console.log(sym1 === sym2); // false

尽管 sym1 和 sym2 都用 'id' 作为描述，但它们是完全不同的值。

创建 Symbol

你可以通过 Symbol() 函数创建：

const mySymbol = Symbol();

1	const mySymbol = Symbol();

或者带上一个描述（description），方便调试（描述不会影响 Symbol 的唯一性）：

const mySymbol = Symbol('my unique symbol');
console.log(mySymbol); // Symbol(my unique symbol)

1 2	const mySymbol = Symbol('my unique symbol'); console.log(mySymbol); // Symbol(my unique symbol)

主要用途

作为对象的唯一属性键
Symbol 最常见的用途是作为对象属性的键，避免属性名冲突。

   const sym = Symbol('key');
   const obj = {};
   obj[sym] = 'value';
   console.log(obj[sym]); // 'value'

const sym = Symbol('key');

const obj = {};

obj[sym] = 'value';

console.log(obj[sym]); // 'value'

用 Symbol 作为键时，属性不会出现在普通的枚举中（比如 for...in 循环），这让它很适合定义“隐藏”属性。

避免命名冲突
在多人协作或第三方库中，Symbol 可以确保你的属性名不会意外覆盖别人的代码。

   const libSymbol = Symbol('libProperty');
   const userObj = { name: 'Alice' };
   userObj[libSymbol] = 'hidden data';
   console.log(userObj.name); // 'Alice'
   console.log(userObj[libSymbol]); // 'hidden data'

const libSymbol = Symbol('libProperty');

const userObj = { name: 'Alice' };

userObj[libSymbol] = 'hidden data';

console.log(userObj.name); // 'Alice'

console.log(userObj[libSymbol]); // 'hidden data'

内置 Symbol
JavaScript 提供了一些内置的 Symbol（称为 “well-known Symbols”），用于定义语言内部行为。例如：

Symbol.iterator：定义对象的迭代器行为。
Symbol.toStringTag：自定义对象的 toString() 输出。
示例：

   const obj = {
     [Symbol.toStringTag]: 'MyObject'
   };
   console.log(Object.prototype.toString.call(obj)); // '[object MyObject]'

const obj = {

[Symbol.toStringTag]: 'MyObject'

};

console.log(Object.prototype.toString.call(obj)); // '[object MyObject]'

Symbol 的特性

唯一性：即使描述相同，每个 Symbol 都是独立的。
不可变且不可枚举：Symbol 属性不会出现在 Object.keys() 或 for...in 中，但可以用 Object.getOwnPropertySymbols() 获取。
不是构造函数：不能用 new Symbol() 创建，只能用 Symbol()。
类型转换：Symbol 不能隐式转换为字符串或数字，但可以用 .toString() 或 .description 获取描述。

  const sym = Symbol('test');
  console.log(sym.toString()); // 'Symbol(test)'
  console.log(sym.description); // 'test'

const sym = Symbol('test');

console.log(sym.toString()); // 'Symbol(test)'

console.log(sym.description); // 'test'

实际应用场景

假设你在开发一个游戏，玩家对象有多个属性，但你想添加一个“内部 ID”而不干扰其他属性：

const playerId = Symbol('playerId');
const player = {
  name: 'Hero',
  level: 10,
  [playerId]: 12345
};
console.log(player[playerId]); // 12345
for (let key in player) {
  console.log(key); // 只输出 'name' 和 'level'，不会输出 Symbol
}

const playerId = Symbol('playerId');

const player = {

name: 'Hero',

level: 10,

[playerId]: 12345

};

console.log(player[playerId]); // 12345

for (let key in player) {

console.log(key); // 只输出 'name' 和 'level'，不会输出 Symbol

}

注意事项

Symbol 不会被垃圾回收，除非显式丢弃对它的引用。
如果需要全局共享的 Symbol，可以使用 Symbol.for()，它会根据描述在全局 Symbol 注册表中查找或创建：

  const sym1 = Symbol.for('shared');
  const sym2 = Symbol.for('shared');
  console.log(sym1 === sym2); // true

const sym1 = Symbol.for('shared');

const sym2 = Symbol.for('shared');

console.log(sym1 === sym2); // true

总结

Symbol 是 JavaScript 中一个强大且灵活的工具，主要用于创建唯一标识符和“隐藏”属性。它在现代开发中非常有用，尤其是在需要高可控性和避免冲突的场景下。

什么是 Symbol？