Electron 22+Electron-Forge中ZeroMQ外部模块的优雅打包方案求助

环境依赖 #

• zeromq@6.0.0-beta.19
• electron@22.3.24
• @electron-forge/cli@6.0.5

本地开发现有配置 #

本地开发阶段，通过Webpack声明外部依赖即可正常运行；同时为避免Mac M1设备上的编译错误，需将ZeroMQ排除在重建流程外：

Webpack主进程配置（webpack.main.config.js） #

module.exports = {
    // ...
    externals: {
        'zeromq': 'commonjs zeromq'
    },
    // ...
}

Electron Forge配置（forge.config.js） #

module.exports = {
    // ...
    rebuildConfig: {
        onlyModules: "axios", // 因缺少头文件，避免在Mac上重建ZeroMQ
    },
    // ...
}

当前打包痛点 #

打包分发时，只能通过钩子手动复制zeromq及依赖的@aminya模块到目标目录，这种方式依赖路径判断，易出错且效率低，当前钩子配置如下：

// forge.config.js
const fs = require('fs');
const path = require('path');

module.exports = {
  packagerConfig: {
    extraResource: [
      "./node_modules/zeromq/",
      "./node_modules/@aminya/",
    ],
    afterCopyExtraResources: [
      (bPath, eVer, platform, arch, done) => {
        let src ;
        let dst ;
        for (const m of ["zeromq", "@aminya"]) {
          if (platform === "darwin") {
            src = path.join(bPath, "jelo-ui.app", "Contents", "Resources", m)
            dst = path.join(bPath, "jelo-ui.app", "Contents", "Resources", "app", "node_modules", m)

          } else {
            src = path.join(bPath, "resources", m)
            dst = path.join(bPath, "resources", "app", "node_modules", m)
          }
          fs.renameSync(src, dst)
        }
        done();
      }
    ]
  },
// ...
}

优雅解决方案 #

核心思路 #

利用Electron Forge对生产依赖的自动复制逻辑，配合Webpack externals和精准的重建排除配置，替代手动钩子操作。

具体步骤 #

1. 确认依赖归属
   将zeromq和@aminya相关包放在package.json的dependencies生产依赖中（而非devDependencies），确保Forge打包时自动识别并复制。

2. 优化Webpack配置
   保持原有externals配置不变，让主进程代码直接引用zeromq模块，避免Webpack将其打包进bundle：

   externals: {
       'zeromq': 'commonjs zeromq'
   }
   

3. 精准排除模块重建
   修改Forge的rebuildConfig，明确排除zeromq和@aminya的重建流程（比原onlyModules更清晰）：

   // forge.config.js
   module.exports = {
       // ...
       rebuildConfig: {
           excludeModules: ["zeromq", "@aminya"]
       },
       // ...
   }
   

4. 验证打包逻辑
   Electron Forge会自动将node_modules中的生产依赖复制到打包后的app/node_modules目录，Webpack externals让代码直接require该目录下的模块；同时重建被跳过，避免Mac M1上的编译错误。

补充说明 #

zeromq@6.x版本依赖@aminya提供的预编译二进制包，无需本地编译，因此跳过重建后可直接使用预编译文件，无需额外操作。

内容的提问来源于stack exchange，提问作者Rwanou