Node.js中FinalizationRegistry使用详解

欢迎各位小伙伴来到golang学习网，相聚于此都是缘哈哈哈！今天我给大家带来《Node.js中如何使用FinalizationRegistry详解》，这篇文章主要讲到等等知识，如果你对文章相关的知识非常感兴趣或者正在自学，都可以关注我，我会持续更新相关文章！当然，有什么建议也欢迎在评论留言提出！一起学习！

FinalizationRegistry用于在对象被垃圾回收时执行清理操作，典型场景包括管理C++插件分配的内存或文件句柄等非JavaScript资源，通过register注册目标对象及清理回调，利用unregisterToken可主动取消注册，避免资源泄漏。

在Node.js中操作FinalizationRegistry，本质上是利用JavaScript运行时提供的一种机制，来注册一个回调函数，当某个对象被垃圾回收器判定为不可达并即将被回收时，这个回调函数就会被执行。这听起来很酷，因为它提供了一种“事后清理”的手段，尤其适用于管理那些与JavaScript对象生命周期绑定的非内存资源，比如文件句柄、网络连接或者原生模块（C++ Addon）分配的内存。但说实话，它不是一个日常工具，更像是一把双刃剑，需要你对垃圾回收机制有相当的理解才能驾驭。

解决方案：

FinalizationRegistry的核心用法围绕其构造函数和两个主要方法：register 和 unregister。

首先，你需要实例化一个FinalizationRegistry对象，并在构造函数中传入一个清理回调函数（cleanupCallback）。这个回调函数会在注册的对象被垃圾回收时被调用。

const registry = new FinalizationRegistry((heldValue) => {
  // heldValue 是你注册时传入的“持有值”，它不会阻止被注册对象的回收
  console.log(`对象已被回收，执行清理操作。关联值: ${heldValue}`);
  // 在这里进行资源清理，例如关闭文件、释放内存等
});

接着，通过registry.register(target, heldValue, unregisterToken)方法来注册你想要监控的对象。

• target: 这是你想要监控的对象。当这个对象变得不可达时，cleanupCallback会被调用。
• heldValue: 这是一个任意值，会在cleanupCallback被调用时作为参数传递。关键在于，heldValue本身不能是target对象或直接引用target，否则会形成强引用，阻止target被回收。 它通常是一个字符串、数字、或一个不直接引用target的简单对象，用来标识或携带清理所需的信息。
• unregisterToken (可选): 这是一个任意值，你可以用它来在target被回收前主动取消注册。如果unregisterToken与target相同，同样会创建强引用。通常，我们会使用一个不相关的、唯一的对象或符号作为unregisterToken。

let myObject = {}; // 假设这是我们需要清理关联资源的对象
const resourceId = 'unique-resource-id-123'; // 关联的资源标识

// 错误的示例：myObject作为unregisterToken会强引用自身
// registry.register(myObject, resourceId, myObject); 

// 正确的做法：使用一个不相关的token
const unregisterToken = Symbol('token-for-myObject');
registry.register(myObject, resourceId, unregisterToken);

// 此时，myObject 仍然可达。
// 当 myObject 变得不可达时（例如，所有对它的引用都消失了），
// 垃圾回收器最终会清理它，并触发 registry 的回调。

// 你也可以在对象被回收前，通过 unregisterToken 主动取消注册
// registry.unregister(unregisterToken);

为了更好地演示，我们来看一个完整的例子。注意，垃圾回收是非确定性的，所以下面的输出顺序和时机可能不完全符合预期，甚至在某些情况下，如果进程结束太快，回调可能根本不触发。

const registry = new FinalizationRegistry((resourceIdentifier) => {
  console.log(`[清理回调] 对象被回收了，关联资源标识: ${resourceIdentifier}`);
  // 模拟释放资源，例如 fs.closeSync(resourceIdentifier);
});

function createObjectWithResource(id) {
  const obj = { id: id, data: new Array(1024 * 1024).fill('some-data') }; // 创建一个大对象，更容易被GC关注
  const unregisterToken = Symbol(`token-${id}`);

  // 注册对象，并传入一个不引用obj本身的资源标识
  registry.register(obj, `resource-${id}`, unregisterToken);
  console.log(`[注册] 对象 ${id} 已注册。`);

  // 返回对象和取消注册的token，以便外部可以操作
  return { obj, unregisterToken };
}

let { obj: obj1, unregisterToken: token1 } = createObjectWithResource(1);
let { obj: obj2, unregisterToken: token2 } = createObjectWithResource(2);

// 故意让obj1变得不可达
obj1 = null;
console.log("[主流程] obj1 设置为 null，理论上已不可达。");

// 我们可以尝试手动触发垃圾回收（在Node.js中通常不推荐，仅用于测试）
// global.gc(); // 需要以 --expose-gc 标志运行 Node.js

// 稍微等待一段时间，给GC一个机会
setTimeout(() => {
  console.log("[主流程] 等待结束，看看有没有清理回调触发。");
  // 取消obj2的注册，即使它还在，也不会触发清理回调了
  registry.unregister(token2);
  console.log("[主流程] obj2 已取消注册。");

  // 再次尝试触发GC，看看obj2是否还会触发（理论上不会）
  // global.gc();
}, 2000);

// 保持进程运行，否则GC可能没机会执行
// console.log("程序运行中，等待GC...");

运行上述代码时，你需要使用 node --expose-gc your_script.js 命令，才能通过 global.gc() 手动触发垃圾回收，否则 global.gc() 会报错。即便如此，GC的执行时机依然是不确定的。

FinalizationRegistry在Node.js中有什么实际应用场景？

说实话，FinalizationRegistry在日常的业务逻辑开发中，你可能很少会直接用到它。它的主要舞台，在我看来，是那些需要与底层系统资源打交道、或者涉及大量非JavaScript内存管理的场景。

一个非常典型的应用场景是FFI（Foreign Function Interface）库，比如node-ffi-napi或者其他类似的C++ Addon。当你通过这些库在JavaScript中创建了一个代表C/C++层内存或资源的对象时，JavaScript的垃圾回收器是无法感知这些外部资源的。如果JavaScript对象被回收了，但对应的C/C++资源没有被释放，就会造成内存泄漏或者资源句柄泄漏。FinalizationRegistry在这里就能派上大用场：你可以注册JavaScript对象，并在其被回收时，调用一个C/C++函数来释放对应的原生资源。这就像给原生资源加了一个“遗嘱”，确保它在宿主对象消亡时得到妥善处理。

另一个可以考虑但相对不那么直接的场景是

本篇关于《Node.js中FinalizationRegistry使用详解》的介绍就到此结束啦，但是学无止境，想要了解学习更多关于文章的相关知识，请关注golang学习网公众号！