【JS学习】（2）symbol关键字和在ts中的使用

在 JavaScript 和 TypeScript 中，symbol 是一种原始数据类型（Primitive Type），用于创建唯一的标识符。它在 ES6 中被引入，主要用于解决属性名冲突问题，以及实现一些高级的编程模式。

---

1. symbol 的基本概念

(1) 定义

• symbol 是一种原始数据类型，表示一个唯一的值。
• 每次调用 Symbol() 都会生成一个全新的、独一无二的值，即使它们的描述相同。

示例

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

console.log(sym1 === sym2); // false，因为每个 Symbol 都是唯一的

(2) 特点

• 唯一性：即使是相同的描述字符串，生成的 symbol 值也是不同的。
• 不可变性：symbol 是原始类型，不能被修改。
• 隐式转换：symbol 不能直接与其他类型进行隐式转换（如与字符串拼接）。

示例

const sym = Symbol("test");

// console.log("Symbol: " + sym); // 报错：不能将 symbol 转换为字符串
console.log("Symbol: " + String(sym)); // 正确：显式转换为字符串

---

2. symbol 的用途

(1) 作为对象的唯一键

symbol 可以用作对象的键，避免属性名冲突。这是 symbol 最常见的用途之一。

示例

const id = Symbol("id");

const user = {
  name: "Alice",
  [id]: 123, // 使用 Symbol 作为键
};

console.log(user[id]); // 输出 123
console.log(user.name); // 输出 "Alice"

// Symbol 键不会出现在常规的枚举中
console.log(Object.keys(user)); // 输出 ["name"]
console.log(Object.getOwnPropertySymbols(user)); // 输出 [Symbol(id)]

(2) 全局 Symbol 注册表

通过 Symbol.for() 方法，可以创建一个全局共享的 symbol。如果已经存在相同的描述字符串，则返回已存在的 symbol。

示例

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

console.log(globalSym1 === globalSym2); // true，因为它们来自全局注册表

console.log(Symbol.keyFor(globalSym1)); // 输出 "globalKey"
console.log(Symbol.keyFor(Symbol("localKey"))); // 输出 undefined，非全局 Symbol

(3) 内置 Symbol

JavaScript 提供了一些内置的 symbol，用于实现特定的行为。这些内置 symbol 是语言的一部分，可以直接使用。

• 常见内置 Symbol：
  • Symbol.iterator：定义对象的迭代器方法。
  • Symbol.toStringTag：自定义对象的默认字符串标签。
  • Symbol.toPrimitive：定义对象的原始值转换行为。

示例

// 自定义迭代器
const iterable = {
  [Symbol.iterator]() {
    let step = 0;
    return {
      next() {
        step++;
        if (step <= 3) {
          return { value: step, done: false };
        }
        return { done: true };
      },
    };
  },
};

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

// 自定义 toStringTag
const obj = {
  [Symbol.toStringTag]: "CustomObject",
};

console.log(Object.prototype.toString.call(obj)); // 输出 "[object CustomObject]"

---

3. symbol 在 TypeScript 中的使用

TypeScript 对 symbol 提供了良好的支持，并将其视为一种独立的原始类型。

(1) 声明 symbol 类型

在 TypeScript 中，可以直接声明 symbol 类型的变量。

示例

let sym: symbol = Symbol("test");

// const sym: unique symbol
const uniqueSym: unique symbol = Symbol("unique"); // 唯一符号类型

(2) unique symbol 类型

TypeScript 引入了 unique symbol 类型，用于表示一个完全唯一的 symbol。这种类型只能通过 const 声明，并且不能赋值给其他变量。

示例

const uniqueSym: unique symbol = Symbol("unique");

// let anotherSym: unique symbol = uniqueSym; // 报错：unique symbol 不能被重新赋值

(3) 使用 symbol 作为对象的键

TypeScript 支持使用 symbol 作为对象的键，并提供了类型检查。

示例

const id = Symbol("id");

interface User {
  name: string;
  [id]: number; // 使用 Symbol 作为键
}

const user: User = {
  name: "Alice",
  [id]: 123,
};

console.log(user[id]); // 输出 123

(4) 内置 Symbol 的类型

TypeScript 为内置 symbol 提供了类型定义，开发者可以直接使用。

示例

class IterableClass {
  *[Symbol.iterator]() {
    yield 1;
    yield 2;
    yield 3;
  }
}

const instance = new IterableClass();
for (const value of instance) {
  console.log(value); // 输出 1, 2, 3
}

---

4. symbol 的优缺点

(1) 优点

• 唯一性：避免属性名冲突，尤其在大型项目或第三方库中。
• 私有性：symbol 键不会出现在常规的枚举中，适合实现私有属性。
• 扩展性：可用于扩展对象的行为（如自定义迭代器）。

(2) 缺点

• 调试困难：symbol 的值无法直接查看，可能增加调试复杂度。
• 兼容性：部分旧环境可能不支持 symbol。

---

5. 总结

• symbol 的核心作用：
  • 创建唯一的标识符，避免属性名冲突。
  • 实现高级功能（如迭代器、元编程）。
• TypeScript 的支持：
  • 提供了 symbol 和 unique symbol 类型。
  • 支持使用 symbol 作为对象的键，并提供类型检查。
• 最佳实践：
  • 使用 symbol 作为对象的私有属性键。
  • 利用内置 symbol 扩展对象的行为。
  • 避免滥用 symbol，以免增加代码的复杂性。