打包你的应用

跟着教程一起学习

这是 Electron 教程的**第 5 部分**。

学习目标

在本教程的这一部分，我们将介绍使用 Electron Forge 打包和分发应用的基础知识。

使用 Electron Forge

Electron 的核心模块不包含任何打包和分发工具。在开发模式下拥有一个可工作的 Electron 应用后，你需要使用额外的工具来创建一个可以分发给用户的打包应用（也称为**可分发文件**）。可分发文件可以是安装程序（例如 Windows 上的 MSI）或可移植的执行文件（例如 macOS 上的 .app）。

Electron Forge 是一个一体化工具，用于处理 Electron 应用的打包和分发。其内部结合了许多现有的 Electron 工具（例如 @electron/packager、@electron/osx-sign、electron-winstaller 等），提供一个统一的接口，因此你无需担心将它们连接起来。

将你的项目导入 Forge

你可以在项目的 devDependencies 中安装 Electron Forge 的 CLI，并使用便捷的转换脚本导入现有项目。

npm
Yarn

npm install --save-dev @electron-forge/cli
npx electron-forge import

npm install --save-dev @electron-forge/cli
yarn dlx electron-forge import

转换脚本完成后，Forge 应该已向你的 package.json 文件添加了一些脚本。

package.json
  //...
  "scripts": {
    "start": "electron-forge start",
    "package": "electron-forge package",
    "make": "electron-forge make"
  },
  //...

CLI 文档

有关 make 和其他 Forge API 的更多信息，请查阅 Electron Forge CLI 文档。

你还应该注意到你的 package.json 现在在 devDependencies 下安装了几个额外的包，并新增了一个导出配置对象的 forge.config.js 文件。在预填充的配置中，你应该会看到多个 makers (生成可分发应用包的包)，每个目标平台对应一个。

创建可分发文件

要创建可分发文件，请使用项目新增的 make 脚本，该脚本运行 electron-forge make 命令。

npm
Yarn

npm run make

yarn make

该 make 命令包含两个步骤：

它首先会在内部运行 electron-forge package，这将你的应用代码与 Electron 二进制文件捆绑在一起。打包的代码会生成到一个文件夹中。
然后它将使用这个打包的应用文件夹，为每个配置的 maker 创建一个单独的可分发文件。

脚本运行后，你应该会看到一个 out 文件夹，其中包含可分发文件以及一个包含打包应用代码的文件夹。

macOS 输出示例
out/
├── out/make/zip/darwin/x64/my-electron-app-darwin-x64-1.0.0.zip
├── ...
└── out/my-electron-app-darwin-x64/my-electron-app.app/Contents/MacOS/my-electron-app

out/make 文件夹中的可分发文件应该已经可以启动了！你现在已经创建了你的第一个打包 Electron 应用。

可分发格式

Electron Forge 可以配置以创建不同操作系统特定格式的可分发文件（例如 DMG、deb、MSI 等）。有关所有配置选项，请参阅 Forge 的Makers 文档。

创建和添加应用图标

设置自定义应用图标需要在配置中进行一些添加。请查阅 Forge 的图标教程以获取更多信息。

不使用 Electron Forge 进行打包

如果你想手动打包你的代码，或者你只是想了解 Electron 应用打包背后的机制，请查阅完整的应用打包文档。

重要：签署你的代码

为了向最终用户分发桌面应用程序，我们强烈建议你对 Electron 应用进行**代码签名**。代码签名是发布桌面应用程序的重要环节，也是教程最后一部分自动更新步骤的强制要求。

代码签名是一种安全技术，用于证明桌面应用程序是由已知来源创建的。Windows 和 macOS 都有各自操作系统特有的代码签名系统，这会使得用户很难下载或启动未签名的应用程序。

在 macOS 上，代码签名是在应用打包层面完成的。在 Windows 上，则是对可分发的安装程序进行签名。如果你已经拥有 Windows 和 macOS 的代码签名证书，可以在 Forge 配置中设置你的凭据。

信息

有关代码签名的更多信息，请查阅 Forge 文档中的签署 macOS 应用指南。

macOS
Windows

forge.config.js
module.exports = {
  packagerConfig: {
    osxSign: {},
    // ...
    osxNotarize: {
      tool: 'notarytool',
      appleId: process.env.APPLE_ID,
      appleIdPassword: process.env.APPLE_PASSWORD,
      teamId: process.env.APPLE_TEAM_ID
    }
    // ...
  }
}

forge.config.js
module.exports = {
  // ...
  makers: [
    {
      name: '@electron-forge/maker-squirrel',
      config: {
        certificateFile: './cert.pfx',
        certificatePassword: process.env.CERTIFICATE_PASSWORD
      }
    }
  ]
  // ...
}

总结

Electron 应用需要打包才能分发给用户。在本教程中，你将应用导入到 Electron Forge 并进行配置，使其打包应用并生成安装程序。

为了让你的应用获得用户系统的信任，你需要通过代码签名来数字认证可分发文件的真实性和未被篡改。一旦你在 Forge 中配置了代码签名证书信息，就可以通过 Forge 对应用进行签名。

学习目标​

使用 Electron Forge​

将你的项目导入 Forge​

创建可分发文件​

重要：签署你的代码​

总结​

学习目标

使用 Electron Forge

将你的项目导入 Forge

创建可分发文件

重要：签署你的代码

总结