JS `Symbol`：私有属性、元编程与 `Well-Known Symbols`

各位观众老爷们，大家好！今天咱们聊聊JavaScript里那些个神神秘秘的Symbol。这玩意儿，说它简单吧，一个函数就能创建；说它难吧，理解透彻了能玩出不少花样。今天就来扒一扒它的皮，看看它到底是个什么玩意儿。

开场白：Symbol，你到底是个啥？

想象一下，你家养了一只猫，你给它取名叫“旺财”。邻居家也养了一只猫，也叫“旺财”。咋区分？靠花色？靠性格？总之，不能单靠名字，不然两只猫同时叫“旺财”，都不知道谁该回应。

Symbol就有点像这个“区分猫”的功能。它是一种唯一且不可变的数据类型，用来生成独一无二的标识符。即使你创建两个描述相同的Symbol，它们也是不同的。

const symbol1 = Symbol("描述：我的猫");
const symbol2 = Symbol("描述：我的猫");

console.log(symbol1 === symbol2); // false，即使描述相同，它们也是不同的Symbol

第一部分：Symbol的简单用法：创建和获取

Symbol()函数可以接受一个可选的字符串参数，作为这个Symbol的描述。这个描述仅仅是为了方便调试，并不会影响Symbol本身的唯一性。

const mySymbol = Symbol("这是一个描述");
console.log(mySymbol.description); // "这是一个描述" (某些环境下可能不支持)
console.log(String(mySymbol)); // "Symbol(这是一个描述)"

注意：Symbol不能使用new关键字来创建，它不是一个构造函数。

// 错误示例：
// const mySymbol = new Symbol(); // TypeError: Symbol is not a constructor

第二部分：Symbol的核心应用：私有属性

好，现在进入正题。Symbol最常见的应用场景之一就是实现对象的私有属性。

在JavaScript中，并没有真正的私有属性（虽然现在有了 # 私有字段，但咱们今天说的是Symbol）。通常，我们使用下划线 _ 开头的属性名来表示“这是一个内部属性，请勿直接访问”。但这仅仅是一个约定，并不能阻止别人访问。

class MyClass {
  constructor() {
    this._privateProperty = "这是一个私有属性，但谁都能访问";
  }

  getPrivateProperty() {
    return this._privateProperty;
  }
}

const instance = new MyClass();
console.log(instance._privateProperty); // "这是一个私有属性，但谁都能访问"

但Symbol可以解决这个问题。由于Symbol的唯一性，我们可以用它来定义一个属性，并且只有拥有该Symbol的对象才能访问它。

const _privateProperty = Symbol("私有属性"); // 创建一个Symbol作为私有属性的键

class MyClass {
  constructor() {
    this[_privateProperty] = "真正的私有属性";
  }

  getPrivateProperty() {
    return this[_privateProperty];
  }
}

const instance = new MyClass();
// console.log(instance[_privateProperty]); // 报错，因为外部无法直接访问

console.log(instance.getPrivateProperty()); // "真正的私有属性"

// 尝试用相同的描述创建Symbol来访问私有属性，仍然失败
const anotherSymbol = Symbol("私有属性");
// console.log(instance[anotherSymbol]); // undefined，因为这是另一个Symbol

使用Symbol作为属性键，可以有效地防止外部代码直接访问对象的内部状态。虽然并非绝对安全（可以使用Object.getOwnPropertySymbols()方法获取对象的所有Symbol属性），但大大提高了安全性，并明确表明这些属性是“内部实现细节，请勿随意修改”。

第三部分：Symbol的进阶用法：元编程

Symbol更强大的地方在于它在元编程中的应用。元编程是指编写能够操作程序本身的程序。Symbol提供了一些预定义的Well-Known Symbols，可以用来定制对象的行为。

什么是Well-Known Symbols？

Well-Known Symbols是一些特殊的Symbol值，它们具有预定义的含义，可以用来修改JavaScript引擎的默认行为。它们都作为Symbol对象的静态属性存在，例如：Symbol.iterator、Symbol.toStringTag 等等。

咱们挑几个常用的Well-Known Symbols来讲解：

1. Symbol.iterator：让对象可迭代

Symbol.iterator属性是一个方法，当对象需要被迭代时（比如使用for...of循环），JavaScript引擎会调用这个方法。该方法必须返回一个迭代器对象，该迭代器对象包含next()方法，next()方法返回一个包含value和done属性的对象。

const myIterable = {
  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 { value: undefined, done: true };
        }
      },
    };
  },
};

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

// 也可以手动调用迭代器
const iterator = myIterable[Symbol.iterator]();
console.log(iterator.next()); // { value: 1, done: false }
console.log(iterator.next()); // { value: 2, done: false }
console.log(iterator.next()); // { value: 3, done: false }
console.log(iterator.next()); // { value: undefined, done: true }

2. Symbol.toStringTag：定制对象的toString()行为

Symbol.toStringTag属性是一个字符串，用来定制对象的toString()方法的返回值。

class MyClass {
  constructor() {
    this.name = "MyClassInstance";
  }
  get [Symbol.toStringTag]() {
    return 'MyCustomClass';
  }
}

const instance = new MyClass();
console.log(instance.toString()); // "[object MyCustomClass]"

// 对比：没有定义 Symbol.toStringTag 的情况
class AnotherClass {
  constructor() {
    this.name = "AnotherClassInstance";
  }
}
const anotherInstance = new AnotherClass();
console.log(anotherInstance.toString()); // "[object Object]"

如果没有定义Symbol.toStringTag，toString()方法默认返回"[object Object]"。通过定义Symbol.toStringTag，可以更清晰地标识对象的类型。

3. Symbol.toPrimitive：定制对象类型转换的行为

Symbol.toPrimitive属性是一个方法，当对象需要被转换为原始类型时，JavaScript引擎会调用这个方法。该方法接受一个字符串参数hint，表示期望转换的类型："number"、"string" 或 "default"。

const myObject = {
  value: 10,
  [Symbol.toPrimitive](hint) {
    if (hint === "number") {
      return this.value;
    }
    if (hint === "string") {
      return `The value is ${this.value}`;
    }
    return this.value * 2; // default
  },
};

console.log(Number(myObject)); // 10
console.log(String(myObject)); // "The value is 10"
console.log(myObject + 5); // 25 (因为 default 情况下返回 value * 2 = 20，然后 20 + 5 = 25)

4. 其他 Well-Known Symbols

Well-Known Symbol	描述
`Symbol.hasInstance`	用于定义对象的`instanceof`行为。
`Symbol.isConcatSpreadable`	用于控制数组的`concat()`方法是否展开该数组。
`Symbol.match`	用于定义对象作为正则表达式匹配器时的行为。
`Symbol.replace`	用于定义对象作为正则表达式替换器时的行为。
`Symbol.search`	用于定义对象作为正则表达式搜索器时的行为。
`Symbol.split`	用于定义对象作为正则表达式分割器时的行为。
`Symbol.species`	用于指定派生对象的构造函数。
`Symbol.unscopables`	用于指定哪些属性不应该被`with`语句绑定。

第四部分：Symbol 的注意事项

不可枚举性： 使用Symbol作为属性键时，默认情况下，该属性是不可枚举的。这意味着它不会出现在for...in循环中，也不会被Object.keys()、Object.getOwnPropertyNames()等方法返回。但是，可以使用Object.getOwnPropertySymbols()方法来获取对象的所有Symbol属性。
全局 Symbol 注册表： 可以使用Symbol.for(key)方法来在全局 Symbol 注册表中创建一个Symbol。如果注册表中已经存在具有相同键的Symbol，则返回已存在的Symbol，否则创建一个新的Symbol并将其添加到注册表中。使用Symbol.keyFor(symbol)方法可以获取全局 Symbol 注册表中Symbol的键。

// 全局 Symbol 注册表
const globalSymbol1 = Symbol.for("myGlobalSymbol");
const globalSymbol2 = Symbol.for("myGlobalSymbol");

console.log(globalSymbol1 === globalSymbol2); // true，因为它们具有相同的键

console.log(Symbol.keyFor(globalSymbol1)); // "myGlobalSymbol"

总结：Symbol，不仅仅是个“符号”

Symbol不仅仅是一种新的数据类型，更是一种强大的工具，可以用来实现私有属性、定制对象行为、以及进行元编程。理解和掌握Symbol，可以让你写出更健壮、更灵活、更易于维护的JavaScript代码。

虽然Symbol的某些特性（比如获取所有Symbol属性）可能会破坏“绝对私有”的幻想，但它仍然是一种非常有用的机制，可以帮助开发者更好地组织和保护代码。

希望今天的讲座能帮助大家更深入地了解JavaScript的Symbol。以后再遇到它，就不会觉得那么陌生了。

各位，下课！

发表回复 取消回复

发表回复取消回复