CN107256161A - 基于electron技术的客户端升级方法 - Google Patents

Abstract

一种基于electron技术的客户端升级方法，包括如下步骤：一.打包内容升级包：二.检测升级并下载内容升级包：版本检测服务根据配置信息判断：A.不用升级；B.容器版本需要升级；C.内容版本需要升级；三.安装内容升级包；四.加载内容升级包：加载后返回第二步。其优点是A.使用内容升级后，直接把50兆的升级包变成3兆的内容升级包。升级时间大大缩短。B.只升级内容，不升级浏览器内核，使浏览器内核相对稳定。减少反复升级浏览器内核带来的风险。C.内容升级和容器升级是两套平行的升级机制。当需要更新浏览器内核的时候，仍然可以整体升级软件。

Description

基于electron技术的客户端升级方法

技术领域

本发明涉及数据交换，涉及传输控制规程，尤指一种基于electron技术的客户端升级方法。

背景技术

Electron是一种打包了浏览器内核webkit和nodejs的运行环境。使用Electron，javascript，html,css这些web开发技术可以用来开发客户端。Electron程序开发完成后，使用javascript,html,css开发的H5程序和Electron提供的运行环境一起被打包成安装包，供用户下载安装。最终安装到用户电脑上运行。Electron技术的出现是革命性的。它带来两个好处1.H5技术也可以用来开发客户端程序，不需要C++知识。这样大大降低了开发成本。2.Electron开发的H5程序是跨平台的。

Electron应用程序一旦被用户下载安装就需要后续的软件升级，确保用户能用上最新的功能。现有的升级流程一般是这样的。当用户启动软件的时候，软件发送当前的版本信息到一个后台版本升级服务，版本升级服务根据配置检测是否需要引导用户升级，并下发升级包的地址。这个升级包是一个全新的安装包，包含electron运行环境和H5程序。Windows上安装包是一个setup安装文件，mac上则是一个app包或是一个dmg镜像。当新的安装文件下载后，启动新版本安装。

现有的升级方法存在这样一个缺点：打包了Electron运行环境和H5程序的安装包比较大，造成下载升级不方便。安装包较大的主要原因还是因为Electron运行环境比较大，大概40-50M大小，包含浏览器webkit内核和nodejs组件。而H5程序占比则小的多。每次程序发布新版本，用户都需要下载较大的安装包。安装包越大，用户越难有耐心下载完。

发明内容

针对现有技术的缺点，本发明的目的在于提供一种基于electron技术的客户端升级方法。旨在解决electron程序升级过程中，由于安装包太大，而不方便升级的问题。

本发明解决其技术问题所采用的技术方案是：提供一种基于electron技术的客户端升级方法，其特征在于包括如下步骤：

一.打包内容升级包：

首先制作内容升级包，把一个文件夹的所有升级内容打包为一个文件；使用asar文件作为内容包的格式；打包asar内容包后，一并打包版本描述json文件为zip包，作为内容升级包；

二.检测升级并下载内容升级包：

在内容升级包中增加内容版本号标识；使一个软件有两个版本号，一个是原来的软件的容器版本号，一个是内容升级包的版本号；把容器版本号和内容版本号一起发给版本检测服务；版本检测服务根据配置信息判断：

A.当前版本均为最新版本，不用升级，执行原客户端软件；

B.容器版本需要升级；执行全量安装包升级，然后返回第一步；

C.内容版本需要升级；由版本检测服务告诉前端内容升级包的地址和内容升级包的md5哈希值；前端下载内容升级包到一个临时目录后校验md5哈希值；md5不正确，则删除安装包，并询问用户，下载出错是否重试，是则返回第一步，否则退出；md5正确则执行如下第三步；

三.安装内容升级包：

把内容升级包移动到有写入权限的目录，解压缩出asar文件和元数据文件；在元数据文件中增加当前运行程序的容器版本和内容版本；作废已安装的内容升级包作废已安装的内容升级包；

四.加载内容升级包：

重新启动程序，首先检查数据目录中是否有内容升级包；如果内容升级包的元数据文件中的容器版本匹配当前容器的版本，则内容升级包有效，可以从内容包中加载H5入口页面index.html；如果版本不匹配，说明升级包无效，则删除内容包，并加载安装目录下的内容包中的index.html；加载后返回第二步。

本发明的有益效果是：

A.使用内容升级后，直接把50兆的升级包变成3兆的内容升级包。升级时间大大缩短。

B.只升级内容，不升级浏览器内核，使浏览器内核相对稳定。减少反复升级浏览器内核带来的风险。

C.另外，内容升级和容器升级是两套平行的升级机制。当需要更新浏览器内核的时候，仍然可以整体升级软件。

附图说明

下面结合附图对本发明作进一步的描述。

图1是本发明的流程方框图。

图2是本发明的内容升级包结构示意图。

图3是本发明的内容升级包安装后的结构示意图。

具体实施方式

参见附图，本发明一种基于electron技术的客户端升级方法，其特征在于包括如下步骤：

一.打包内容升级包：

内容升级首先需要制作内容升级包；asar是一种类似于tar的文件格式，相当于把一个文件夹的所有内容打包为一个文件；Electron支持直接运行打包了所有h5资源的asar文件；因此可以使用asar文件作为内容包的格式；但是，由于asar文件由于没有元数据，不方便直接查看asar内容包的版本号，且无压缩，不方便网络传输；我们打包asar内容包后，一并打包版本描述json文件为zip包，作为内容升级包；内容包升级的时候解压缩zip包；程序启动时加载asar文件中的H5入口页面index.html；

二.检测升级并下载内容升级包：

为了实现内容升级的检测，内容包中必须增加内容版本号标识；这样一个软件就有了两个版本号，一个是原来的软件的版本号，即容器版本号，一个是内容包的版本号；软件启动检测版本的时候，把容器版本号和内容版本号一起发给版本检测服务(图1C)；版本检测服务根据配置信息返回给软件三种情况：1.不用升级；2.需要容器升级；3.需要内容升级；第一种情况，表明当前软件为最新版本，可以正常启动；第二种情况就是原来的全量安装包升级机制，仍保留，作为内容升级的补充；第三种情况，是本文所述内容升级；版本检测服务需要告诉前端内容升级包的地址，内容升级包的md5哈希值；md5哈希值用于校验下载的升级包真实性；接着，前端下载内容升级包到一个临时目录后(图1D)，校验md5哈希值；md5不正确，则删除安装包，并询问用户，下载出错是否重试；md5正确则说明内容升级包可用，可以安装内容升级包；

三.安装内容升级包：

由于程序是没有权限修改软件的安装目录下的文件的，即windows下面非管理员账户启动的软件无权限修改Program Files目录下的自身的安装文件，而mac下的程序可以修改app包内容，但会破坏数字签名证书，造成程序不可用；这样内容升级包直接替换安装目录下的内容包是不可行的；本方案把内容升级包移动到有写入权限的目录，比如程序的数据目录，windows下为AppData\Roaming\YourApp，mac为～/Library/ApplicationSupport/YourApp；移动上一步下载的内容升级包至此，并解压缩出asar文件和元数据文件(图1E)；同时，在元数据文件中增加当前运行程序的容器版本和内容版本；这个版本号需要在程序加载内容包的时候检查；这个措施确保当程序容器升级的时候，作废已安装的内容升级包；

四.加载内容升级包：

有了上一步的内容升级包后，程序在重新启动的时候首先检查数据目录中是否有内容升级包；如果内容升级包的元数据文件中的容器版本匹配当前容器的版本，则内容升级包有效，可以从内容包中加载H5入口页面index.html；如果版本不匹配，说明升级包无效，则删除内容包，并加载安装目录下的内容包中的index.html(图1B)；加载后进行步骤二所述的版本升级检测。

在本发明的实施例中：

使用两个版本号分别标示容器和内容的版本号。启动的时候，首先把容器版本号和内容版本号通过http请求发给后台版本检测服务https://update.gf.com.cn/update/containerApp/checkVersion。内容升级的时候，后台版本检测服务返回内容升级包的大小，md5和地址给前端。前端下载地址中的升级包到临时目录，并校验大小，md5。如果大小，md5正确，升级包被移动到程序的数据目录下，进行安装。否则，则提示下载出错。(数据目录是一个有写入权限的目录，windows下为～\AppData\Roaming\gf-trader，mac为～/Library/Application Support/gf-trader)。

下载的内容升级包是一个zip文件，包含一个asar文件，一个元数据json文件。Asar文件是打包的h5资源(类似于tar文件，Electron运行时支持直接加载asar文件中的html页面包括js,html,css，图片等文件)，元数据文件则描述这个升级包的版本号信息。安装过程首先解压内容升级zip包。然后，在元数据json文件中追加写入当前被升级的软件的内容包版本号和容器版本号，最后重启软件。

重新启动后，至易版在加载过程中，首先检查程序的数据目录中是否有升级包。不存在内容升级包，则从软件内置的内容包加载入口html文件。存在内容升级包，则读取元数据json文件，并判断升级包的版本号和容器版本号是否和当前启动的软件的容器版本号、内容版本号匹配。如果容器版本号不匹配，说明内容升级包已经不适用于当前安装的软件版本，则删除失效的内容升级包，并从软件中内置的内容包加载。如果匹配，则加载内容升级包asar文件中H5入口页面。内容升级完成。

Claims (1)

1.一种基于electron技术的客户端升级方法，其特征在于包括如下步骤：

一.打包内容升级包：

首先制作内容升级包，把一个文件夹的所有升级内容打包为一个文件；使用asar文件作为内容包的格式；打包asar内容包后，一并打包版本描述json文件为zip包，作为内容升级包；

二.检测升级并下载内容升级包：

在内容升级包中增加内容版本号标识；使一个软件有两个版本号，一个是原来的软件的容器版本号，一个是内容升级包的版本号；把容器版本号和内容版本号一起发给版本检测服务；版本检测服务根据配置信息判断：

A.当前版本均为最新版本，不用升级，执行原客户端软件；

B.容器版本需要升级；执行全量安装包升级，然后返回第一步；

C.内容版本需要升级；由版本检测服务告诉前端内容升级包的地址和内容升级包的md5哈希值；前端下载内容升级包到一个临时目录后校验md5哈希值；md5不正确，则删除安装包，并询问用户，下载出错是否重试，是则返回第一步，否则退出；md5正确则执行如下第三步；

三.安装内容升级包：

把内容升级包移动到有写入权限的目录，解压缩出asar文件和元数据文件；在元数据文件中增加当前运行程序的容器版本和内容版本；作废已安装的内容升级包作废已安装的内容升级包；

四.加载内容升级包：

重新启动程序，首先检查数据目录中是否有内容升级包；如果内容升级包的元数据文件中的容器版本匹配当前容器的版本，则内容升级包有效，可以从内容包中加载H5入口页面index.html；如果版本不匹配，说明升级包无效，则删除内容包，并加载安装目录下的内容包中的index.html；加载后返回第二步。