Electron 内部原理:弱引用
作为一种具有垃圾回收功能的语言,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 来测试弱引用,该 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