Electron Forge 项目中环境变量的传递与构建实践

环境变量在Electron开发中的重要性

在现代Electron应用开发中，环境变量管理是一个关键环节。开发者通常会在项目根目录下创建.env文件来存储敏感配置信息或环境相关参数。这些变量在开发阶段通过工具如dotenv或vite可以轻松加载，但在使用Electron Forge进行打包构建时却经常遇到变量丢失的问题。

问题现象分析

当开发者使用Electron Forge的make命令构建应用时，常见的现象是：

• 开发阶段通过npm run start运行时，环境变量加载正常
• 使用npm run make构建后，主进程(main)、预加载脚本(loader)和渲染进程(renderer)中的环境变量全部变为undefined
• 特别是在使用Vite作为构建工具时，问题更为明显

解决方案汇总

方案一：使用Webpack的EnvironmentPlugin

对于使用Webpack作为构建工具的项目，可以通过配置webpack.main.config.js文件来解决：

const webpack = require("webpack");

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

同时，在package.json中配合env-cmd工具使用：

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

方案二：使用dotenvx工具

对于偏好使用dotenv生态的项目，可以采用dotenvx工具：

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

方案三：Vite项目的特殊处理

针对使用Vite作为构建工具的项目，需要在forge.config.ts中额外配置：

packagerConfig: {
  asar: {
    unpack: "node_modules/**",
  },
  extraResource: [
    path.resolve(__dirname, ".env")
  ]
}

这样打包时会将.env文件包含在资源中，运行时dotenv可以正常加载。

方案四：cross-env与DefinePlugin结合

对于需要更细粒度控制的场景，可以结合cross-env和Webpack的DefinePlugin：

"scripts": {
  "make": "cross-env-shell NODE_ENV=prod \"pnpm run build-prod && electron-forge make\""
}

在webpack配置中：

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

最佳实践建议

1. 安全性考虑：永远不要将敏感信息直接硬编码在代码中，即使是环境变量也应考虑加密方案

2. 环境区分：为不同环境(开发、测试、生产)维护不同的.env文件

3. 构建验证：在构建完成后，通过解压或运行验证环境变量是否正常加载

4. 文档记录：在项目文档中明确环境变量的使用方式和构建要求

5. 团队协作：提供.env.example文件作为模板，避免团队成员遗漏必要配置

总结

Electron Forge项目中的环境变量传递问题源于构建过程与开发过程的差异。通过合理选择工具链和配置方案，开发者可以确保环境变量在构建后的应用中正常可用。具体方案的选择应基于项目使用的构建工具和技术栈，同时兼顾安全性和可维护性要求。