Electron-Builder 打包优化：如何正确排除 node_modules 目录

在 Electron 应用开发中，使用 electron-builder 进行打包时，开发者经常会遇到 node_modules 目录被意外包含进最终打包产物的问题。本文将深入分析这一现象的原因，并提供多种有效的解决方案。

问题现象分析

当使用 electron-builder 进行打包时，即使开发者没有明确包含 node_modules 目录，这个目录仍然可能出现在最终的 asar 文件中。这会导致：

1. 打包体积显著增大
2. 包含大量不必要的依赖文件
3. 可能包含开发依赖和测试文件

根本原因

electron-builder 默认会扫描并包含项目依赖的 node_modules，这是为了确保应用运行时能够访问所有必要的依赖。这种行为是设计使然，因为：

1. 大多数 Electron 应用需要 node_modules 中的依赖
2. 自动依赖解析可以避免手动管理依赖的复杂性
3. 确保原生模块（.node 文件）能够被正确包含

解决方案

方案一：显式排除 node_modules

在 electron-builder 配置文件中，可以明确排除 node_modules 目录：

{
  "files": [
    "dist",
    "dist-electron",
    "!node_modules"
  ]
}

方案二：使用 beforeBuild 钩子

通过设置 beforeBuild 钩子返回 false，可以完全跳过 node_modules 的自动包含：

// 在配置文件中
{
  "beforeBuild": async () => false
}

方案三：优化 Electron 语言包

electron-builder 默认会包含 Electron 的所有语言包，可以通过配置只包含必要的语言：

{
  "electronLanguages": ["en"]
}

最佳实践建议

1. 完整打包方案：如果应用依赖 node_modules 中的模块，建议使用 webpack 或类似的打包工具将所有依赖打包到 dist 目录中，然后排除 node_modules

2. 原生模块处理：特别注意处理 .node 等原生模块，确保它们被正确包含

3. 体积优化：除了排除 node_modules，还可以：

   • 移除不必要的资源文件
   • 压缩图片等静态资源
   • 使用代码分割技术

4. 测试验证：任何排除操作后，务必进行充分测试，确保应用功能正常

注意事项

1. 直接排除 node_modules 可能导致应用无法运行，除非所有依赖都已正确打包
2. Electron 本身的 node_modules 是必需的，不应该被排除
3. 对于大型项目，建议分阶段优化打包配置

通过合理配置 electron-builder，开发者可以显著减小打包体积，同时确保应用功能的完整性。根据项目实际情况选择最适合的优化方案，并在性能优化和功能完整性之间找到平衡点。