当项目应用包更新后应该主动提示用户更新,这是采用electron-updater进行更新提示
一、安装依赖
npm i electron-updater
二、配置安装包更新地址
electron-builder.json5添加配置
// 配置安装包更新地址
publish: [
{
provider: "generic",
url: "http://www.niech.cn/everyDayNote",
},
]
三、新建封装版本管理工具electron/version.ts
import { autoUpdater } from 'electron-updater';
import { dialog, BrowserWindow } from 'electron';
const updateUrl = 'http://www.niech.cn/everyDayNote';
/**检测更新 */
export const checkUpdate = (win: BrowserWindow) => {
console.log('开始检测');
// 设置更新检测的资源路径,会检测对应路径下的 last.yaml文件中的版本信息 上线后确保该文件能正常访问
if (process.platform == 'darwin') {
autoUpdater.setFeedURL(`${updateUrl}/mac`);
return;
} else {
autoUpdater.setFeedURL(`${updateUrl}/win`);
}
//检测更新
autoUpdater.checkForUpdates();
//监听'error'事件
autoUpdater.on('error', err => {
console.log('出错拉' + err);
dialog.showErrorBox('更新出错拉!', err.message);
});
//监听'update-available'事件,发现有新版本时触发
autoUpdater.on('update-available', () => {
console.log('found new version');
dialog.showMessageBox({
message: '发现新版本,正在下载安装包'
});
});
// 更新包下载百分比回调
autoUpdater.on('download-progress', function (progressObj) {
if (win) {
win.webContents.send('download-progress', progressObj);
}
});
//默认会自动下载新版本,如果不想自动下载,设置autoUpdater.autoDownload = false
// autoUpdater.autoDownload = false;
//监听'update-downloaded'事件,新版本下载完成时触发
autoUpdater.on('update-downloaded', () => {
dialog
.showMessageBox({
type: 'info',
title: '应用更新',
message: '需要退出程序才能安装新版本,是否安装?',
buttons: ['是', '否']
})
.then(buttonIndex => {
if (buttonIndex.response == 0) {
//选择是,则退出程序,安装新版本
autoUpdater.quitAndInstall();
}
});
});
};
四、主进程main.ts调用更新校检
/**
* 版本更新检测
*/
ipcMain.handle("check-update",(e:any)=>{
// 获取发送通知的渲染进程窗口
const currentWin = getWindowByEvent(e);
// 升级校验
checkUpdate(currentWin);
});
/**
* 通过窗口事件获取发送者的窗口
* @param event ipc发送窗口事件
*/
function getWindowByEvent(event: IpcMainEvent): BrowserWindow {
const webContentsId = event.sender.id;
for (const currentWin of BrowserWindow.getAllWindows()) {
if (currentWin.webContents.id === webContentsId) {
return currentWin;
}
}
return null;
}
utils/electron.ts添加工具方法定义
/**
* 新建窗口
* @param path 路由地址
*/
export function openWindow(path: string) {
window.ipcRenderer.invoke("open-win", path);
}
/**
* 检查版本更新
*/
export function checkUpdate(){
window.ipcRenderer.invoke("check-update");
}
export default {
openWindow,
checkUpdate
};