Electron打包(二)——版本自动更新流程

参考官方文档auto-update

环境:

  • node:16.13.0
  • electron: 11.3.0
  • electron-builder: 22.10.5
  • electron-updater: 4.3.9
electron应用自动更新具体实现流程图
electron-updater自动更新过程.png

1.配置publish

(1)在package.json文件的build中配置自定义服务器:

"build": {
    "publish": [
      {
        "provider": "generic",
        "url": "http://your-domain.com/update"
      }
    ],
}

2.配置更新服务器

(1)如何让客户端知道需要更新?
把electron-builder打包生成的latest.yml、xxx.exe文件、xxx.exe.blockmap文件,放到服务端即可触发自动化检测。

(2)如何触发版本更新?
修改package.json内的version,当服务端的version高于客户端时,便会触发自动化更新。

3.添加插件依赖

安装:npm install electron-updater
引入:import { autoUpdater } from 'electron-updater'

步骤1:进入程序页面给主进程发信息请求版本检测,主进程electron-updater接受信息后处理版本检测。

(1)渲染进程

// 渲染进程:主动触发版本检测事件
this.$ipcApi.send("check-update");

(2)主进程

// 主进程:执行更新版本检查
ipcMain.handle('check-update', () => {
    // 询问服务器是否有更新
    autoUpdater.checkForUpdates().catch(err => {
        console.log('网络连接问题', err)
    })
})

4.autoUpdater操作:

步骤2:通过自定义通道和 autoUpdater 提供的通道监听时机check for update、download progress等,给渲染进城发消息,最终重启安装即可。

// 存在新版本时,默认自动下载更新
autoUpdater.autoDownload = false // 若想通过渲染进程手动触发,需要设置autoDownload为false
// 当更新发生错误的时候触发
autoUpdater.on('error', (err) => {})
// 当开始检查更新的时候触发
autoUpdater.on('checking-for-update', (event, arg) => {}) // 通知渲染进程,此时开始检测版本
// 发现可更新版本时触发
autoUpdater.on('update-available', (info) => {}) // 发现可更新版本-弹层询问渲染进程是否需要“立即更新”
// 没有可更新版本时触发
autoUpdater.on('update-not-available', (info) => {}) // 通知渲染进程,没有检测到新版本
// 发现可更新版本后-用户操作“立即更新”,此时触发开始下载更新
autoUpdater.downloadUpdate().then((path)=>{})
// 下载监听-下载进度数据(0-100%)
autoUpdater.on('download-progress', (progressObj) => {}) //通知渲染进程,下载进度条界面UI展示
// 更新包下载完成时触发
autoUpdater.on('update-downloaded', () => {}) // 用于通知渲染进程下载完成-弹层询问是否立刻重启并安装
// 执行 重启应用程序并下载后安装更新(只能在update-downloaded发出后调用)
autoUpdater.quitAndInstall()
关键步骤示例:

(1)发现可更新版本时触发
autoUpdater.on('update-available', (info) => {})
发现可更新版本-弹层询问渲染进程是否需要“立即更新”

发现新版本.jpg

(2)下载监听-下载进度数据(0-100%)
autoUpdater.on('download-progress', (progressObj) => {})
通知渲染进程,下载进度条界面UI展示

新版本下载中.jpg

(3)更新包下载完成时触发
autoUpdater.on('update-downloaded', () => {})
通知渲染进程下载完成-弹层询问是否立刻重启并安装

是否立即重启.jpg

5.electron-log日志调试

记录任务执行日志并保存到本地,将自动更新功能的检测、下载、更新等流程日志全部存储起来,方便进行排错。

日志存放位置:%USERPROFILE%\AppData\Roaming\{app name}\logs\{process type}.log

安装:npm install electron-log
使用:

const log = require('electron-log');
log.info('Hello, log');
log.warn('Some problem appears');
log日志本地调试.jpg

6.开发环境-本地调试检测新版本

目的:为了在不打包应用程序的情况下开发、测试更新流程的UI及交互。
(1)根目录创建dev-app-update.yml文件
配置版本检测地址:

provider: generic,
url: "http://your-domain.com/update"

(2)在版本更新检测的js文件中配置:

// 防止报错no such file or directory dev-app-update.yml
const isDevelopment = process.env.NODE_ENV === 'development'
if (isDevelopment) {
    autoUpdater.updateConfigPath = path.join(__dirname, '../../../dev-app-update.yml')
}
版本检测-本地调试.png

7.注意问题

(1)想让用户可以手动下载更新应用程序
只需禁用自动下载:autoUpdater.autoDownload = false

(2)electron-updater有bug,在本地调试时会取electron的版本,所以需要手动app的版本

if (process.env.NODE_ENV === 'development') {
    autoUpdater.currentVersion = require('../../../config').appVersion
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,547评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,399评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,428评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,599评论 1 274
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,612评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,577评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,941评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,603评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,852评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,605评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,693评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,375评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,955评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,936评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,172评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,970评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,414评论 2 342

推荐阅读更多精彩内容