Cordova热更新和App升级 - 简书

原文: Cordova热更新和App升级 - 简书

公司的cordova项目前段时间增长了热更新功能，本身第一次作的时候在网上查找了不少资料，有的资料写的并不全面遇到了不少坑。所以总结一些在开发过程当中遇到了问题和解决办法。

cordova项目热更新分为两个部分，网页内容（web content)更新和Cordova插件(native side)更新。前者是网页内容，后者是 cordova 插件。web content 的运行是基于 native side。如:登陆页面的微信登陆，须要在项目中集成微信的插件才能实现登陆。

web代码的更新

此更新方式，只须要更新web前段代码，不须要更新android的原生代码。只是对js、html等的更新。

一、添加插件 Cordova Hot Code Push

cordova plugin add cordova-hot-code-push-plugin

二、添加热更新工具 cordova-hot-code-push-cli

npm install -g cordova-hot-code-push-cli

三、添加cordova-hcp.json文件

此文件是用于方便生成www文件下chcp.json文件的内容。

执行命令（必须在项目根目录执行更新工具的命令）

cordova-hcp init

生成的默认应用程序配置文件(cordova-hcp.json)在项目根文件夹中。

执行时将要求您从命令行中填写一些项目首选项：

• Project name: 你如今的项目名称所需.
• Amazon S3 Bucket name:亚马逊上的S3桶的名字。能够跳过。
• Amazon S3 region: 亚马逊S3地区。能够跳过。
• iOS app identifier: 应用程序商店的应用程序ID。App升级是跳转应用商店进行升级。
• Android app identifier: 能够App在应用商城的地址，或者是apk的下载地址。
• Update method: 什么时候执行更新。
  • start: 在启动应用程序时安装更新。
  • resume: 在恢复应用程序(从背景移动到前景状态)或启动时，安装更新；默认使用。
  • now: 从服务器加载更新后当即安装。

cordova-hcp.json文件内容：

{
  "name": "",//可为空
  "autogenerated": true,//若是不添加，热更新会不能使用
  "ios_identifier": "id123456789",//应用在App store id(可为空)
  "android_identifier": "",//应用在应用商城上的地址或者App的下载地址(可为空)
  "update": "start",//在应用启动时安装
  "min_native_interface": 1,//可用以作App升级（能够不填)
  "content_url":
  "http://************/cordova/www"//www文件在服务器上的地址
}

"autogenerated": true 这个值执行命令后是没有的须要本身手动添加，若是不添加网页内容更新将会无效。

四、在www文件下生成chcp.json 和 chcp.manifest文件

• chcp.json: 包含发布相关信息：热更新代码版本号，应用 native side 版本号等等
• chcp.manifest: 包含项目热更新代码(静态)文件信息：文件名和文件哈希值

执行命令

cordova-hcp build

执行此命令会在chcp.json文件中增长"release":"当前时间"字段。（默认使用时间戳，格式为：yyyy.MM.dd-HH.mm.ss），插件将版本号进行字符串相等比较来判断是否存在新版本。

"release": "2017.06.07-16.30.20",//惟一web项目版本号,用与热更新web内容的更新。（必需）

五、config.xml 配置

最好写在底部方便之后配置修改

<chcp>
    <auto-download enabled="true" />

    <auto-install enabled="true" />

    <native-interface version="1" />
    
    <config-file url="https://************/cordova/www/chcp.json" />
</chcp>

• config-file：配置文件 chcp.json 从服务器上加载的路径（必须的配置项）
• auto-download：是否自动下载热更新代码，默认是 true
• auto-install：是否自动安装热更新代码，默认是 true
• native-interface：当前 native side 的版本号

六、将www文件放到服务器

这一步我是直接将项目的www文件夹放到服务器上，而后重启app，就可实现App的web内容代码的热更新了。须要注意的是www文件在服务地地址必定要与"content_url":"http://************/cordova/www"和config.xml中<config-file url="https://************/cordova/www/chcp.json" /> 填写的地址一致。

更新App

其实完成上面步骤，就能够实现热更新功能了。可是当咱们增长了cordova插件或者原生中添加了第三方库等，须要对App升级。那么这个时候就要去对应的商城下载apk（苹果去app store升级）所以还须要下面的配置。

一、config.xml 配置中定义native side 版本号

<chcp>

    <native-interface version="5" /> </chcp>

此配置会与服务器上配置文件 chcp.json 中的 min_native_interface 值做比较 。

1. 两个值相同 ，不提示升级，可是网页内容能够更新。

2. 若是大于服务器上的值，不会提醒更新，可是网页内容能够更新。

3. 小于服务上的值，提示应用须要更新升级，那么热更新将没法正常进行。

二、添加JS代码  Wiki文档

document.addEventListener('deviceready', () => {
    let chcp = window.chcp;

    // 检测更新
    chcp.fetchUpdate((error, data) => {


      if (error) {
        console.log('--更新版本异常，或其余错误--', error.code, error.description);
        if (error.code === -2) {
          var dialogMessage = '有新的版本是否下载';
          //调用升级提示框 点击确认会跳转对应商店升级
          chcp.requestApplicationUpdate(dialogMessage, null, null);
        }
      }
      // 服务器版本信息
      // console.log('--更新的版本信息--', data.config);
      // 版本信息
      chcp.getVersionInfo((err, data) => {

        console.log('服务器应用时间版本: ' + data.readyToInstallWebVersion);

        console.log('当前应用时间版本： ' + data.currentWebVersion);

        console.log('当前应用version name: ' + data.appVersion);

      });

    });
  });

若是当前APP中的<native-interface version="1"/>低于服器上chcp.json中min_native_interface的值，那么执行热更新就会提示错误：chcp.error.APPLICATION_BUILD_VERSION_TOO_LOW，返回的异常码为-2。这个时候咱们应当提示用户前往应用商店对APP进行升级。

须要注意的是，若是弹出的升级提示框点击确认的跳转对应平台升级app的地址，是咱们在cordova-hcp.json中填写的地址；若是点击了取消，那么就不会升级，而且网页的热更新功能也将失效，除非升级为最新的apk。

详细错误代码参考

总结：

热更新分为网页内容的跟新和cordova插件的更新,前者更新不须要升级App，后者须要升级App，在使用热更新功能是最好是两个功能都要实现。

---

补充：

1. cordova若是网页内容和App升级两个都要实现，请将config.xml配置选项

<auto-download enabled="true" />
<auto-install enabled="true" />

2. cordova热更新弹出框很难看，android测试为黑色背景绿色文字。网上找了不少的资料，也没能找到解决cordova自带对话框样式的方法。若是有解决的方法请留意一下，谢谢！

相关链接

Cordova 代码热更新