性能

开发人员经常询问有关优化 Electron 应用程序性能的策略。软件工程师、消费者和框架开发人员并不总是对“性能”一词的含义达成共识。本文档概述了 Electron 维护人员最喜欢的几种方法，用于减少使用的内存、CPU 和磁盘资源，同时确保您的应用程序对用户输入做出响应并尽可能快地完成操作。此外，我们希望所有性能策略都能为应用程序的安全性保持高标准。

有关如何使用 JavaScript 构建高性能网站的智慧和信息通常也适用于 Electron 应用程序。在一定程度上，讨论如何构建高性能 Node.js 应用程序的资源也适用，但请务必理解“性能”一词对于 Node.js 后端和在客户端上运行的应用程序而言具有不同的含义。

提供此列表是为了您的方便——与我们的安全检查清单非常相似——并非旨在详尽无遗。遵循以下所有步骤构建一个缓慢的 Electron 应用程序可能是可能的。Electron 是一个强大的开发平台，它使您（开发人员）可以或多或少地做任何您想做的事情。所有这些自由意味着性能在很大程度上取决于您。

衡量、衡量、衡量

以下列表包含许多相当直接且易于实施的步骤。但是，要构建应用程序的最优版本，您需要超越许多步骤。相反，您必须通过仔细分析和衡量来仔细检查应用程序中运行的所有代码。瓶颈在哪里？当用户单击按钮时，哪些操作占据了大部分时间？当应用程序只是处于空闲状态时，哪些对象占据了最多的内存？

一次又一次，我们看到构建高性能 Electron 应用程序最成功的策略是分析正在运行的代码，找到其中最耗费资源的部分并对其进行优化。一遍又一遍地重复这个看似费力的过程将极大地提高应用程序的性能。与 Visual Studio Code 或 Slack 等主要应用程序合作的经验表明，这种做法是迄今为止提高性能最可靠的策略。

要了解有关如何分析应用程序代码的更多信息，请熟悉 Chrome 开发者工具。对于同时查看多个进程的高级分析，请考虑使用Chrome Tracing工具。

推荐阅读

• 分析运行时性能
• 演讲：“Visual Studio Code - 第一秒”

检查清单：性能建议

如果您尝试这些步骤，您的应用程序可能会变得更精简、更快，并且通常不太耗费资源。

1. 粗心加载模块
2. 过早加载和运行代码
3. 阻塞主进程
4. 阻塞渲染进程
5. 不必要的 polyfill
6. 不必要或阻塞的网络请求
7. 打包代码
8. 当不需要默认菜单时，调用 Menu.setApplicationMenu(null)

1. 粗心加载模块

在向应用程序添加 Node.js 模块之前，请检查该模块。该模块包含多少个依赖项？仅在 require() 语句中调用它需要什么类型的资源？你可能会发现，NPM 包注册表中下载次数最多的模块或 GitHub 中星标最多的模块实际上并不是最精简或最小的模块。

为什么？

此建议背后的原因最好通过一个实际示例来说明。在 Electron 的早期，可靠地检测网络连接是一个问题，导致许多应用程序使用公开了一个简单的 isOnline() 方法的模块。

该模块通过尝试连接到许多众所周知的端点来检测你的网络连接。对于这些端点的列表，它依赖于另一个模块，该模块还包含一个众所周知的端口列表。此依赖项本身依赖于一个包含有关端口信息的模块，该信息以包含超过 100,000 行内容的 JSON 文件的形式提供。每当加载模块（通常在 require('module') 语句中）时，它都会加载其所有依赖项，并最终读取和解析此 JSON 文件。解析数千行 JSON 是一个非常昂贵的操作。在速度较慢的机器上，它可能需要几秒钟的时间。

在许多服务器上下文中，启动时间几乎无关紧要。需要有关所有端口的信息的 Node.js 服务器如果在服务器启动时将所有必需的信息加载到内存中，则实际上可能“性能更高”，从而可以更快地处理请求。本示例中讨论的模块并不是一个“糟糕”的模块。但是，Electron 应用程序不应该加载、解析和存储它实际上不需要的内存信息。

简而言之，一个看似优秀的模块（主要为运行 Linux 的 Node.js 服务器编写）可能会对应用的性能造成不利影响。在这个特定示例中，正确的解决方案是根本不使用模块，而是使用 Chromium 后续版本中包含的连接性检查。

如何？

在考虑模块时，我们建议您检查

1. 包含的依赖项的大小
2. 加载（require()）它所需的资源
3. 执行您感兴趣的操作所需的资源

可以通过在命令行上使用单个命令来生成加载模块的 CPU 配置文件和堆内存配置文件。在以下示例中，我们正在查看流行的模块 request。

node --cpu-prof --heap-prof -e "require('request')"

执行此命令将在您执行它的目录中生成一个 .cpuprofile 文件和一个 .heapprofile 文件。可以使用 Chrome 开发人员工具分别使用 性能 和 内存 选项卡来分析这两个文件。

在这个示例中，在作者的机器上，我们看到加载 request 几乎花费了半秒，而 node-fetch 则显著减少了内存，并且花费的时间不到 50 毫秒。

2. 过早加载和运行代码

如果您有昂贵的设置操作，请考虑推迟这些操作。检查应用程序启动后立即执行的所有工作。不要立即启动所有操作，请考虑按与用户旅程更紧密对齐的顺序分阶段启动这些操作。

在传统的 Node.js 开发中，我们习惯于将所有 require() 语句放在顶部。如果您当前正在使用相同策略编写 Electron 应用程序并且正在使用您不需要的大型模块，请应用相同策略并将加载推迟到更合适的时间。

为什么？

加载模块是一项非常昂贵的操作，尤其是在 Windows 上。当您的应用启动时，它不应该让用户等待当前不必要的操作。

这似乎很明显，但许多应用程序倾向于在应用启动后立即执行大量工作 - 例如检查更新、下载在后续流程中使用的内容或执行繁重的磁盘 I/O 操作。

我们以 Visual Studio Code 为例。当您打开一个文件时，它会立即向您显示该文件，而不会进行任何代码突出显示，优先让您与文本进行交互。完成这项工作后，它将继续进行代码突出显示。

如何？

我们考虑一个示例，并假设您的应用程序正在解析虚构的 .foo 格式的文件。为了做到这一点，它依赖于同样虚构的 foo-parser 模块。在传统的 Node.js 开发中，您可能会编写急切加载依赖项的代码

parser.js

const fs = require('node:fs')
const fooParser = require('foo-parser')

class Parser {
  constructor () {
    this.files = fs.readdirSync('.')
  }

  getParsedFiles () {
    return fooParser.parse(this.files)
  }
}

const parser = new Parser()

module.exports = { parser }

在上面的示例中，我们正在执行大量工作，这些工作在文件加载后立即执行。我们是否需要立即获取已解析的文件？我们可以在稍后（当实际调用 getParsedFiles() 时）执行这项工作吗？

parser.js

// "fs" is likely already being loaded, so the `require()` call is cheap
const fs = require('node:fs')

class Parser {
  async getFiles () {
    // Touch the disk as soon as `getFiles` is called, not sooner.
    // Also, ensure that we're not blocking other operations by using
    // the asynchronous version.
    this.files = this.files || await fs.promises.readdir('.')

    return this.files
  }

  async getParsedFiles () {
    // Our fictitious foo-parser is a big and expensive module to load, so
    // defer that work until we actually need to parse files.
    // Since `require()` comes with a module cache, the `require()` call
    // will only be expensive once - subsequent calls of `getParsedFiles()`
    // will be faster.
    const fooParser = require('foo-parser')
    const files = await this.getFiles()

    return fooParser.parse(files)
  }
}

// This operation is now a lot cheaper than in our previous example
const parser = new Parser()

module.exports = { parser }

简而言之，按需分配资源，而不是在应用程序启动时分配所有资源。

3. 阻塞主进程

Electron 的主进程（有时称为“浏览器进程”）很特殊：它是应用程序所有其他进程的父进程，也是操作系统与之交互的主要进程。它处理窗口、交互以及应用程序内部各个组件之间的通信。它还包含 UI 线程。

在任何情况下，都不应通过长时间运行的操作阻塞此进程和 UI 线程。阻塞 UI 线程意味着在主进程准备好继续处理之前，整个应用程序将冻结。

为什么？

主进程及其 UI 线程本质上是应用程序内部主要操作的控制塔。当操作系统告知应用程序鼠标点击时，它将在到达窗口之前经过主进程。如果窗口正在渲染流畅的动画，它将需要与 GPU 进程就此进行通信——再次经过主进程。

Electron 和 Chromium 会小心地将繁重的磁盘 I/O 和 CPU 绑定操作放到新线程上，以避免阻塞 UI 线程。您也应该这样做。

如何？

Electron 强大的多进程架构随时准备帮助您执行长时间运行的任务，但也包含少量性能陷阱。

1. 对于长时间运行的 CPU 密集型任务，请使用工作线程，考虑将它们移至 BrowserWindow，或（作为最后的手段）生成一个专用进程。

2. 尽可能避免使用同步 IPC 和 @electron/remote 模块。虽然有合法的用例，但不知不觉地阻塞 UI 线程实在太容易了。

3. 避免在主进程中使用阻塞 I/O 操作。简而言之，每当核心 Node.js 模块（如 fs 或 child_process）提供同步或异步版本时，您都应首选异步和非阻塞变体。

4. 阻止渲染器进程

由于 Electron 附带当前版本的 Chrome，因此你可以利用 Web 平台提供的最新且最棒的功能，以延迟或卸载繁重操作，从而保持你的应用流畅且响应。

为什么？

你的应用可能在渲染器进程中运行了大量的 JavaScript。诀窍在于尽可能快地执行操作，而不会占用保持滚动流畅、响应用户输入或以 60fps 运行动画所需的资源。

如果用户抱怨你的应用有时“卡顿”，则编排渲染器代码中的操作流特别有用。

如何？

一般来说，为现代浏览器构建高性能 Web 应用的所有建议也适用于 Electron 的渲染器。目前，你可以使用的两个主要工具是用于小型操作的 requestIdleCallback() 和用于长时间运行操作的 Web Workers。

requestIdleCallback() 允许开发人员排队执行一个函数，只要进程进入空闲期就会执行该函数。它使你能够执行低优先级或后台工作，而不会影响用户体验。有关如何使用它的更多信息，请查看其在 MDN 上的文档。

Web Workers 是在单独线程上运行代码的强大工具。有一些需要注意的注意事项——查阅 Electron 的多线程文档和Web Workers 的 MDN 文档。对于任何需要大量 CPU 能力且持续时间较长的操作，它们都是理想的解决方案。

5. 不必要的 polyfill

Electron 的一个巨大优势在于，您确切地知道哪个引擎将解析您的 JavaScript、HTML 和 CSS。如果您要重新利用为大型网络编写的代码，请务必不要填充 Electron 中包含的功能。

为什么？

在为当今的互联网构建 Web 应用程序时，最旧的环境决定了您可以和不可以使用的功能。即使 Electron 支持性能良好的 CSS 滤镜和动画，但较旧的浏览器可能不支持。在您可以使用 WebGL 的地方，您的开发人员可能选择了更加耗费资源的解决方案来支持较旧的手机。

在 JavaScript 方面，您可能包含了工具包库，如 jQuery（用于 DOM 选择器）或 polyfill（如 regenerator-runtime）来支持 async/await。

基于 JavaScript 的 polyfill 比 Electron 中的同等原生功能更快的现象非常罕见。不要通过发布您自己的标准 Web 平台功能版本来减慢您的 Electron 应用程序的速度。

如何？

假设当前版本的 Electron 中的 polyfill 是不必要的。如果您有疑问，请查看 caniuse.com 并检查 Electron 版本中使用的 Chromium 版本 是否支持您想要的功能。

此外，请仔细检查您使用的库。它们真的有必要吗？例如，jQuery 非常成功，以至于它的许多功能现在已成为 可用的标准 JavaScript 功能集 的一部分。

如果您正在使用 TypeScript 等转换器/编译器，请检查其配置并确保您针对的是 Electron 支持的最新 ECMAScript 版本。

6. 不必要或阻塞的网络请求

如果可以轻松地将很少更改的资源与您的应用程序捆绑在一起，请避免从互联网获取这些资源。

为什么？

许多 Electron 用户从完全基于 Web 的应用程序开始，然后将其转变为桌面应用程序。作为 Web 开发人员，我们习惯于从各种内容分发网络加载资源。现在您正在发布一个合适的桌面应用程序，请尝试在可能的情况下“剪断电线”，避免让您的用户等待永远不会更改且可以轻松包含在您的应用程序中的资源。

一个典型的例子是 Google Fonts。许多开发人员利用 Google 令人印象深刻的免费字体集合，其中附带一个内容分发网络。宣传很简单：包含几行 CSS，Google 将负责其余部分。

在构建 Electron 应用程序时，如果您下载字体并将其包含在应用程序的捆绑包中，您的用户将得到更好的服务。

如何？

在理想世界中，你的应用程序根本不需要网络来操作。要实现这一点，你必须了解你的应用程序正在下载哪些资源 - 以及这些资源有多大。

要做到这一点，请打开开发者工具。导航到网络选项卡，然后选中禁用缓存选项。然后，重新加载你的渲染器。除非你的应用程序禁止此类重新加载，否则你通常可以通过在开发者工具中按下Cmd + R或Ctrl + R来触发重新加载。

该工具现在将仔细记录所有网络请求。在第一次通过时，清点所有正在下载的资源，首先关注较大的文件。其中是否有任何图像、字体或媒体文件不会更改，并且可以包含在你的包中？如果是，请包含它们。

下一步，启用网络节流。找到当前显示在线的下拉菜单，然后选择较慢的速度，例如快速 3G。重新加载你的渲染器，看看你的应用程序是否正在不必要地等待任何资源。在许多情况下，应用程序将等待网络请求完成，尽管实际上并不需要涉及的资源。

提示：加载你可能希望在不发布应用程序更新的情况下更改的互联网资源是一种强大的策略。要高级控制资源的加载方式，请考虑投资服务工作者。

7. 捆绑你的代码

正如在“过早加载和运行代码”中指出的，调用require()是一项昂贵的操作。如果你能够做到这一点，请将你的应用程序的代码捆绑到一个文件中。

为什么？

现代 JavaScript 开发通常涉及许多文件和模块。虽然这对于使用 Electron 进行开发来说完全没问题，但我们强烈建议你将所有代码捆绑到一个文件中，以确保仅在应用程序加载时才支付调用 require() 时包含的开销。

如何？

有许多 JavaScript 捆绑器，我们知道，通过推荐一个工具而胜过另一个工具会激怒社区。但是，我们建议你使用能够处理 Electron 的独特环境的捆绑器，该环境需要同时处理 Node.js 和浏览器环境。

在撰写本文时，流行的选择包括 Webpack、Parcel 和 rollup.js。

8. 当不需要默认菜单时调用 Menu.setApplicationMenu(null)

Electron 将在启动时设置一个带有某些标准项的默认菜单。但是，你的应用程序可能想要更改它，并且这将有利于启动性能。

为什么？

如果你构建自己的菜单或使用没有原生菜单的无边框窗口，则应尽早告诉 Electron 不要设置默认菜单。

如何？

在 app.on("ready") 之前调用 Menu.setApplicationMenu(null)。这将阻止 Electron 设置默认菜单。另请参阅 https://github.com/electron/electron/issues/35512 以了解相关的讨论。