Electron 内部机制：弱引用

2016 年 9 月 20 日 ·阅读时长 6 分钟

作为一种带有垃圾回收机制的语言，JavaScript 使得用户无需手动管理资源。但由于 Electron 托管了这种环境，它必须非常小心地避免内存和资源泄漏。

本文介绍了弱引用的概念，以及它们如何在 Electron 中用于管理资源。

弱引用

在 JavaScript 中，每当你将一个对象分配给一个变量时，你都在为该对象添加一个引用。只要存在对该对象的引用，它就会一直保存在内存中。一旦所有对该对象的引用都消失了，即不再有变量存储该对象，JavaScript 引擎将在下次垃圾回收时回收内存。

弱引用是对对象的引用，它允许你获取对象，而不会影响对象是否会被垃圾回收。你还会在对象被垃圾回收时收到通知。因此，可以使用 JavaScript 来管理资源。

以 Electron 中的 NativeImage 类为例，每次调用 nativeImage.create() API 时，都会返回一个 NativeImage 实例，它在 C++ 中存储图像数据。一旦你完成了对该实例的使用，并且 JavaScript 引擎 (V8) 对该对象进行了垃圾回收，C++ 中的代码将被调用以释放内存中的图像数据，因此用户无需手动管理此过程。

另一个例子是窗口消失问题，它直观地展示了当所有对窗口的引用都消失时，窗口是如何被垃圾回收的。

在 Electron 中测试弱引用

无法在原始 JavaScript 中直接测试弱引用，因为该语言没有办法分配弱引用。JavaScript 中与弱引用相关的唯一 API 是 WeakMap，但由于它只创建弱引用键，因此无法知道对象何时被垃圾回收。

在 v0.37.8 之前的 Electron 版本中，可以使用内部 v8Util.setDestructor API 测试弱引用，它会为传递的对象添加一个弱引用，并在对象被垃圾回收时调用回调。

// Code below can only run on Electron < v0.37.8.
var v8Util = process.atomBinding('v8_util');

var object = {};
v8Util.setDestructor(object, function () {
  console.log('The object is garbage collected');
});

// Remove all references to the object.
object = undefined;
// Manually starts a GC.
gc();
// Console prints "The object is garbage collected".

请注意，你必须使用 --js-flags="--expose_gc" 命令开关启动 Electron 以公开内部 gc 函数。

该 API 在更高版本中被移除，因为 V8 实际上不允许在析构函数中运行 JavaScript 代码，在更高版本中这样做会导致随机崩溃。

`remote` 模块中的弱引用

除了使用 C++ 管理原生资源外，Electron 还需要弱引用来管理 JavaScript 资源。一个例子是 Electron 的 remote 模块，它是一个远程过程调用 (RPC) 模块，允许从渲染器进程中使用主进程中的对象。

remote 模块的一个关键挑战是避免内存泄漏。当用户在渲染器进程中获取远程对象时，remote 模块必须保证该对象继续存在于主进程中，直到渲染器进程中的引用消失。此外，它还必须确保当不再有渲染器进程引用该对象时，该对象可以被垃圾回收。

例如，如果没有适当的实现，以下代码会导致内存泄漏。

const { remote } = require('electron');

for (let i = 0; i < 10000; ++i) {
  remote.nativeImage.createEmpty();
}

remote 模块中的资源管理很简单。每当请求一个对象时，就会向主进程发送一条消息，Electron 会将该对象存储在一个映射中并为其分配一个 ID，然后将该 ID 发送回渲染器进程。在渲染器进程中，remote 模块会接收 ID 并将其包装在一个代理对象中，当代理对象被垃圾回收时，会向主进程发送一条消息以释放该对象。

以 remote.require API 为例，简化的实现如下所示。

remote.require = function (name) {
  // Tell the main process to return the metadata of the module.
  const meta = ipcRenderer.sendSync('REQUIRE', name);
  // Create a proxy object.
  const object = metaToValue(meta);
  // Tell the main process to free the object when the proxy object is garbage
  // collected.
  v8Util.setDestructor(object, function () {
    ipcRenderer.send('FREE', meta.id);
  });
  return object;
};

在主进程中

const map = {};
const id = 0;

ipcMain.on('REQUIRE', function (event, name) {
  const object = require(name);
  // Add a reference to the object.
  map[++id] = object;
  // Convert the object to metadata.
  event.returnValue = valueToMeta(id, object);
});

ipcMain.on('FREE', function (event, id) {
  delete map[id];
});

具有弱值的映射

通过前面的简单实现，remote 模块中的每次调用都会从主进程返回一个新的远程对象，并且每个远程对象都代表对主进程中对象的引用。

设计本身很好，但问题是，当有多个调用接收同一个对象时，就会创建多个代理对象，对于复杂的对象，这会给内存使用和垃圾回收带来巨大压力。

例如，以下代码

const { remote } = require('electron');

for (let i = 0; i < 10000; ++i) {
  remote.getCurrentWindow();
}

它首先使用大量内存来创建代理对象，然后占用 CPU (中央处理器) 来对其进行垃圾回收并发送 IPC 消息。

一个明显的优化是缓存远程对象：当已经存在具有相同 ID 的远程对象时，将返回以前的远程对象，而不是创建一个新的对象。

这在 JavaScript 核心中的 API 中是无法实现的。使用普通的映射来缓存对象会阻止 V8 对对象进行垃圾回收，而 WeakMap 类只能使用对象作为弱键。

为了解决这个问题，添加了一种具有弱引用值的映射类型，这非常适合缓存具有 ID 的对象。现在 remote.require 看起来像这样

const remoteObjectCache = v8Util.createIDWeakMap()

remote.require = function (name) {
  // Tell the main process to return the meta data of the module.
  ...
  if (remoteObjectCache.has(meta.id))
    return remoteObjectCache.get(meta.id)
  // Create a proxy object.
  ...
  remoteObjectCache.set(meta.id, object)
  return object
}

请注意，remoteObjectCache 使用弱引用存储对象，因此当对象被垃圾回收时，不需要删除键。

原生代码

对于有兴趣了解 Electron 中弱引用 C++ 代码的人来说，可以在以下文件找到它：

setDestructor API

createIDWeakMap API

弱引用​

在 Electron 中测试弱引用​

remote 模块中的弱引用​

具有弱值的映射​

原生代码​

弱引用

在 Electron 中测试弱引用

`remote` 模块中的弱引用

具有弱值的映射

原生代码