如何使用Symbol创建唯一对象键名-小浪学习网

symbol解决了对象键名冲突问题，模拟私有属性，支持元编程。1. symbol创建唯一键，避免不同模块间属性覆盖；2. symbol键默认不可枚举，隐藏内部属性；3. 内置知名symbol扩展对象行为。symbol()每次生成唯一值，适合局部唯一键；symbol.for()在全局注册表中查找或创建symbol，确保跨模块共享。访问symbol键需用方括号语法并持有symbol引用，遍历可用Object.getownpropertysymbols或reflect.ownkeys。二者区别在于唯一性与作用域，使用场景不同：symbol()用于模块内部私有属性，symbol.for()用于跨模块共享标识。

如何使用Symbol创建唯一对象键名

在JavaScript中，Symbol提供了一种创建真正唯一对象键名的方式。它能有效避免在不同代码模块或库之间因键名冲突而导致的属性覆盖问题，尤其在需要为对象添加一些不希望被常规遍历发现的内部或元数据属性时，Symbol显得尤为重要。

如何使用Symbol创建唯一对象键名

解决方案

使用Symbol创建唯一对象键名非常直接。你只需要调用Symbol()构造函数，它每次都会返回一个独一无二的值。然后，你可以将这个Symbol值作为对象的属性键来使用。

// 创建一个唯一的Symbol const myUniqueKey = Symbol('descriptionForDebugging');  // 创建一个对象 const myObject = {};  // 使用Symbol作为键名添加属性 myObject[myUniqueKey] = '这是一个通过Symbol键名存储的值'; myObject['regularkey'] = '这是一个常规的字符串键名';  console.log(myObject[myUniqueKey]); // 输出: 这是一个通过Symbol键名存储的值 console.log(myObject['regularKey']); // 输出: 这是一个常规的字符串键名  // 即使描述相同，每次调用Symbol()都会生成不同的Symbol值 const anotherUniqueKey = Symbol('descriptionForDebugging'); console.log(myUniqueKey === anotherUniqueKey); // 输出: false

这种机制确保了即使你在代码的不同部分创建了看似相同的Symbol（比如描述字符串一样），它们在作为键名时依然是互不干扰的独立存在。

如何使用Symbol创建唯一对象键名

为什么我们需要Symbol来创建唯一键名？它解决了哪些实际问题？

说实话，刚接触Symbol的时候，我心里也犯嘀咕：字符串键名用了这么多年不也挺好吗？直到后来在一些大型项目或需要集成第三方库的场景下，才真正体会到Symbol的价值。它主要解决了以下几个令人头疼的问题：

最直接的，就是命名冲突。想象一下，你正在开发一个大型应用，或者在使用多个第三方库。每个模块或库都可能往同一个对象上挂载属性。如果大家都用字符串作为键名，比如都想用’id’或者’status’，那冲突几乎是必然的。一个模块不小心就覆盖了另一个模块的属性，排查起来简直是噩梦。Symbol的出现，就像给每个属性一个独一无二的“身份证号”，从根本上杜绝了这种无意间的覆盖。

如何使用Symbol创建唯一对象键名

其次，它提供了一种模拟“私有”属性的手段。虽然JavaScript本身并没有真正的私有属性（ES2022的私有类字段除外），但Symbol键名默认是不可枚举的。这意味着它们不会出现在for…in循环、Object.keys()、Object.values()或json.stringify()的结果中。这对于我们想给对象添加一些内部使用的、不希望被外部轻易发现或修改的元数据或状态，简直是完美。它不是绝对的私有，但提供了一种有效的“隐藏”机制，让代码更健壮，也减少了外部误用的风险。

最后，Symbol在元编程和扩展内置对象时也大放异彩。比如，JavaScript中很多内置的“知名Symbol”（Well-known Symbols），如Symbol.iterator、Symbol.toStringTag等，就是用来改变或定义对象的特定行为的。通过它们，我们可以为自定义对象赋予迭代能力，或者改变Object.prototype.toString的默认输出。这在不污染全局命名空间的前提下，为对象增加了强大的扩展能力。对我而言，Symbol不仅仅是解决了冲突，它更是提供了一种更优雅、更安全的编程范式。

Symbol键名与字符串键名在使用和行为上有何不同？如何遍历或访问Symbol键？

Symbol键名和字符串键名在使用上看起来都是对象属性的键，但它们的内在行为和访问方式却有着本质区别。理解这些差异，对于我们正确地运用Symbol至关重要。

核心区别在于它们的唯一性和可枚举性。

唯一性： 字符串键名是字面量，只要字符串内容相同，它们就是同一个键。而Symbol()每次调用都会生成一个全新的、独一无二的Symbol值，即使它们的描述字符串完全一样。
可枚举性： 这是Symbol键名最显著的特性之一。默认情况下，Symbol键是不可枚举的。这意味着传统的遍历方法，比如for…in循环、Object.keys()、Object.values()以及JSON.stringify()，都不会发现或包含Symbol键。字符串键名则通常是可枚举的（除非显式设置为不可枚举）。

那么，既然它们“隐藏”起来了，我们该如何访问或遍历Symbol键呢？

要访问一个Symbol键的值，你必须持有那个Symbol本身。你不能像字符串键那样用点语法（obj.key），而必须使用方括号语法：obj[mySymbol]。

const secretKey = Symbol('secret'); const myData = {   name: 'Alice',   [secretKey]: 'This is a hidden secret!' };  console.log(myData.name); // 'Alice' console.log(myData[secretKey]); // 'This is a hidden secret!' // console.log(myData.secretKey); // undefined，因为这不是一个字符串键

至于遍历或获取Symbol键，JavaScript提供了专门的方法：

Object.getOwnPropertySymbols(obj)： 这是最直接的方法，它会返回一个数组，包含对象自身的所有Symbol属性键。

const sym1 = Symbol('sym1'); const sym2 = Symbol('sym2'); const obj = {   a: 1,   b: 2, };  const symbolKeys = Object.getOwnPropertySymbols(obj); console.log(symbolKeys); // [Symbol(sym1), Symbol(sym2)]  for (const key of symbolKeys) {   console.log(`${key.toString()}: ${obj[key]}`); } // 输出: // Symbol(sym1): value1 // Symbol(sym2): value2

Reflect.ownKeys(obj)： 这个方法更全面，它会返回一个数组，包含对象自身的所有属性键，无论是字符串键还是Symbol键。

const allKeys = Reflect.ownKeys(obj); console.log(allKeys); // ['a', Symbol(sym1), 'b', Symbol(sym2)]  for (const key of allKeys) {   console.log(`${String(key)}: ${obj[key]}`); } // 输出: // a: 1 // Symbol(sym1): value1 // b: 2 // Symbol(sym2): value2

理解这些差异非常关键。如果你想确保某个属性不会被意外地遍历或序列化，使用Symbol键就是个不错的选择。而当你需要检查对象的所有属性，包括那些“隐藏”的Symbol属性时，Object.getOwnPropertySymbols或Reflect.ownKeys就是你的得力助手。

Symbol.for() 和 Symbol() 有什么区别？什么时候应该使用它们？

Symbol()和Symbol.for()都用于创建Symbol值，但它们之间存在一个关键的区别，这决定了它们各自的适用场景。这个区别在于它们是否使用一个全局的Symbol注册表。

Symbol(description)：
- 行为： 每次调用Symbol()都会创建一个全新且唯一的Symbol值。即使你传入相同的描述字符串，它们也是不同的Symbol。
- 特点： 这些Symbol是私有的，不注册到任何全局注册表中。它们只在你创建它们的代码范围内是可访问的。
- 用例：
  - 当你需要一个绝对唯一的键，用于某个特定对象实例或模块内部，以防止任何外部或无意的冲突时。
  - 例如，为一个对象添加一个内部状态标识，这个标识只在这个对象实例的生命周期内有效，不希望被其他地方复用。
  - 模拟私有属性，或者为特定数据结构添加不希望被常规遍历发现的元数据。
```
const mySymbol1 = Symbol('myKey'); const mySymbol2 = Symbol('myKey'); console.log(mySymbol1 === mySymbol2); // false (它们是不同的Symbol)
```
Symbol.for(keyString)：
- 行为： Symbol.for()会首先在全局Symbol注册表中查找是否存在一个使用keyString作为键的Symbol。
  - 如果找到了，它就返回那个已存在的Symbol。
  - 如果没有找到，它会创建一个新的Symbol，并使用keyString作为键将其注册到全局注册表中，然后返回这个新的Symbol。
- 特点： Symbol.for()创建的Symbol是共享的。只要keyString相同，无论你在代码的哪个部分，甚至在不同的JavaScript运行环境（如iframe之间），都能获取到同一个Symbol。
- Symbol.keyFor(symbol)： 这是一个配套的方法，用于从全局注册表中获取一个已注册Symbol的keyString。如果Symbol未注册，则返回undefined。
- 用例：
  - 当你需要在应用程序的不同部分或不同模块之间共享同一个Symbol时。例如，定义一个跨模块共享的“钩子”或“协议”，确保所有模块都引用的是同一个Symbol。
  - 在需要跨iframe或Web Workers通信时，确保双方能够识别和使用相同的Symbol。
  - JavaScript的许多“知名Symbol”就是通过这种机制实现的，它们是全局共享的，以便所有代码都能遵循相同的行为约定。
```
const globalSymbol1 = Symbol.for('sharedKey'); const globalSymbol2 = Symbol.for('sharedKey'); console.log(globalSymbol1 === globalSymbol2); // true (它们是同一个Symbol)  console.log(Symbol.keyFor(globalSymbol1)); // 'sharedKey' console.log(Symbol.keyFor(mySymbol1)); // undefined (mySymbol1 未注册)
```

在我看来，Symbol()更像是为每个独立实例或模块提供一个“私有标签”，而Symbol.for()则更像是提供一个“公共协议”或“全局标识”。如果你只是想避免局部命名冲突，用Symbol()就足够了。但如果你需要跨越模块边界，让不同的代码段能识别并操作同一个Symbol定义的行为，那么Symbol.for()才是正确的选择。混淆这两者可能导致预期之外的行为，比如本以为是私有的Symbol却被全局共享了，或者本该共享的Symbol却变成了互不相干的独立个体。

文章版权归作者所有，未经允许请勿转载。

THE END