JavaScript基本数据类型之Symbol

在 JavaScript 中，Symbol 是一种基本数据类型（primitive type），它表示独一无二的值。它是 ECMAScript 2015 (ES6) 中引入的一种类型，用于确保对象属性的唯一性，避免命名冲突。以下是关于 Symbol 类型的详细说明：

---

1. 创建 Symbol

使用 Symbol() 函数来创建一个 Symbol 值，每个 Symbol 值都是唯一的，即使它们有相同的描述。

const sym1 = Symbol();
const sym2 = Symbol();

console.log(sym1 === sym2); // false

带描述的 Symbol

可以为 Symbol 提供一个可选的描述，便于调试或日志记录。

const sym3 = Symbol("description");
const sym4 = Symbol("description");

console.log(sym3 === sym4); // false
console.log(sym3.description); // "description"

---

2. Symbol 的用途

（1）用作对象属性的键

Symbol 通常用作对象的属性键，以确保这些键是唯一的，防止属性被覆盖或意外修改。

const symKey = Symbol("key");
const obj = {
  [symKey]: "value"
};

console.log(obj[symKey]); // "value"

（2）保护属性不被意外访问或覆盖

由于 Symbol 属性不会出现在常规的 for...in 循环或 Object.keys()、JSON.stringify() 中，因此它们常被用作“私有”属性的实现方式（虽然并不完全私有）。

const secret = Symbol("secret");
const obj = {
  [secret]: "hidden value",
  visible: "public value"
};

console.log(obj[secret]); // "hidden value"
console.log(Object.keys(obj)); // ["visible"]
console.log(Object.getOwnPropertySymbols(obj)); // [Symbol(secret)]

---

3. 内置 Symbol

JavaScript 提供了一些内置的 Symbol，这些内置 Symbol 通常用于定义语言中的特定行为：

内置 Symbol	描述
Symbol.iterator	定义对象的默认迭代器，用于支持 for...of 循环。
Symbol.toStringTag	定义对象在调用 Object.prototype.toString 时返回的自定义描述。
Symbol.toPrimitive	定义对象在被转换为原始值时的自定义行为。
Symbol.hasInstance	定义对象在使用 instanceof 操作符时的自定义行为。
Symbol.isConcatSpreadable	定义对象在使用 Array.prototype.concat 时是否可以展开。
Symbol.asyncIterator	定义异步迭代器，用于支持 for await...of 循环。

示例：Symbol.iterator

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

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

---

4. Symbol 的限制

1. 不能用 new 创建
   Symbol 是一个原始值，不是对象，所以不能使用 new Symbol()。

   const sym = new Symbol(); // TypeError
   

2. 不能隐式转换为字符串
   Symbol 类型不能隐式地转换为字符串或数字。

   const sym = Symbol("example");
   console.log(sym + ""); // TypeError
   console.log(String(sym)); // "Symbol(example)"
   

3. 性能
   大量使用 Symbol 可能影响性能，尤其在需要频繁使用 Object.getOwnPropertySymbols 等方法时。

---

5. 全局 Symbol

通过 Symbol.for() 和 Symbol.keyFor() 可以创建和访问全局 Symbol：

• Symbol.for(key): 在全局 Symbol 注册表中查找是否存在指定键的 Symbol。如果不存在，就创建一个新的 Symbol。

const globalSym1 = Symbol.for("key");
const globalSym2 = Symbol.for("key");

console.log(globalSym1 === globalSym2); // true

• Symbol.keyFor(symbol): 返回一个全局 Symbol 的键。

const sym = Symbol.for("key");
console.log(Symbol.keyFor(sym)); // "key"

注意：普通 Symbol 不会被 Symbol.keyFor() 处理。

const sym = Symbol("local");
console.log(Symbol.keyFor(sym)); // undefined

---

总结

• Symbol 的主要用途: 避免属性名冲突，定义独一无二的键。
• 独特性: 每个 Symbol 值都是唯一的，即使描述相同。
• 内置支持: JavaScript 提供许多内置 Symbol 用于自定义语言行为。