Symbol 与知名符号
进阶
Symbol 是 ES6 引入的原始类型,每次调用 Symbol() 都返回一个全新且唯一的值,即使描述字符串完全相同。
它最常见的用途是作为对象的属性键,绕开字符串键的命名冲突;这类键不会出现在 for...in、
Object.keys 与 JSON.stringify 的结果里,因此适合存放库内部的元数据,也适合定义"半私有"的约定字段。
需要跨模块共享同一个 Symbol 时使用 Symbol.for(key),它走全局注册表,Symbol.keyFor 可以反查键名。
比自定义 Symbol 更重要的是知名符号(well-known symbols):语言内部会主动查找这些键。实现
Symbol.iterator 的对象可以被 for...of、展开运算符与解构消费;
Symbol.toPrimitive 决定对象转原始值的规则,参数 hint 为 "number"、
"string" 或 "default";Symbol.toStringTag 影响
Object.prototype.toString 的输出,让 [object Object] 变成 [object Money]。
同族的还有 Symbol.hasInstance、Symbol.asyncIterator、Symbol.species 等。
工程视角上,知名符号是"实现协议"而不是"调用 API"。当你写一个自定义集合类时,实现
Symbol.iterator 比额外暴露一个 forEach 更符合语言习惯,因为它自动获得所有依赖迭代协议的能力。
需要注意:Symbol 不能 new,也不能隐式转字符串(Symbol() + '' 会抛 TypeError),
必须显式使用 String(sym) 或读取 sym.description。
const uid = Symbol('id');
const uid2 = Symbol('id');
console.log(uid === uid2); // false,描述相同也互不相等
console.log(uid.toString()); // "Symbol(id)"
const user = { name: '林知远', [uid]: 'U-1024', age: 28 };
console.log(Object.keys(user)); // ["name", "age"],Symbol 键不出现
console.log(JSON.stringify(user)); // {"name":"林知远","age":28}
// Symbol.for 使用全局注册表,同名会复用同一个 Symbol
const g1 = Symbol.for('app.theme');
const g2 = Symbol.for('app.theme');
console.log(g1 === g2); // true
console.log(Symbol.keyFor(g1)); // "app.theme"
// Symbol.toPrimitive:自定义对象转原始值的规则
const price = {
amount: 128,
[Symbol.toPrimitive](hint) {
return hint === 'string' ? `¥${this.amount}` : this.amount;
}
};
console.log(`${price}`); // "¥128"
console.log(price + 2); // 130
// Symbol.toStringTag:影响 Object.prototype.toString 的返回值
class Money {
get [Symbol.toStringTag]() { return 'Money'; }
}
console.log(Object.prototype.toString.call(new Money())); // "[object Money]"
Symbol 键会被序列化丢弃。用 Symbol 存放的数据经过 JSON.stringify、
structuredClone 的 JSON 路径或网络传输后会消失,不要用它承载需要持久化的业务字段。