ES2023中Symbol.for在WeakMap报错原因及正确使用方法

问题场景 #

先看你提供的代码和报错截图：

const key = Symbol('b')
const weak = new WeakMap()
weak.set(key) // 实际也会触发类型错误

const key = Symbol.for('a')
const weak = new WeakMap()
weak.set(key) // 报错：Invalid value used as weak map key

报错原因 #

WeakMap的核心约束是：键必须是可被垃圾回收的对象类型。而不管是Symbol()还是Symbol.for()创建的Symbol，都属于ECMAScript的基本数据类型，并非对象，因此完全不符合WeakMap对键的类型要求，两者作为WeakMap键都会触发相同的错误。

你可能误以为Symbol('b')可以正常使用，实际上是测试时未严格校验——它同样会抛出类型错误。

Symbol.for的正确用法 #

Symbol.for()的核心价值是创建或复用全局注册表中的Symbol实例，和普通Symbol()的核心区别：

• Symbol()每次调用都会生成全新的、不共享的Symbol，即使描述符完全相同；
• Symbol.for(key)会先在全局Symbol注册表中查找以key为标识的Symbol，存在则直接返回该实例，不存在才创建新Symbol并注册到全局。

典型适用场景：

• 跨模块、跨作用域共享唯一标识，比如作为对象的私有属性键，确保不同模块访问的是同一个Symbol；
• 定义全局唯一的符号值，比如自定义迭代器、Symbol.hasInstance等场景中，需要全局一致的标识。

示例代码：

// 模块A
const sharedKey = Symbol.for('global.unique.key')
const data = { [sharedKey]: '跨模块共享数据' }

// 模块B
const sameKey = Symbol.for('global.unique.key')
console.log(data[sameKey]) // 输出：跨模块共享数据（两个Symbol是同一实例）

结合Symbol与WeakMap的正确方式 #

如果需要用Symbol相关的值作为WeakMap的键，必须将Symbol包装为对象（对象属于可垃圾回收的类型）：

const keyObj = Object(Symbol.for('a')) // 将Symbol包装成对象
const weakMap = new WeakMap()
weakMap.set(keyObj, '关联数据')

内容的提问来源于stack exchange，提问作者Liujing