JS `WeakMap` 实现私有数据：防止外部直接访问对象内部属性

各位观众老爷，晚上好！今天咱们来聊聊JavaScript里一个相当有趣，而且在某些场景下非常有用的东西：WeakMap，以及它如何帮助我们实现对象的私有数据。

开场白：你家的秘密花园

想象一下，你有一个房子（一个JavaScript对象），里面有很多房间（对象的属性）。有些房间，比如客厅和厨房，你可以随便让客人参观（公有属性），但有些房间，比如卧室和书房，你只想自己使用，不想让别人随便闯入（私有属性）。

在JavaScript里，传统的做法是使用闭包或者命名约定（比如在属性名前面加下划线_）来模拟私有属性，但这并不是真正的私有，只是“君子协定”，别人仍然可以访问。WeakMap提供了一种更可靠的方式来隐藏对象的内部数据，让它们只能通过特定的方法来访问。

什么是WeakMap？

WeakMap是一个键值对的集合，其中键必须是对象，而值可以是任意类型。与普通的Map不同，WeakMap对键是弱引用的。这意味着，如果一个对象作为WeakMap的键，并且没有其他地方引用这个对象，那么垃圾回收器可以回收这个对象，而WeakMap中对应的键值对也会被自动移除。

这里有几个关键点：

键必须是对象： 这是WeakMap的核心限制，也是它实现私有数据的关键。
弱引用： 防止内存泄漏。当对象不再被使用时，WeakMap不会阻止它被回收。
不可迭代： WeakMap没有keys(), values(), entries() 方法，也不能直接遍历。这进一步增强了数据的私有性。你不能轻易地找出WeakMap里存储了哪些对象。

为什么使用WeakMap实现私有数据？

传统的私有属性实现方法，比如闭包，虽然可以隐藏数据，但也有一些缺点：

内存占用： 闭包会创建一个新的作用域，将私有变量保存在这个作用域中。如果创建大量对象，每个对象都有自己的私有变量副本，这会占用大量的内存。
原型污染： 有些实现方式可能会修改对象的原型，这可能会导致意外的问题。
不够安全： 命名约定只是“君子协定”，别人仍然可以轻松地访问以下划线开头的属性。

WeakMap则可以避免这些问题：

内存效率： WeakMap使用弱引用，当对象被回收时，WeakMap中的数据也会被自动移除，避免内存泄漏。
真正的私有： 数据存储在WeakMap中，只能通过特定的方法访问，外部无法直接访问，提供了真正的私有性。
不污染原型： WeakMap不会修改对象的原型。

WeakMap实现私有数据的例子

让我们通过一个例子来演示如何使用WeakMap来实现对象的私有数据。

const _counter = new WeakMap();

class Counter {
  constructor() {
    _counter.set(this, { count: 0 }); // 初始化私有数据
  }

  increment() {
    const data = _counter.get(this);
    data.count++;
  }

  decrement() {
    const data = _counter.get(this);
    data.count--;
  }

  getCount() {
    return _counter.get(this).count;
  }
}

const myCounter = new Counter();
myCounter.increment();
myCounter.increment();
console.log(myCounter.getCount()); // 输出: 2

// 尝试直接访问私有数据（无效）
console.log(myCounter._counter); // 输出: undefined

// 尝试直接修改私有数据（无效）
myCounter._counter = { count: 100 };
console.log(myCounter.getCount()); // 输出: 2 (私有数据没有被修改)

// 即使使用 console.dir() 也无法直接访问 WeakMap 中的数据
console.dir(myCounter); // 只能看到公有方法

在这个例子中，我们创建了一个WeakMap叫做_counter，它用来存储Counter对象的私有计数器。

在Counter的构造函数中，我们使用_counter.set(this, { count: 0 })来初始化每个Counter对象的私有数据。
increment(), decrement(), 和 getCount() 方法都使用 _counter.get(this) 来访问和修改对象的私有数据。
尝试直接访问或修改 myCounter._counter 是无效的，因为 _counter 是一个WeakMap，外部无法直接访问它的内容。

进阶用法：多个私有属性

如果我们需要存储多个私有属性，可以在WeakMap的值中使用一个对象来存储所有这些属性。

const _privateData = new WeakMap();

class Person {
  constructor(name, age) {
    _privateData.set(this, {
      name: name,
      age: age,
      secret: "I love coding!"
    });
  }

  getName() {
    return _privateData.get(this).name;
  }

  getAge() {
    return _privateData.get(this).age;
  }

  revealSecret(password) {
    if (password === "please") {
      return _privateData.get(this).secret;
    } else {
      return "Incorrect password!";
    }
  }
}

const john = new Person("John", 30);
console.log(john.getName()); // 输出: John
console.log(john.getAge()); // 输出: 30
console.log(john.revealSecret("please")); // 输出: I love coding!
console.log(john.revealSecret("wrong")); // 输出: Incorrect password!

// 无法直接访问私有数据
console.log(john._privateData); // 输出: undefined

在这个例子中，_privateData存储了一个包含name、age和secret的对象，这些属性都是Person对象的私有属性。只有通过Person对象的方法才能访问这些属性。

WeakMap 的优势和局限性

让我们总结一下WeakMap的优势和局限性：

优势	局限性
真正的私有性：外部无法直接访问私有数据。	键必须是对象：不能使用原始类型（如字符串、数字、布尔值）作为键。
内存效率：使用弱引用，避免内存泄漏。	不可迭代：无法直接遍历`WeakMap`，也无法获取键或值的列表。
不污染原型：不会修改对象的原型。	调试困难：难以直接查看`WeakMap`中的内容，需要使用特定的调试技巧。
适用于需要隐藏内部状态的场景。	增加了代码的复杂性：相比于直接访问属性，使用`WeakMap`需要编写更多的代码。
可以存储与对象相关的元数据，而不会影响对象的生命周期。	在某些情况下，闭包可能更简单：如果只需要少量私有变量，并且不需要担心内存泄漏，使用闭包可能更方便。但是随着私有变量的增多，闭包管理起来也会更加复杂。而`WeakMap`仍然清晰简洁。

WeakMap vs. 闭包：如何选择？

WeakMap和闭包都可以用来实现私有数据，那么我们应该如何选择呢？

内存管理： 如果你需要创建大量的对象，并且担心内存泄漏，那么WeakMap是更好的选择。
复杂性： 如果只需要少量私有变量，并且不需要太高的安全性，那么闭包可能更简单。
可维护性： 当私有变量增多时，使用WeakMap可以使代码更清晰、更易于维护。

总的来说，WeakMap提供了一种更健壮、更安全、更可维护的方式来实现对象的私有数据，特别是在大型项目中。

ECMAScript Private Fields (#)

值得一提的是，ECMAScript 2022 引入了真正的私有字段语法，使用 # 前缀来声明私有字段。这种方式更加简洁直观，并且由 JavaScript 引擎强制执行私有性。

class Dog {
  #name; // Private field

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

  bark() {
    console.log(`Woof! My name is ${this.#name}`);
  }

  getName() {
    return this.#name; // 内部可以访问
  }
}

const myDog = new Dog("Buddy");
myDog.bark(); // 输出: Woof! My name is Buddy

// 尝试直接访问私有字段（会报错）
// console.log(myDog.#name); // SyntaxError: Private field '#name' must be declared in an enclosing class

console.log(myDog.getName()); // 输出 Buddy

使用 # 定义的字段是真正的私有字段，外部无法直接访问，即使使用 console.dir() 也无法看到。这是目前 JavaScript 中实现私有属性的最佳方式。

总结

WeakMap是JavaScript中一个强大的工具，可以帮助我们实现对象的私有数据，提高代码的安全性和可维护性。虽然ECMAScript Private Fields (#) 提供了更简洁的语法，但在不支持该语法的环境中，WeakMap仍然是一个有效的替代方案。希望今天的讲座能够帮助你更好地理解和使用WeakMap。

好了，今天的讲座就到这里，谢谢大家！希望大家以后写代码都能像写诗一样优雅，bug 就像流星一样罕见！咱们下期再见！

发表回复 取消回复

发表回复取消回复