Skip to content
全栈开发

JavaScript中的Symbol类型

JavaScript 在 ES6 (ECMAScript 2015) 中引入了一种新的原始数据类型：Symbol。这种类型的值是唯一且不可变的。它的主要设计目的是作为对象属性的标识符，以避免属性名冲突。与其他原始类型（如 String, Number, Boolean, Null, Undefined, BigInt）不同，Symbol 类型没有字面量表示形式，必须通过 Symbol() 函数来创建。

什么是Symbol？

Symbol 是一种独特的、不可变的数据类型。每次调用 Symbol() 函数都会返回一个全新的、独一无二的 Symbol 值。这意味着即使你使用相同的描述字符串来创建两个 Symbol，它们也是不相等的。

let sym1 = Symbol();
let sym2 = Symbol('description'); // 'description' 是可选的描述，主要用于调试
let sym3 = Symbol('description');


console.log(typeof sym1); // "symbol"
console.log(sym1 === sym2); // false
console.log(sym2 === sym3); // false

这个描述字符串并不会影响 Symbol 值的唯一性，它仅仅是一个标签，方便在代码调试或输出时区分不同的 Symbol。需要注意的是，Symbol 不是一个构造函数，不能使用 new Symbol() 来创建，否则会抛出 TypeError。

为何使用Symbols？

Symbol 最核心的用途是作为对象属性的键（key）。由于每个 Symbol 值都是唯一的，使用它作为属性键可以有效防止属性名冲突，尤其是在多人协作或者需要向现有对象添加属性而不想覆盖原有属性或方法（例如来自第三方库或JavaScript内置对象的属性）的场景下。

想象一下，如果多个库或代码模块都想向同一个对象添加一个表示“ID”的属性，如果都使用字符串 'id' 作为键，后添加的就会覆盖先前的，导致意外行为。使用 Symbol 可以完美解决这个问题。

const userID = Symbol('userID');
const sessionID = Symbol('sessionID');


let user = {
  name: 'Alice',
  [userID]: 'u123', // 使用Symbol作为属性键
  [sessionID]: 's789'
};


// 添加另一个可能冲突的属性，但使用Symbol则不会冲突
const libraryID = Symbol('id');
user[libraryID] = 'lib-abc';


console.log(user[userID]); // 'u123'
console.log(user[libraryID]); // 'lib-abc'
// 如果使用字符串 'id'，可能会覆盖或被覆盖

这种机制特别适用于定义对象的“元编程”行为，或者附加一些不希望被常规迭代（如 for...in）轻易访问到的内部状态或方法。

Symbols与对象属性

使用 Symbol 作为键的属性被称为符号属性（Symbol-keyed properties）。这些属性与使用字符串作为键的属性在某些对象操作中表现不同。例如，符号属性不会被 for...in 循环枚举，也不会被 Object.keys()、Object.getOwnPropertyNames() 或 JSON.stringify() 返回。

const symKey = Symbol('myKey');
let obj = {
  regularKey: 'value1',
  [symKey]: 'value2'
};


for (let key in obj) {
  console.log(key); // 只输出 'regularKey'
}


console.log(Object.keys(obj)); // ['regularKey']
console.log(Object.getOwnPropertyNames(obj)); // ['regularKey']
console.log(JSON.stringify(obj)); // {"regularKey":"value1"}

如果需要获取对象上的符号属性键，可以使用 Object.getOwnPropertySymbols() 方法。它会返回一个包含对象自身所有符号属性键的数组。

console.log(Object.getOwnPropertySymbols(obj)); // [Symbol(myKey)]

若想获取对象上所有的自有属性键（包括字符串和符号），可以使用 Reflect.ownKeys() 方法。

console.log(Reflect.ownKeys(obj)); // ['regularKey', Symbol(myKey)]

这种“隐藏”特性使得 Symbol 成为实现对象内部逻辑或状态而又不干扰常规属性操作的理想选择。

众所周知的Symbols（Well-Known Symbols）

JavaScript 自身定义了一些内置的、具有特殊含义的 Symbol 值，它们作为 Symbol 对象的静态属性存在，被称为“众所周知的 Symbols”（Well-Known Symbols）。这些 Symbol 用于暴露语言内部的算法和行为，允许开发者通过在自定义对象上定义以这些 Symbol 为键的属性来“钩入”或定制 JavaScript 的核心操作。

一些常见的例子包括：

  • Symbol.iterator: 使对象可迭代（用于 for...of 循环）。
  • Symbol.toStringTag: 定制 Object.prototype.toString.call() 的输出。
  • Symbol.hasInstance: 定制 instanceof 操作符的行为。
  • Symbol.search, Symbol.match, Symbol.replace, Symbol.split: 定制字符串相应方法的行为。

例如，通过在对象上实现 Symbol.iterator 方法，可以让该对象支持 for...of 迭代。

let collection = {
  items: [10, 20, 30],
  [Symbol.iterator]: function*() {
    for (let item of this.items) {
      yield item;
    }
  }
};


for (let value of collection) {
  console.log(value); // 输出 10, 20, 30
}

全局Symbol注册表

除了每次都创建唯一的 Symbol 外，JavaScript 还提供了一个全局 Symbol 注册表。可以使用 Symbol.for(key) 方法来创建或获取注册表中的 Symbol。如果给定 key 的 Symbol 已经存在于注册表中，则返回该 Symbol；否则，创建一个新的 Symbol，使用该 key 注册，并返回这个新的 Symbol。

let symGlobal1 = Symbol.for('app.id');
let symGlobal2 = Symbol.for('app.id');


console.log(symGlobal1 === symGlobal2); // true，因为它们是同一个Symbol


let symLocal = Symbol('app.id');
console.log(symGlobal1 === symLocal); // false，Symbol()创建的是本地唯一Symbol

相对地，可以使用 Symbol.keyFor(sym) 方法来查找一个已注册 Symbol 的 key。如果该 Symbol 不在全局注册表中（例如通过 Symbol() 创建的），则返回 undefined。

console.log(Symbol.keyFor(symGlobal1)); // 'app.id'
console.log(Symbol.keyFor(symLocal)); // undefined

全局 Symbol 注册表主要用于在不同的代码域（例如不同的 <iframe> 或 Service Worker）之间共享 Symbol，或者在需要通过一个固定的标识符反复获取同一个 Symbol 的场景下使用。

graph LR
    subgraph "Symbol Creation"
        A["Symbol('desc')"] --> B(Unique Symbol 1);
        C["Symbol('desc')"] --> D("Unique Symbol 2");
        B -.-> E{"Not Equal"};
        D -.-> E;
    end


    subgraph "Global Symbol Registry"
        F["Symbol.for('key')"] --> G((Global Registry));
        H["Symbol.for('key')"] --> G;
        G -- Returns --> I(Shared Symbol);
        I -.-> J{Equal};
        I -.-> J;
        K["Symbol.keyFor(Shared Symbol)"] --> L("Returns 'key'");
        M["Symbol.keyFor(Unique Symbol 1)"] --> N(Returns undefined);
    end

小结

Symbol 作为 ES6 引入的一种新的原始数据类型，为 JavaScript 带来了重要的补充。它的核心特性是值的唯一性和不可变性，主要用于创建不会与其他属性名冲突的对象属性键。这对于避免命名冲突、实现内部状态或元编程能力至关重要。Symbol 属性在常规的对象枚举中默认隐藏，需要特定的方法（如 Object.getOwnPropertySymbols 或 Reflect.ownKeys）来访问。此外，JavaScript 还提供了“众所周知的 Symbols”来允许开发者定制语言的核心行为，以及一个全局 Symbol 注册表 (Symbol.for 和 Symbol.keyFor) 用于跨域共享或重用 Symbol。理解和适当地使用 Symbol，有助于编写更健壮、更模块化的 JavaScript 代码。