Electron的自动更新机制并不算复杂,但团队内似乎没有相关文档,正好笔者搞明白了,就简单说明一下,以MacOS的arm平台为例说明,具体代码可以参考Postcat的相关配置,本篇文章就不以具体代码举例了。
这里是以Mac arm平台为例,对于不同平台,包名不一样、更新文件名不一样、压缩包后缀不一样,但总体上都是围绕这三样东西。
配置了自动更新后,构建后,会有以下几个关键文件:
- 安装包:Postcat-1.0.0-arm64.dmg
- 更新/指引文件:latest-mac.yml
- 压缩包:Postcat-1.0.0-arm64-mac.zip
三者是对应的,要顺利完成自动更新,三者缺一不可。当运行Postcat时,应用程序会尝试访问更新文件,从更新文件中获取最新的版本号和一个相对路径,相对路径指向.zip压缩包。
如果更新文件latest.yml中的最新版本号和当前运行的应用程序版本号一致,则不会再去访问压缩包。
如果不一致,则回去尝试访问压缩包,去将压缩包下载到本地,自动进行更新(更新过程是自动的,笔者也不了解内部运行的机理)。
待下一次重启应用时,运行的即是最新的应用程序,大致流程模型如下:
编辑
由此可知,latest.yml文件的位置是相当重要的,它必须始终指向最新的压缩包,因为在每一次发布新版本后,需要将latest.yml文件替换掉。关于这一点,Github平台已经帮我们做得很好了,但如果你的安装包需要发布在其他平台上,这一步操作需要加入到标准流程中。
当然,由于我们有自己的需求,因此在中间加了一层Nginx,Electron关于自动更新对外的访问,都会经过Nginx,由此变成:
编辑
需要注意的是,更新文件latest.yml中的路径是相对路径,而Electron访问压缩包时走的是http协议,绝对路径,因此当自动更新出现问题时,可以查看latest.yml中的相对路径是否正确。
这个机制我有应用到目前我参与的开源项目中,Postcat 开源的 API 管理工具,纯国产,免费的,主打插件生态,适合中小团队以及个人开发者使用,有 API 相关的核心功能。
目前在 Github 上 1.3k star,如果你觉得这个项目还不错的话,不妨点个 star 支持一下~
Github:
https://github.com/Postcatlab/postcat
Demo:
https://postcat.com/zh/?utm_source=al&utm_campaign=gf&utm_content=Electron