JS `FinalizationRegistry` (ES2021)：当对象被回收时触发回调 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷，晚上好！我是你们的老朋友，今天咱们来聊聊JavaScript里一个比较冷门但又很有意思的家伙——FinalizationRegistry。这玩意儿就像一个默默守护的骑士，专门负责在对象被垃圾回收器“咔嚓”掉之前，给你最后一次机会“缅怀”它。

一、啥是FinalizationRegistry？

简单来说，FinalizationRegistry是一个允许你在对象被垃圾回收时得到通知的机制。注意，我说的是允许，而不是保证。垃圾回收的行为是不可预测的，所以你不能依赖它来执行关键业务逻辑。

你可以把它想象成一个“遗愿清单”，当某个对象即将“离世”时，FinalizationRegistry会执行你事先登记好的“遗愿”。这个“遗愿”就是一个回调函数。

二、为什么要用FinalizationRegistry？

你可能会问，既然垃圾回收是自动的，我干嘛还要关心对象啥时候死呢？问得好！

FinalizationRegistry主要用于以下场景：

清理外部资源： 比如，某个对象持有对文件句柄、网络连接或其他非JavaScript资源的引用。当对象被回收时，你需要释放这些资源，否则可能会造成资源泄漏。
缓存失效： 如果你用对象作为缓存的键，当对象被回收时，你需要从缓存中移除对应的条目。
调试和监控： 追踪对象的生命周期，帮助你发现内存泄漏或其他潜在问题。

三、如何使用FinalizationRegistry？

使用FinalizationRegistry非常简单，只需要三个步骤：

创建FinalizationRegistry实例：
```
const registry = new FinalizationRegistry(heldValue => {
  // 当对象被回收时，会执行这个回调函数
  console.log("对象被回收了！关联值是：", heldValue);
});
```
FinalizationRegistry的构造函数接受一个回调函数作为参数。这个回调函数会在对象被回收时执行，并且会接收一个“关联值”（held value）作为参数。稍后我们会解释这个“关联值”是干嘛的。
注册要监听的对象：
```
let obj = { name: "张三" };
let heldValue = "张三的身份信息"; // 关联值

registry.register(obj, heldValue);
```
registry.register()方法接受两个参数：
- obj: 你要监听的对象。
- heldValue: 关联值。这个值会作为参数传递给回调函数。你可以用它来传递一些关于对象的信息，比如对象的ID、名称或其他你需要的属性。
让对象符合被回收的条件：

这一步不是代码，而是操作。你需要让对象不再被引用，这样垃圾回收器才能回收它。
```
obj = null; // 移除对对象的引用
```
注意，即使你移除了对对象的引用，垃圾回收器也不会立即回收它。垃圾回收的时机是不确定的。

四、完整示例

const registry = new FinalizationRegistry(heldValue => {
  console.log("对象被回收了！关联值是：", heldValue);
});

let obj = { name: "张三" };
let heldValue = "张三的身份信息";

registry.register(obj, heldValue);

obj = null; // 移除引用

// 为了尽快触发垃圾回收，可以尝试执行以下代码（不保证有效）
if (global.gc) {
  global.gc();
}

// 理论上，一段时间后你会在控制台看到 "对象被回收了！关联值是：张三的身份信息"

五、 heldValue：关联值的妙用

heldValue是FinalizationRegistry的一个关键特性。它可以让你在回调函数中获取关于被回收对象的信息，而不需要在对象本身存储这些信息。

例如，你可以用heldValue来传递对象的ID：

let objectId = 123;
let obj = { data: "一些数据" };

registry.register(obj, objectId);

registry = null; // 移除引用后，objectId仍然保留，可以在回调中使用
obj = null;

或者，你可以用heldValue来传递一个清理函数：

let cleanup = () => {
  console.log("清理资源");
};

let obj = { data: "一些数据" };

registry.register(obj, cleanup);

obj = null;

在回调函数中，你可以执行这个清理函数：

const registry = new FinalizationRegistry(cleanupFn => {
  cleanupFn(); // 执行清理函数
});

六、注意事项和最佳实践

不要依赖它来执行关键逻辑： 垃圾回收的时机是不确定的，所以你不能依赖FinalizationRegistry来执行必须执行的任务。它更适合用于清理资源、缓存失效等非关键操作。
避免在回调函数中创建新的对象： 在回调函数中创建新的对象可能会导致内存泄漏，因为这些对象可能会阻止垃圾回收器回收其他对象。
小心循环引用： 如果你的对象和heldValue之间存在循环引用，可能会导致内存泄漏。

使用WeakRef来访问对象： FinalizationRegistry的一个常见用例是与WeakRef结合使用。WeakRef允许你创建一个对对象的弱引用，这意味着当对象只剩下弱引用时，它仍然可以被垃圾回收。

const registry = new FinalizationRegistry(heldValue => {
  console.log("对象被回收了！关联值是：", heldValue);
});

let obj = { name: "李四" };
let weakRef = new WeakRef(obj);
let heldValue = "李四的额外信息";

registry.register(obj, heldValue);

obj = null; // 移除强引用

// 可以通过 weakRef.deref() 获取对象，如果对象已经被回收，则返回 undefined
let dereferencedObj = weakRef.deref();
if (dereferencedObj) {
  console.log("对象仍然存在：", dereferencedObj.name);
} else {
  console.log("对象已经被回收了");
}

// 强制垃圾回收（仅用于测试）
if (global.gc) {
  global.gc();
}

在这个例子中，我们使用WeakRef创建了对obj的弱引用。即使我们移除了对obj的强引用，我们仍然可以通过weakRef.deref()来访问它，直到它被垃圾回收。

FinalizationRegistry的回调是在什么时机执行的？ 重要的是理解 FinalizationRegistry 回调的执行时机。它不是在对象被立即回收时执行，而是在垃圾回收器决定回收对象之后，但在对象实际内存被释放之前执行。也就是说，回调执行的时机仍然是不确定的，并且可能发生在程序的任何时候。
FinalizationRegistry与WeakMap/WeakSet的区别: WeakMap和WeakSet是用于存储对对象的弱引用的数据结构。当对象被回收时，WeakMap和WeakSet会自动移除对该对象的引用。它们之间的主要区别在于，WeakMap和WeakSet是用于存储数据的，而FinalizationRegistry是用于在对象被回收时执行回调的。换句话说，WeakMap和WeakSet用于管理对象的生命周期，而FinalizationRegistry用于在对象生命周期结束时执行清理操作。

七、使用场景案例

清理文件句柄

class FileHandler {
  constructor(filePath) {
    this.filePath = filePath;
    this.fileHandle = fs.openSync(filePath, 'r+'); // 假设是同步打开文件，仅为示例
    registry.register(this, this.fileHandle);
  }

  readData() {
    // 读取文件数据
    const buffer = Buffer.alloc(1024);
    fs.readSync(this.fileHandle, buffer, 0, 1024, 0);
    return buffer.toString();
  }

  close() {
    // 手动关闭文件句柄
    if (this.fileHandle) {
      fs.closeSync(this.fileHandle);
      this.fileHandle = null;
      console.log(`File ${this.filePath} closed manually.`);
    }
  }
}

const registry = new FinalizationRegistry(fileHandle => {
  if (fileHandle) {
    fs.closeSync(fileHandle);
    console.log(`File handle ${fileHandle} closed by FinalizationRegistry.`);
  }
});

// 使用示例
let fileHandler = new FileHandler('example.txt');
console.log(fileHandler.readData());

// 假设之后不再需要fileHandler对象，移除引用
fileHandler = null;

// 强制执行垃圾回收（仅用于测试）
if (global.gc) {
    global.gc();
}

这个例子中，当FileHandler对象被回收时，FinalizationRegistry会关闭文件句柄，防止资源泄漏。

缓存失效

const cache = new Map();
const registry = new FinalizationRegistry(key => {
  cache.delete(key);
  console.log(`Cache entry for key ${key} removed.`);
});

function getCachedData(key, expensiveComputation) {
  let cachedValue = cache.get(key);
  if (!cachedValue) {
    const value = expensiveComputation();
    cache.set(key, value);
    registry.register(key, key); // 注册 key 对象
    cachedValue = value;
  }
  return cachedValue;
}

// 模拟一个耗时计算
function expensiveComputation() {
  console.log("Performing expensive computation...");
  return { data: "Result of computation" };
}

// 使用示例
let key = { id: 1 }; // 使用对象作为 key
let data = getCachedData(key, expensiveComputation);
console.log("Data:", data);

// 移除对 key 的引用
key = null;

// 强制执行垃圾回收（仅用于测试）
if (global.gc) {
    global.gc();
}

在这个例子中，我们使用对象作为缓存的键。当键对象被回收时，FinalizationRegistry会从缓存中移除对应的条目，防止缓存变得陈旧。

八、总结

FinalizationRegistry是一个强大的工具，可以让你在对象被回收时执行清理操作。但是，你需要谨慎使用它，并且理解它的局限性。记住，不要依赖它来执行关键逻辑，并且要避免内存泄漏。

总的来说，FinalizationRegistry是一个锦上添花的功能，而不是雪中送炭的救命稻草。正确使用它可以提高程序的健壮性和资源利用率，但使用不当可能会导致更严重的问题。

表格总结:

特性	描述	使用场景	注意事项
回调执行时机	在对象被垃圾回收器决定回收之后，但在对象实际内存被释放之前执行，时机不确定。	清理外部资源（文件句柄、网络连接），缓存失效，调试和监控	不要依赖它来执行关键逻辑；避免在回调函数中创建新的对象；小心循环引用。
`heldValue`	关联值，在对象被回收时传递给回调函数，用于传递对象的信息或清理函数。	传递对象的ID、名称、清理函数等信息。	确保 `heldValue` 不会引起循环引用导致内存泄漏。
与 `WeakRef` 结合使用	`WeakRef` 允许你创建一个对对象的弱引用，当对象只剩下弱引用时，它仍然可以被垃圾回收。`FinalizationRegistry` 可以监听 `WeakRef` 引用的对象，并在对象被回收时执行回调。	允许你在对象被回收前访问对象，或者在对象被回收时执行清理操作。	确保正确处理 `weakRef.deref()` 返回 `undefined` 的情况。
与 `WeakMap/WeakSet` 区别	`WeakMap` 和 `WeakSet` 用于存储对对象的弱引用的数据结构，当对象被回收时，会自动移除对该对象的引用。`FinalizationRegistry` 用于在对象被回收时执行回调。	`WeakMap/WeakSet` 用于管理对象的生命周期，`FinalizationRegistry` 用于在对象生命周期结束时执行清理操作。	根据实际需求选择合适的数据结构或 API。
适用性和局限性	适用于清理非关键资源，但不应该依赖它来执行必须执行的任务。垃圾回收的时机不确定，可能会导致任务延迟或无法执行。	适用于资源清理、缓存失效、调试和监控等场景。	需要谨慎使用，并理解其局限性。

好了，今天的讲座就到这里。希望大家对FinalizationRegistry有了更深入的了解。记住，编程之路漫漫，唯有不断学习，才能走得更远。下次再见！

发表回复 取消回复

发表回复取消回复