Skip to content

Symbol 唯一类型冲突

快速摘要

你比较了两个有相同描述的 Symbol 但它们是不同的唯一 symbol —— Symbol() 始终创建唯一身份。

为什么发生

  • 你在不同模块中用 Symbol('key') 创建了两个 symbol 并比较 —— 它们不相等

  • 你在一处用 Symbol.for('key') 另一处用 Symbol('key'),混合了全局和本地 symbol

  • 用作属性键的 symbol 被重新创建而非共享,因此属性永远找不到

最小示例

✗ 错误代码
// module-a.ts
export const key = Symbol('id');
// module-b.ts
const key = Symbol('id'); // different symbol!
const obj = { [key]: 'value' };
console.log(obj[Symbol('id')]); // undefined — different symbol
✓ 修复代码
// shared.ts
export const idKey = Symbol.for('id'); // global symbol
// module-a.ts
import { idKey } from './shared';
// module-b.ts
import { idKey } from './shared';
const obj = { [idKey]: 'value' };
console.log(obj[idKey]); // 'value' — same symbol

使用 Symbol.for() 创建全局共享 symbol,两个模块引用同一 symbol,属性可找到。

如何诊断

  • 记录 symbol1 === symbol2 检查它们是否是同一 symbol 实例

  • 检查 symbol 是用 Symbol()(唯一)还是 Symbol.for()(全局注册表)创建

  • 使用 symbol.description 比较描述,但记住相等描述不意味着相等 symbol

如何修复

  • 对需要跨模块共享的 symbol 使用 Symbol.for('key') —— 它使用全局注册表

  • 从共享模块导出 symbol 并在各处导入而非重新创建

  • 如果跨模块共享需要且 symbol 身份不重要则使用字符串键

如何预防

  • 对共享 symbol 使用 Symbol.for(),对私有 symbol 使用 Symbol() —— 永远不对同一键混合两者

  • 导出和导入 symbol 常量而非在每个模块中重新创建

相关资源

相关术语

相关课程

← 返回语言