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 来测试弱引用,它会向传入的对象添加一个弱引用,并在对象被垃圾回收时调用回调函数
// 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