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，但由于它只创建弱引用键，因此无法知道对象何时被垃圾回收。

在 Electron v0.37.8 之前的版本中，你可以使用内部的 v8Util.setDestructor API 来测试弱引用，该 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` 模块中的弱引用

带有弱值的映射表

原生代码