Electron项目进行应用程序更新,我们使用electronr-builder方式打包,由于项目的主进程逻辑总是需要迭代优化,“增量更新”不满足业务需求,因此采用“全量更新”。
“全量更新”面临的问题:
前提:Electron自身提供的打包程序,在安装时界面不优雅,因此我们使用自定义的安装程序美化工具打包应用。
(1)更新包不知道旧应用程序安装在用户磁盘的哪个路径
(2)旧应用程序路径内文件已存在,文件更新时不能直接进行覆盖,会生成额外文件夹存放
(3)旧应用程序中用户已经进行过自定义选项配置,更新包覆盖导致用户配置数据丢失
(4)旧应用程序和更新包都存在卸载程序,需要删除更新包的卸载程序,沿用旧包卸载功能
1. 更新包读取注册表内应用安装路径
(1)nsis配置
nsis配置:指安装过程的配置,如果不配置应用程序自动安装在C盘。
在package.json文件build中nsis这个选项中配置自定义的nsis脚本
"nsis": {
"oneClick": false, // 是否一键安装
"perMachine": true, // 是否显示辅助安装程序页面
"allowElevation": true, // 允许请求提升(仅限辅助安装程序)
"installerIcon": "build/icons/icon.ico", // 安装图标
"installerHeaderIcon": "build/icons/icon.ico", // 安装时头部图标
"createDesktopShortcut": false, // 创建桌面图标
"createStartMenuShortcut": false, // 创建开始菜单图标
"artifactName": "${productName}_${version}.${ext}", // 生成打包文件名称
"shortcutName": "XXXXX", // 图标名称
"include": "config/installer.nsh" // 包含的自定义nsis脚本
},
(2)创建自定义的nsis脚本文件
在nsis脚本中,读取注册表中旧应用程序的安装路径,并对更新包的安装路径进行设置。
# installer.nsh
!macro preInit
ReadRegStr $0 HKLM "Software\ProjectName\XXX" "Path"
SetRegView 64
WriteRegExpandStr HKLM "${INSTALL_REGISTRY_KEY}" InstallLocation $0
WriteRegExpandStr HKCU "${INSTALL_REGISTRY_KEY}" InstallLocation $0
SetRegView 32
WriteRegExpandStr HKLM "${INSTALL_REGISTRY_KEY}" InstallLocation $0
WriteRegExpandStr HKCU "${INSTALL_REGISTRY_KEY}" InstallLocation $0
!macroend
2. 更新包覆盖旧应用程序路径内文件
在package.json文件build中nsis选项中配置:
"nsis": {
"allowToChangeInstallationDirectory": false, // 允许修改安装目录(仅限辅助安装程序)
}
这样我们使用electron-updater进行更新的时候,就会安装到我们设置的软件安装路径中,不会产生额外的文件夹。
3. 版本更新后保存用户配置
用户配置文件bin:存放在安装程序的根目录。
C盘存储用户信息:C:\Users\DN\AppData\Local\Temp/ProjectName/bin
。
思路:在版本更新时,拷贝用户配置bin文件到C盘缓存路径下;程序更新完成后重新启动,若C盘缓存路径能读取用户配置文件,则拷贝回来覆盖到安装程序的bin文件下。
(1)检测到版本更新时,用户点击“确认更新”操作
- 获取:用户配置文件bin路径、用户磁盘文件缓存路径
- 拷贝:bin文件备份到缓存路径
// 渲染进程中用户确认更新版本
ipcMain.handle('sure-update-now', () => {
log.info('更新版本:开始下载');
//配置文件bin路径
let binPath = path.join(process.cwd(), 'bin')
//临时路径
let tempPath = app.getPath('temp') +'/ProjectName/bin'
//拷贝文件夹
if(index.isEmpty(binPath)){
log.info('bin文件为空');
} else {
copyFolder(binPath,tempPath)
log.info('更新版本:拷贝bin文件到缓存路径完成');
}
autoUpdater.downloadUpdate().then((path)=>{
log.info('更新版本:download path',path);
console.log("download path", path)
})
})
(2)应用程序启动,读取C盘缓存路径
程序启动,当前根目录不存在bin文件夹时,检测C盘缓存路径是否存在用户配置bin文件,存在则拷贝回根目录bin下
// 下载配置文件
try{
// 用户缓存中读取用户配置
let binPath = path.join(process.cwd(), 'bin') // 用户配置文件bin路径
let tempPath = app.getPath('temp') +'/BigFoot/bin' // c盘临时路径
if (!fs.existsSync(binPath) && fs.existsSync(tempPath)) {
log.info('发现当前bin文件不存在,开始从缓存读取====');
await copyFolder(tempPath,binPath)
}
...
// 创建主界面
setTimeout(() => {
log.info('创建主界面成功!');
createMainWindow()
}, 500)
}catch(error){
log.warn('创建主界面前,下载配置文件出错了!!!!!!');
}
4. 删除更新包的卸载程序
旧应用程序存在卸载程序,更新包也存在卸载程序,两个卸载程序重复,需要删除更新包的卸载程序
// 下载配置文件
try{
// 用户缓存中读取用户配置
...
// 如果是更新版本,需要删除旧的卸载程序exe
let oldUninstallFilePath = path.join(process.cwd(), 'uninst.exe');
let newUninstallFilePath = path.join(process.cwd(), 'Uninstall XXX.exe');
if(fs.existsSync(oldUninstallFilePath) && fs.existsSync(newUninstallFilePath)) {
log.info('当前是更新版本,删除新的卸载程序exe====');
fs.unlinkSync(newUninstallFilePath); // 删除新的卸载程序
}
// 创建主界面
setTimeout(() => {
log.info('创建主界面成功!');
createMainWindow()
}, 500)
}catch(error){
log.warn('创建主界面前,下载配置文件出错了!!!!!!');
}