Electron Forge 项目中环境变量的传递解决方案

问题背景

在 Electron Forge 项目中，开发者经常遇到环境变量在开发时能正常加载，但在打包构建后却无法获取的问题。特别是在使用 .env 文件管理环境变量的场景下，这个问题尤为常见。

核心问题分析

Electron Forge 构建过程中，环境变量的处理与开发时有显著差异。主要原因包括：

1. 构建过程与运行时环境分离
2. Webpack/Vite 等构建工具对环境变量的处理方式不同
3. 打包后应用无法直接访问项目根目录下的 .env 文件

解决方案汇总

方案一：使用 env-cmd 或 dotenvx 工具

在 package.json 的脚本命令中直接注入环境变量：

"scripts": {
  "start": "env-cmd -f .env.dev electron-forge start",
  "package": "env-cmd electron-forge package"
}

或者在 Vite 项目中使用 dotenvx：

"start": "dotenvx run --env-file=.env.local -- electron-forge start"

方案二：Webpack 环境插件配置

对于使用 Webpack 的项目，可以在 webpack 配置中添加 EnvironmentPlugin：

const webpack = require("webpack");

module.exports = {
  plugins: [
    new webpack.EnvironmentPlugin([
      'SERVER_PORT',
      'AWS_ACCESS_KEY_ID',
      'AWS_SECRET_ACCESS_KEY'
    ])
  ]
}

方案三：DefinePlugin 定义全局变量

另一种 Webpack 方案是使用 DefinePlugin 明确定义变量：

new webpack.DefinePlugin({
  'process.env.NODE_ENV': JSON.stringify(process.env.NODE_ENV)
})

方案四：打包时包含 .env 文件

对于需要运行时读取 .env 文件的情况，可以在 forge.config.ts 中配置：

packagerConfig: {
  extraResource: [
    path.resolve(__dirname, ".env")
  ]
}

不同构建工具的注意事项

Webpack 项目

1. 确保 webpack 配置正确加载环境变量
2. 区分开发和生产环境的不同配置
3. 注意环境变量在渲染进程和主进程中的传递方式

Vite 项目

1. Vite 的 define 配置对主进程可能不生效
2. 考虑使用 import.meta.env 替代 process.env
3. 可能需要额外的配置才能使环境变量在主进程中可用

最佳实践建议

1. 敏感信息应避免直接打包到应用中，考虑使用加密或运行时获取
2. 为不同环境创建不同的 .env 文件（如 .env.dev, .env.prod）
3. 在代码中添加环境变量缺失时的友好提示
4. 文档化项目所需的环境变量

总结

Electron Forge 项目中环境变量的处理需要根据具体技术栈选择合适的方案。无论是通过构建工具注入、插件配置还是文件打包，核心目标都是确保环境变量在开发和生产环境下都能正确传递。开发者应根据项目实际情况选择最适合的方法，并注意敏感信息的安全性处理。