最后更新于

加速electron在国内的下载速度

在开发 Electron 应用时，npm install electron 或 yarn add electron 是我们的第一步。这个过程中，会下载一个名为 electron-prebuilt（现在通常直接是 electron 包的一部分）的预编译二进制文件压缩包。这些文件默认托管在 GitHub Releases 上。然而，在国内或其他特定网络环境下，从 GitHub 下载这些体积不小的文件往往速度感人，甚至可能因为网络波动导致下载失败，严重影响开发效率。

别急，有妙招！通过查看 electron 包依赖的下载模块（如旧版的 electron-download，其逻辑已被整合）的源码或相关文档，我们可以发现其下载地址是可以通过环境变量或参数进行灵活配置的。

关键的源码逻辑通常如下所示：

// 示例代码，具体实现可能随版本更新而变化
var url =
  process.env.NPM_CONFIG_ELECTRON_MIRROR || // npm 配置中的镜像
  process.env.ELECTRON_MIRROR ||          // 直接设置的环境变量
  (opts && opts.mirror) ||                // 安装选项中指定的镜像
  'https://github.com/electron/electron/releases/download/v'; // 默认 GitHub 地址

这段代码清晰地告诉我们，可以通过设置 NPM_CONFIG_ELECTRON_MIRROR 或 ELECTRON_MIRROR 环境变量，将 Electron 的下载源指向速度更快的国内镜像。

解决方案：配置 Electron 下载镜像

以下是两种主流的配置镜像源的方法，助你告别漫长等待：

一、临时配置（单次安装生效）

如果你只是偶尔需要加速某一次 electron 的安装，或者想快速测试镜像效果，可以在执行安装命令时临时指定环境变量：

DEBUG=* ELECTRON_MIRROR="https://npmmirror.com/mirrors/electron/" npm install electron --save-dev

或者使用 yarn:

DEBUG=* ELECTRON_MIRROR="https://npmmirror.com/mirrors/electron/" yarn add electron --dev

小技巧：

  • 命令中加入 DEBUG=* 参数会输出详细的调试信息（在某些版本的 npm/yarn 和 electron 安装脚本中生效）。通过这些日志，你可以清晰地看到实际的下载 URL，从而确认下载源是否已成功切换到你指定的镜像地址。例如，你可能会看到类似 downloading https://npmmirror.com/mirrors/electron/vX.Y.Z/electron-vX.Y.Z-os-arch.zip ... 的输出。

  • https://npmmirror.com/mirrors/electron/ 是由淘宝 NPM 镜像团队维护的 Electron 镜像，国内访问速度通常非常理想，推荐使用。

二、永久配置（一劳永逸）

如果你希望之后所有的 Electron 安装都能默认享受镜像加速的便利，可以将环境变量添加到你的 Shell 配置文件中。这样，每次打开新的终端会话时，该配置都会自动生效。

  1. 确定你的 Shell 类型：

    • 如果你使用的是 Bash，配置文件通常是 ~/.bashrc 或 ~/.bash_profile。

    • 如果你使用的是 Zsh (比如 macOS Catalina 及之后版本的默认 Shell)，配置文件是 ~/.zshrc。

  2. 编辑配置文件： 打开对应的配置文件（例如 nano ~/.zshrc 或 vim ~/.bashrc），在文件末尾添加以下行：

    export ELECTRON_MIRROR="https://npmmirror.com/mirrors/electron/"

  3. 使配置生效： 保存文件后，执行 source ~/.zshrc (或 source ~/.bashrc) 命令，或者简单地重新打开一个新的终端窗口，新的环境变量配置即可生效。

进阶优化：Electron 缓存管理

为何需要管理缓存？

有时，即使配置了镜像源，也可能因为之前下载中断导致缓存文件不完整，或者缓存文件本身存在损坏，从而引发 Electron 安装失败。这时，清理或管理 Electron 的本地缓存就显得尤为重要。

默认缓存位置

Electron 下载的预编译二进制文件会默认缓存在用户主目录下的一个特定文件夹中。通常是：

  • Linux/macOS: $HOME/.electron

  • Windows: %USERPROFILE%\.electron (即 C:\Users\<你的用户名>\.electron)

如果安装遇到问题，可以尝试手动删除此目录下的相关版本文件或整个目录来清理缓存，然后重新尝试安装。

自定义缓存目录

与下载镜像类似，Electron 也允许你通过设置 ELECTRON_CUSTOM_DIR 环境变量来指定一个自定义的缓存目录。这在以下场景中非常有用：

  • 希望将缓存统一存放在非系统盘或空间更充裕的磁盘分区。

  • 在 CI/CD 环境中，需要精确控制缓存路径。

配置方法与设置 ELECTRON_MIRROR 类似：

  • 临时指定：

    ELECTRON_CUSTOM_DIR="/path/to/your/custom/electron_cache_directory/" npm install electron

  • 永久配置 (添加到 .zshrc 或 .bashrc):

    export ELECTRON_CUSTOM_DIR="/path/to/your/custom/electron_cache_directory/"

    确保替换 /path/to/your/custom/electron_cache_directory/ 为你实际希望使用的目录路径。

官方参考与总结

通过合理配置下载镜像和管理本地缓存，可以显著提升 Electron 的安装速度和成功率，让你的开发之旅更加顺畅。

更多关于 Electron 安装选项的权威信息，包括自定义镜像和缓存的配置，强烈建议查阅 Electron 官方文档：