作为一种具有垃圾回收机制的语言,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 来测试弱引用,它会为传入的对象添加一个弱引用,并在对象被垃圾回收时调用回调函数
var v8Util = process.atomBinding('v8_util');
var object = {};
v8Util.setDestructor(object, function () {
console.log('The object is garbage collected');
});
object = undefined;
gc();
注意,您必须使用 --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 会将该对象存储在一个 map 中并为其分配一个 ID,然后将 ID 发送回渲染进程。在渲染进程中,remote
模块会收到 ID 并用一个代理对象对其进行封装,当代理对象被垃圾回收时,会向主进程发送一条消息以释放该对象。
以 remote.require
API 为例,简化实现如下所示
remote.require = function (name) {
const meta = ipcRenderer.sendSync('REQUIRE', name);
const object = metaToValue(meta);
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);
map[++id] = object;
event.returnValue = valueToMeta(id, object);
});
ipcMain.on('FREE', function (event, id) {
delete map[id];
});
带有弱值的 Map
在之前的简单实现中,remote
模块中的每次调用都会从主进程返回一个新的远程对象,每个远程对象代表主进程中该对象的一个引用。
设计本身没有问题,但问题在于当多次调用以接收同一个对象时,会创建多个代理对象,对于复杂对象,这会给内存使用和垃圾回收带来巨大压力。
例如,以下代码
const { remote } = require('electron');
for (let i = 0; i < 10000; ++i) {
remote.getCurrentWindow();
}
它首先花费大量内存创建代理对象,然后占用 CPU (中央处理器) 进行垃圾回收并发送 IPC 消息。
一个显而易见的优化是缓存远程对象:当已经存在一个具有相同 ID 的远程对象时,将返回先前的远程对象,而不是创建新的对象。
使用 JavaScript 核心中的 API 无法做到这一点。使用普通 map 缓存对象会阻止 V8 对对象进行垃圾回收,而 WeakMap 类只能使用对象作为弱键。
为了解决这个问题,添加了一种以弱引用作为值的 map 类型,它非常适合缓存带有 ID 的对象。现在 remote.require
看起来像这样
const remoteObjectCache = v8Util.createIDWeakMap()
remote.require = function (name) {
...
if (remoteObjectCache.has(meta.id))
return remoteObjectCache.get(meta.id)
...
remoteObjectCache.set(meta.id, object)
return object
}
请注意,remoteObjectCache
将对象存储为弱引用,因此当对象被垃圾回收时,无需删除键。
原生代码
对于对 Electron 中弱引用的 C++ 代码感兴趣的人,可以在以下文件中找到
setDestructor
API
createIDWeakMap
API