打包你的应用
学习目标
在本教程的这一部分中,我们将介绍使用 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
文件中添加了一些脚本。
//...
"scripts": {
"start": "electron-forge start",
"package": "electron-forge package",
"make": "electron-forge make"
},
//...
有关 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 二进制文件捆绑在一起。打包后的代码会生成到一个文件夹中。 - 然后它将使用这个打包好的应用文件夹,为每个配置的生成器创建独立的可分发文件。
脚本运行后,你将看到一个 out
文件夹,其中包含可分发文件和一个包含打包应用代码的文件夹。
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 应用打包背后的机制,请查阅完整的应用打包文档。
重要提示:代码签名
为了向最终用户分发桌面应用程序,我们强烈建议你对 Electron 应用进行代码签名。代码签名是发布桌面应用程序的重要组成部分,并且是教程最后部分中自动更新步骤的强制要求。
代码签名是一种安全技术,用于证明桌面应用是由已知来源创建的。Windows 和 macOS 都有自己的操作系统特定代码签名系统,这将使用户难以下载或启动未签名的应用程序。
在 macOS 上,代码签名是在应用打包级别完成的。在 Windows 上,则是对可分发安装程序进行签名。如果你已经拥有 Windows 和 macOS 的代码签名证书,可以在 Forge 配置中设置你的凭据。
有关代码签名的更多信息,请查阅 Forge 文档中的签名 macOS 应用指南。
- macOS
- Windows
module.exports = {
packagerConfig: {
osxSign: {},
// ...
osxNotarize: {
tool: 'notarytool',
appleId: process.env.APPLE_ID,
appleIdPassword: process.env.APPLE_PASSWORD,
teamId: process.env.APPLE_TEAM_ID
}
// ...
}
}
module.exports = {
// ...
makers: [
{
name: '@electron-forge/maker-squirrel',
config: {
certificateFile: './cert.pfx',
certificatePassword: process.env.CERTIFICATE_PASSWORD
}
}
]
// ...
}
总结
Electron 应用程序需要打包才能分发给用户。在本教程中,你将应用导入 Electron Forge 并对其进行配置,以打包你的应用并生成安装程序。
为了让你的应用程序被用户系统信任,你需要通过代码签名数字认证可分发文件是真实的且未被篡改。一旦你配置 Forge 使用你的代码签名证书信息,你的应用程序就可以通过 Forge 进行签名。