Electron Builder 踩坑记：自动化全量更新
2023-12-25 20:13:28
使用 Electron Builder 进行全量更新的终极指南
引言
Electron Builder 作为一款跨平台应用打包工具，以其便利性和高效性备受开发者青睐。然而，当涉及到全量更新时，却可能会遇到重重困难，可谓是踩坑之旅。本文将详细阐述这些问题及其解决方案，为广大 Electron 开发者提供借鉴和启示。
全量更新的坎坷之路
顾名思义，全量更新就是将整个应用包替换为新版本。看似简单的操作，却暗藏玄机。在使用 Electron Builder 进行全量更新时，首先遇到的问题是：更新后应用无法正常启动。经过排查，发现罪魁祸首是更新包中缺少了某些必要的依赖项。
解决依赖项问题
解决这一问题的关键在于构建过程中添加 --platform 参数，指定目标平台。这样，Electron Builder 就会自动包含平台相关的依赖项，保证更新包的完整性。
Github Releases 的妙用
自动化更新的另一大难点在于版本管理和发布。Github Releases 作为一款代码托管平台，提供了便捷的版本发布和管理功能。笔者尝试使用 Github Releases 来进行 Electron 应用的版本发布和更新，却遇到了另一个问题：更新后应用无法自动下载和安装新版本。
启用全量更新支持
究其原因，是因为 Github Releases 默认只支持差量更新，即仅下载更新包中新增或修改的文件，而不下载整个更新包。对于 Electron 应用这种全量更新的场景，显然不适用。
要解决这个问题，需要在 Github Releases 中开启全量更新支持。具体操作如下：
- 创建新版本。
- 进入版本编辑页面。
- 勾选 "Generate ZIP archive" 复选框。
- 保存更新。
通过以上设置，Github Releases 就会自动生成全量更新包，并可以通过 --github-release-url 参数指定该更新包的下载地址。
示例代码
以下是一段使用 Electron Builder 进行自动化全量更新的示例代码：
const electronBuilder = require('electron-builder');
electronBuilder.build({
config: {
productName: 'My Electron App',
version: '1.0.0',
platform: 'win32',
githubReleases: {
releaseType: 'draft',
autoPublish: true,
generateReleaseNotes: true,
generateZipArchive: true,
},
},
publish: 'github',
});
运行以上代码，Electron Builder 会自动构建更新包并发布到 Github Releases。之后，您就可以通过 --github-release-url 参数指定该更新包的下载地址，从而实现自动化全量更新。
结语
Electron Builder 的自动化全量更新虽然看似简单，但实际上暗藏玄机。本文通过分享笔者在使用 Electron Builder 时遇到的问题和解决方案，希望能够帮助其他开发者规避类似的陷阱，提高打包和更新的效率。随着 Electron 技术的不断发展，相信会有更多便捷高效的更新方式涌现，让我们拭目以待。
常见问题解答
-
为什么更新后应用无法启动？
可能是更新包中缺少了必要的依赖项。添加--platform参数指定目标平台可以解决这个问题。 -
为什么应用无法自动下载和安装新版本？
Github Releases 默认只支持差量更新。需要开启全量更新支持才能解决这个问题。 -
如何使用 Github Releases 进行全量更新？
创建新版本，进入版本编辑页面，勾选 "Generate ZIP archive" 复选框，保存更新即可。 -
如何指定更新包的下载地址？
使用--github-release-url参数指定更新包的 Github Releases 下载地址。 -
Electron Builder 的全量更新有什么优点？
相比于差量更新，全量更新更简单、更可靠，并且不会出现文件丢失或损坏的问题。
