打包你的应用程序

请跟随教程进行

这是 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 文件，该文件导出一个配置对象。在预填充的配置中，你应该会看到多个 maker（用于生成可分发应用包的包），每个 maker 对应一个目标平台。

创建可分发文件

要创建可分发文件，请使用你的项目新添加的 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 文档中的 Signing macOS Apps 指南。

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

创建可分发文件

重要提示：对你的代码进行签名

总结