在 JavaScript 中，Symbol 是一种原始数据类型，适合用于创建唯一的标识符。它主要用于避免命名冲突、保护对象的属性，以及实现元编程。

适用情况

  • 创建唯一的属性键：
    • 在对象中需要使用不会和其他属性冲突的键时，Symbol 是理想的选择。
    • 即使属性名称相同，每次创建的 Symbol 都是唯一的。
  • 隐藏属性：
    • Symbol 键属性是非可枚举的，不能被 for...in 或 Object.keys() 等列举出来，适合用于为对象添加“隐藏”属性。
  • 元编程：
    • JavaScript 提供了一些内建的 Symbol，例如 Symbol.iterator、Symbol.toStringTag，这些可以用于自定义对象的行为。

    范例 1：创建唯一键属性

    避免对象属性名称的命名冲突。

    const uniqueKey1 = Symbol("key");
    const uniqueKey2 = Symbol("key");

    const obj = {
    [uniqueKey1]: "Value for uniqueKey1",
    [uniqueKey2]: "Value for uniqueKey2",
    };

    console.log(obj[uniqueKey1]); // Value for uniqueKey1
    console.log(obj[uniqueKey2]); // Value for uniqueKey2

    // 无法使用常规方法获取 Symbol 键
    console.log(Object.keys(obj)); // []
    console.log(Object.getOwnPropertyNames(obj)); // []
    console.log(Object.getOwnPropertySymbols(obj)); // [ Symbol(key), Symbol(key) ]

    范例 2：实现隐藏属性

    使用 Symbol 添加对象属性，但不让它暴露在普通的属性枚举中。

    const secret = Symbol("secret");

    const user = {
    name: "Alice",
    age: 25,
    [secret]: "This is a hidden property",
    };

    console.log(user[secret]); // This is a hidden property

    // 不会被普通的方法列举出来
    for (const key in user) {
    console.log(key); // 只会输出 name 和 age
    }

    范例 3：用 Symbol 实现元编程

    自定义对象的行为，如可迭代性或类型标籤。

    自定义迭代器使用 Symbol.iterator 让对象可迭代。

    const iterableObject = {
    data: [1, 2, 3],
    [Symbol.iterator]() {
    let index = 0;
    return {
    next: () => {
    if (index < this.data.length) {
    return { value: this.data[index++], done: false };
    } else {
    return { done: true };
    }
    },
    };
    },
    };

    for (const value of iterableObject) {
    console.log(value); // 1, 2, 3
    }

    自定义 toStringTag使用 Symbol.toStringTag 修改 Object.prototype.toString 的结果。

    class CustomClass {
    get [Symbol.toStringTag]() {
    return "CustomClass";
    }
    }

    const instance = new CustomClass();
    console.log(Object.prototype.toString.call(instance)); // [object CustomClass]

    小结

    Symbol 适合用于：

    • 创建唯一的对象属性，避免命名冲突。
    • 隐藏对象属性，提高对象的安全性。
    • 自定义行为，利用内建的 Symbol 实现元编程功能。
    • 虽然 Symbol 是强大的工具，但它的使用情景通常是高级或框架级别的需求，对于普通应用，谨慎使用即可。