无需登录 数据私有 本地保存

ES 私有字段演示 - # 语法与封装

JavaScript 开发工具 封装 演示 私有字段 类
13
0
0
0

术语表与概念解析

本节提供与 JavaScript ES 私有字段相关的所有核心术语的详细解释，帮助您建立完整的知识框架。

私有字段是 ECMAScript 2022 引入的一种类成员，使用 # 前缀标识。私有字段只能在类的内部（即类定义的顶层代码中）被访问和修改，类外部的代码无法直接读写这些字段。这与传统的 JavaScript "私有"约定（如 _private）有本质区别——后者只是通过命名约定来表示"建议不要外部访问"，而 # 私有字段在语言层面就禁止了外部访问。

私有字段在类初始化时声明，语法为 #fieldName = initialValue;。声明后，该字段在类的所有方法中都可以使用 this.#fieldName 的方式访问。尝试在类外部使用 instance.#fieldName 会导致 SyntaxError 或 TypeError。

私有字段的核心价值在于提供了真正的信息隐藏（Information Hiding）能力。在大型项目中，私有字段可以防止外部代码意外依赖类的内部实现细节，从而使类的维护者可以安全地重构内部实现而不影响外部调用者。

私有方法与私有字段类似，使用 # 前缀标识，只能在类内部调用。私有方法通常用于将复杂的内部逻辑封装为独立的函数，同时保持这些函数对外部不可见。

class MyClass {
  #validate(input) {
    return input !== null && input !== undefined;
  }

  process(data) {
    if (this.#validate(data)) {
      // 处理数据
    }
  }
}

私有方法可以与私有字段协同工作，共同实现类的封装。在本工具的 PrivateMethods 场景中，您可以体验私有方法的实际应用效果。

静态私有字段使用 static #fieldName 语法声明，它属于类本身而不是类的实例。所有实例共享同一个静态私有字段的值，但类外部的代码无法访问这个字段。

class Counter {
  static #count = 0;

  constructor() {
    Counter.#count++;
  }

  static getCount() {
    return Counter.#count;
  }
}

静态私有字段在实现单例模式（Singleton Pattern）、工厂模式和计数器等场景中非常有用。由于外部代码无法访问静态私有字段，因此可以确保这些全局状态不会被意外修改。

#field in object 是 ES2022 引入的新语法，用于在类的内部安全地检查一个对象是否拥有某个私有字段。这个语法只能在定义该私有字段的类内部使用。

class Example {
  #secret = 42;

  check(obj) {
    return #secret in obj;
  }
}

这个语法的引入解决了私有字段的一个重要痛点：如何在不触发异常的情况下判断一个对象是否拥有某个私有字段。在没有这个语法之前，开发者只能通过 try-catch 来捕获可能的异常。

in 操作符的一个重要特性是：它只在定义该私有字段的类内部才能使用。如果在其他类或全局作用域中使用 #field in obj，会导致语法错误。

私有字段不会被 JSON.stringify() 序列化。这意味着当您将一个包含私有字段的对象传递给 JSON.stringify() 时，输出的 JSON 字符串中不会包含任何私有字段的值。

class User {
  #password;
  name;

  constructor(name, password) {
    this.name = name;
    this.#password = password;
  }
}

const user = new User("Alice", "secret123");
console.log(JSON.stringify(user)); // {"name":"Alice"}

这一特性对序列化流程有重要影响。如果您需要持久化包含私有字段的对象，必须在序列化之前将私有字段的值显式地复制到一个普通对象中。同样，Object.keys()、Object.values()、Object.entries() 等方法也不会返回私有字段。

在 ES2022 之前，开发者通常使用 WeakMap 来模拟私有字段。这种方式通过将私有数据存储在外部的 WeakMap 中，利用 WeakMap 的弱引用特性来实现类似私有的效果。

const privateData = new WeakMap();

class MyClass {
  constructor(value) {
    privateData.set(this, { secret: value });
  }

  getSecret() {
    return privateData.get(this).secret;
  }
}

与 # 私有字段相比，WeakMap 方式有几个缺点：语法更繁琐、运行时性能略低、调试时不易识别、无法提供语法错误提示。因此，ES2022 的私有字段语法是更优的选择，但在需要兼容旧环境时，WeakMap 仍然是一个有效的替代方案。

TypeScript 的 private 关键字和 ES2022 的 # 私有字段虽然都提供私有性，但它们的实现机制有根本区别：

  • TypeScript private：仅在编译时检查，编译为 JavaScript 后，私有成员仍然是普通的公有属性。运行时可以通过点号或方括号语法访问。
  • ES # 私有字段：在运行时强制执行，即使编译后的代码也无法绕过私有性限制。
// TypeScript
class TSExample {
  private secret = 42;
}

// 编译后的 JavaScript
class TSExample {
  constructor() {
    this.secret = 42; // 仍然是公有属性！
  }
}

// ES2022
class ESExample {
  #secret = 42;
}
// #secret 在运行时真正私有

这意味着 TypeScript 的 private 更多是一种设计时的约束，而 ES 的 # 私有字段提供了真正的运行时封装。在安全性要求较高的场景中，应优先使用 ES 私有字段。

品牌检测是指使用 #field in object 语法来判断一个对象是否是由特定类创建的。由于私有字段只能在定义它的类中访问，因此这个检查可以作为可靠的类型验证手段。

class Payment {
  #transactionId;

  constructor(id) {
    this.#transactionId = id;
  }

  static isPayment(obj) {
    return #transactionId in obj;
  }
}

const payment = new Payment("TX001");
Payment.isPayment(payment);      // true
Payment.isPayment({});           // false

品牌检测在多态场景中特别有用，例如当一个函数需要验证输入参数是否是特定类的实例时。这比使用 instanceof 更安全，因为 instanceof 可以被子类继承，而品牌检测只认同一级类。

🔧 相关工具