ionic2/3实战-热更新(cordova-plugin-code-push)

前言

  • 什么是热更新?热更新就是动态下发代码,它可以使开发者在不发布新版本的情况下,修复 BUG 和发布功能.用户毫无感知,还可以绕过某些应用商店的长时间审核
  • ionic实现热更新的插件有好几个,本文以微软公司提供的热更新插件(cordova-plugin-code-push)为例.这里还有一款热更新插件的介绍
  • 大公司提供的服务坑少,我在集成的过程中很顺利,只是集成步骤比较多,各位只要认真阅读文档都可以成功

参考文档

环境准备

  • 全局安装typescript、typings、tslint、code-push-cli
cnpm install -g typescript
cnpm install -g typings
cnpm install -g tslint
cnpm install -g code-push-cli
目前(2017年10月16日 08:59:44)的版本信息

注:code-push-cli是连接热更新服务端的工具,我们把要更新的代码上传至服务端,客户端(我们的app)安装cordova-plugin-code-push插件来从服务端下载代码.

登录code-push服务端

  • 使用code-push login命令会打开浏览器窗口让我们登录code-push服务端
  • 我这里用github帐号登录,你也可以使用其他帐号,登录成功会返回一个权限token

  • 复制token粘帖到命令行工具中,回车则会登录成功

使用code-push-cli在服务端创建应用

  • 使用命令code-push app add <appName> <os> <platform>创建应用;前面说过我们要部署代码到热更新服务端;<appName>建议以app名称加"_android"或"_ios"后缀,以防忘记
  • 如下图,给app在服务端分别创建了android和ios的cordova应用.默认为每个应用生成两种部署类型("Production"和"Staging"),我们就用这两种类型分别代表生产环境和开发环境,请记下你生成的这四个key值,key是用来连接客户端和服务端的
code-push app add ionic2_tabs_android android cordova
code-push app add ionic2_tabs_ios ios cordova


注:也可以在web端查看/管理app,传送门

app环境准备

  • 进入app目录,安装热更新插件及插件依赖
ionic cordova plugin add cordova-plugin-code-push
cnpm install --save @ionic-native/code-push
  • 查看是否安装白名单插件cordova plugin list,如果没有安装请安装ionic cordova plugin add cordova-plugin-whitelist
  • config.xml添加如下配置允许与CodePush服务器通信
<access origin="*" />

或者

<access origin="https://codepush.azurewebsites.net" />
<access origin="https://codepush.blob.core.windows.net" />
<access origin="https://codepushupdates.azureedge.net" />

app代码准备

  • app.module.ts声明插件 import {CodePush} from "@ionic-native/code-push";
export const CODE_PUSH_DEPLOYMENT_KEY = {
  'android':{
    'Production':'你的android Production key',
    'Staging':'你的android Staging key'
  },
  'ios':{
     'Production':'你的ios Production key',
    'Staging':'你的ios Staging key'
  }
};
import {CodePush} from "@ionic-native/code-push";
constructor(private codePush: CodePush) {}
  /**
   * 热更新同步方法
   */
 sync() {
    if (this.isMobile()) {
      let deploymentKey = '';
      if (this.isAndroid() && IS_DEBUG) {
        deploymentKey = CODE_PUSH_DEPLOYMENT_KEY.android.Staging;
      }
      if (this.isAndroid() && !IS_DEBUG) {
        deploymentKey = CODE_PUSH_DEPLOYMENT_KEY.android.Production;
      }
      if (this.isIos() && IS_DEBUG) {
        deploymentKey = CODE_PUSH_DEPLOYMENT_KEY.ios.Staging;
      }
      if (this.isIos() && !IS_DEBUG) {
        deploymentKey = CODE_PUSH_DEPLOYMENT_KEY.ios.Production;
      }
      this.codePush.sync({
        deploymentKey: deploymentKey
      }).subscribe(syncStatus => {
        console.log(syncStatus);
      });
    }
  }
  • 在app启动的时候调用code-push同步方法
  • 热更新插件只能在真机测试.所以现在打包app并安装到手机上.我这里以android为例先安装一个debug版本的app到手机上

安装了新插件,记得执行cordova platform rm androidcordova platform add android

发布更新

  • 使用命令code-push deployment list <appName>查看发布状态
    如下图可以看到目前android应用"Production"和"Staging"两种部署状态都没有发布更新,也没有安装记录

这是安装在手机上的app页面

修改代码使页面按钮颜色为红色,然后发布更新
  • 使用命令code-push release-cordova <appName> <platform> [options]发布更新,如下图所示.

默认发布"Staging"部署状态,也就是开发版.code-push release-cordova ionic2_tabs_android android --des "修改按钮颜色"
发布上传时间依网速快慢大概需要1分钟左右
再次查看发布状态,会看到"Staging"已经有一个版本"v1",但是还没有安装记录

  • 前面已经设置app在启动的时候会调用code-push同步方法,所以我们现在退出app,重新打开app,如下gif演示了code-push下载更新过程(点击gif放大看)
  • 再次查看部署状态已经发现有一个更新安装记录,说明热更新成功

code-push常用命令

//给app在热更新服务器上创建应用
code-push app add <appName> <os> <platform> 

//删除应用
code-push app rm <appName>

//查看热更新服务器上有哪些应用
code-push app list

//发布应用
code-push release-cordova <appName> <platform> [options]
 Options参数:
  --deploymentName, -d ..指定部署的类型.默认"Staging",可以选择"Production"或其他  自定义类型
  --description, --des ..添加描述
  --mandatory, -m .......指定此版本是否为强制更新版本
  例1:发布更新
  code-push release-cordova ionic2_tabs_android android --des ""
  例2:部署"Production"状态的更新,即生产环境的热更新部署使用这句命令
  code-push release-cordova ionic2_tabs_android android  -d "Production" --des ""
  注意:一般生产环境的app是压缩过的,所以在发布正式环境热更新之前,先执行"ionic build --prod"压缩代码
  例3:部署ios应用的更新
  code-push release-cordova ionic2_tabs_ios ios --des ""
  例4:添加-m参数强制更新,code-push插件从服务端下载完代码,会立即自动重启app
  code-push release-cordova ionic2_tabs_android android  -m --des ""

//查看部署状态
code-push deployment list <appName>
  例1:
  code-push deployment list ionic2_tabs_android
  例2:查看部署状态及key值,忘记key就这样找
  code-push deployment list ionic2_tabs_android -k

//清空部署记录
code-push deployment clear <appName> <deploymentName>
如:清空Staging状态的部署记录
code-push deployment clear ionic2_tabs_android Staging

//添加部署状态,默认只有"Staging"和"Production"两中状态
code-push deployment add <appName> [deploymentName]

//删除自定义的部署状态
code-push deployment rm <appName> <deploymentName>

其他问题

  • 官方文档教程中,要给index.html添加如下<meta>,经测试不用添加
<meta http-equiv="Content-Security-Policy" content="default-src https://codepush.azurewebsites.net 'self' data: gap: https://ssl.gstatic.com 'unsafe-eval'; style-src 'self' 'unsafe-inline'; media-src *" />
  • 官方文档教程中,添加如下代码到config.xml中.即把热更新key值放到config.xml中.但是这样切换生产环境和开发环境不够方便,于是本文把部署key放到代码层动态指定
<platform name="android">
    <preference name="CodePushDeploymentKey" value="YOUR-ANDROID-DEPLOYMENT-KEY" />
</platform>
<platform name="ios">
    <preference name="CodePushDeploymentKey" value="YOUR-IOS-DEPLOYMENT-KEY" />
</platform>
  • 关于苹果 App Store禁止热更新的说明
    目前还没有全面禁止热更新,收到警告邮件的开发者绝大部分是使用了 JS-Patch 或 Rollout 的热更新类库
    我公司的应用都是企业内部应用,还没有应用上传到 App Store上,所以不受此限制.
    ios cordova的热更新应用能否上传到App Store和实现热更新,我觉得90%没问题,各位测试后请留言.
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,482评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,377评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,762评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,273评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,289评论 5 373
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,046评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,351评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,988评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,476评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,948评论 2 324
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,064评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,712评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,261评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,264评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,486评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,511评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,802评论 2 345

推荐阅读更多精彩内容