Electron-builder是一个功能强大的打包工具,能够为macOS、Windows和Linux构建可分发且支持自动更新的Electron应用程序。通过electron-updater模块,开发者可以轻松实现应用的自动更新功能,让用户始终使用最新版本的应用。📦
为什么选择Electron-builder自动更新?
相比Electron内置的自动更新功能,electron-updater提供了更多优势:
✨ 跨平台支持:不仅支持macOS和Windows,还完美支持Linux平台 🔒 代码签名验证:在macOS和Windows上都支持代码签名验证 🚀 智能下载:支持差量更新,大幅减少下载时间和带宽消耗 📊 分阶段发布:可以控制新版本的发布节奏,避免大规模问题
快速开始配置自动更新
1. 安装electron-updater依赖
首先需要在项目中安装electron-updater:
npm install electron-updater
# 或者
yarn add electron-updater
2. 配置发布选项
在package.json中配置发布设置,支持GitHub Releases、Amazon S3、云存储服务等多种发布平台。
3. 添加自动更新代码
在主进程中添加以下代码即可启用自动更新:
const { autoUpdater } = require('electron-updater')
autoUpdater.checkForUpdatesAndNotify()
就是这么简单!两行代码就能让你的应用具备自动更新能力。
支持的自动更新目标格式
Electron-builder支持以下格式的自动更新:
macOS:DMG格式 Linux:AppImage、DEB、Pacman和RPM Windows:NSIS安装程序
高级配置选项
自定义更新器实例
如果需要更精细的控制,可以创建特定的更新器实例:
import { NsisUpdater } from 'electron-updater'
const autoUpdater = new NsisUpdater({
requestHeaders: {
// 自定义请求头
}
})
autoUpdater.checkForUpdatesAndNotify()
分阶段发布控制
通过编辑latest.yml文件,可以控制新版本的发布比例:
version: 1.1.0
path: MyApp Setup 1.1.0.exe
sha512: Dj51I0q8aPQ3ioaz9LMqGYujAYRbDNblAQbodDRXAMxmY6hsHqEl3F6SvhfJj5oPhcqdX1ldsgEvfMNXGUXBIw==
stagingPercentage: 10
上面的配置表示新版本将分发给10%的用户群体。
调试和故障排除
启用日志记录可以方便地调试自动更新过程:
autoUpdater.logger = require('electron-log')
autoUpdater.logger.transports.file.level = 'info'
最佳实践建议
-
代码签名必不可少:macOS应用必须进行代码签名才能使用自动更新功能
-
测试环境配置:开发阶段可以创建
dev-app-update.yml文件来测试更新流程 -
错误处理:监听错误事件,为用户提供友好的错误提示
-
更新进度显示:显示下载进度,提升用户体验
兼容性说明
Electron-builder生成的元数据文件格式会随时间变化,但保持了向后兼容性。对于新项目,建议设置electronUpdaterCompatibility为最新格式版本。
通过Electron-builder的自动更新功能,你可以专注于应用开发,而无需担心版本分发问题。你的用户将始终享受到最新、最稳定的应用体验!🎉
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考



