TypeScript 中的 Symbols

1. 概念

Symbol 是一种基本数据类型，用于表示唯一的标识符。每个通过 Symbol() 函数创建的 Symbol 实例都是唯一的，即使它们具有相同的描述符（description）也是如此。

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

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

2. 作为属性键

Symbols 可以作为对象的属性键，用来定义对象的私有属性或防止属性名冲突。

let mySymbol = Symbol();

let obj = {
    [mySymbol]: "value"
};

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

3. 内置 Symbols

TypeScript 提供了一些内置的 Symbols，用于表示对象的内部行为或元信息，如 Symbol.iterator、Symbol.toStringTag 等。

let arr = [1, 2, 3];
let iter = arr[Symbol.iterator]();

console.log(iter.next()); // { value: 1, done: false }

4. Symbol 属性的遍历

使用 Object.getOwnPropertySymbols() 和 Object.getOwnPropertyNames() 方法可以分别获取对象的 Symbols 属性和字符串属性，从而实现对对象属性的完整遍历。

let obj = {
    [Symbol("a")]: "a",
    [Symbol("b")]: "b",
    c: "c"
};

let symbols = Object.getOwnPropertySymbols(obj);
let names = Object.getOwnPropertyNames(obj);

console.log(symbols); // [Symbol(a), Symbol(b)]
console.log(names); // ["c"]

5. 实际应用场景

• 定义私有属性：Symbols 可以用来定义对象的私有属性，避免了属性名冲突和意外覆盖。
• 实现迭代器：内置的 Symbol.iterator 可以用来定义对象的迭代行为，使得对象可以被遍历。
• 自定义对象行为：通过定义内置 Symbols 或自定义 Symbols，可以改变对象的默认行为，增强代码的可读性和灵活性。