Cordova android平台开发三(热更新cordova-hot-code-push-plugin配置)

在config.xml中chcp节点下配置cordova-hot-code-push-plugin插件

1、config.xml 配置项

  • config-file:
    定义一个url,指定加载app版本更新的配置文件chcp.json,默认(在config.xml中未配置)的情况下,会半自动设置为本地服务上的chcp.json的途径。
chcp config-file url="https://5027caf9.ngrok.com/chcp.json"//chcp
  • auto-download:
    半自动下载web内容更新,默认是半自动,假如需要手动下载更新,可以设置JavaScript板块,不使用半自动下载可以设置auto-download为false。
chcp auto-download enabled="false" //chcp
  • auto-install:
    半自动安装,web内容更新,默认半自动安装,需要手动安装,可以设置JavaScript板块,不使用半自动安装可以设置false。
chcp auto-install enabled="false" //chcp

2、热更新插件必备的两个自有配置文件 chcp.json 和 chcp.manifest.

①、app热更新配置文件 www/chcp.json

release版本号,最低需要的外壳app版本号。文件置于www文件夹下,需要被打包到外壳app中,此文件可以用cordova-hcp(Cordova-hot-code-push-plugin)命令行半自动生成,在项目根目次下,执行:cordova-hcp init 可以生成此文件,之后发布新的release版本时,只要执行 cordova-hcp build 即可,详细命令参见:
https://github.com/nordnet/cordova-hot-code-push-cli
例:

{ "autogenerated": true,
  "release": "2016.09.30-10.15.04",
  "content_url": "https://179dc874.ngrok.io", 
  "update": "now"}
  • content_url:
    服务器端url,服务器端web内容文件的位置,插件会以此为base url来下载chcp.manifest和chcp.json。
  • release:
    每次release版本发布,都务必是唯一的,插件基于此才可以知道有没有新版本release。热更新插件比较release字符串是否对等,假如不等即表达服务端有新版本(注意:不得比较体积)。
  • min_native_interface:
    所需最小的外壳app版本,这是app的build版本号,是正整数,不是应用商店中形如“0.0.1”字符串。
    需要注意的是在config.xml中,指定build版本形式如次:
widget id="com.xxxxxx.hybrid"
version="0.0.1"
xmlns="http://www.w3.org/ns/widgets"
xmlns:cdv="http://cordova.apache.org/ns/1.0"
android-versionCode="12"
ios-CFBundleVersion="3"

version — app字符串版本号,既用户在APP应用商店上看见的版本号
android-versionCode — 安卓的build版本号,用于 min_native_interface
ios-CFBundleVersion — IOS的build版本号,用于 min_native_interface
例:app增加了新的插件,需要更新外壳app,为避免用户下载了不适应如今外壳版本的web内容,需要设置chcp.json 中 min_native_interface的值,例如我们app中chcp.json如次:

{ "autogenerated": true,
   "release": "2016.09.30-10.15.04", 
   "content_url": "https://132ec098.ngrok.io", 
   "update": "now",
   "min_native_interface":10}

此时外壳app的build版本是12(参见config.xml 中android-versionCode的值),若热更新的时候,web内容的release发布,

{ "autogenerated": true,
   "release": "2016.10.01-10.15.04", 
   "content_url": "https://132ec068.ngrok.io", 
   "update": "now",
   "min_native_interface":15}

此时加载chcp.json时,发现min_native_interface要求外壳app的版本是15,而外壳app现时build版本是12,显然不能满足web内容更新后外壳app最低版本要求15,(min_native_interface比外壳app的build版本高)此时,不会下载web内容,而是发出一个chcp_updateLoadFailed错误事件,告知用户需要升班外壳app版本。

  • update:
    只能安装web内容的时机,可用值如次:
    start — APP启动时安装更新(默认值)
    resume — app 从后台切换到前台时安装
    now — 下载完成web内容后,即安装更新
    注:可以禁用半自动安装改用手动安装,需要用到javascript module。
  • android_identifier:
    apk包名,假如指定此值,将指导用户到Google Play Store的app页面(国内用不到)。
  • ios_identifier:
    ios应用标号,例:id345038631,假如指定了,指导用户到App Store 中app的页面。
②、web内容清单文件chcp.manifest

包含所有web内容文件的名称和md5值。

[
{
"file": "css/style.css",
"hash": "84a33cf00d95bc1e3617cc35262f7e94"
},
{
"file": "img/adam.jpg",
"hash": "b445da3cc203f97bce534fdad93b3931"
},
{
"file": "img/ben.png",
"hash": "2d983b2362f6db11855af918c7f95aee"
}
]

依据此文件来对比web内容文件的删除、新增、更新。
更新阶段,从服务器下载所有web文件
安装阶段,删除服务器端不存在的文件
此文件在放在www下,chcp.manifest 需要打包到外壳app中,同时也要放在服务器端www文件夹下(chcp.json中content_url指定的过访url)。可以经过命令 cordova-hcp build 生成 chcp.manifest 清单文件。

  • file:
    相对于www的文件途径名,既储存web文件的位置。
  • hash:
    文件的MD5值,用于检测自上次release以来,这个文件是否变更过,以及文件的完整性校验,每次更新web内容都需要更新此文件,否则不会检测到更新。

3、Build operations配置文件

不一样于在config.xml文件中修改插件配置,假如想在执行build命令行的时候修改插件配置,就需要用到chcpbuild.options文件。文件务必位于项目根目次下,文件采用json款式,此文件只有build命令执行时生效,不影响config.xml中的配置,无需改动,变更的是特定平台下的config.xml(cordova build 过程的after_perpare阶段)。
例如:config.xml文件中

chcp config-file url="https://company_server.com/mobile/www/chcp.json" //chcp

在 项目根目次下开创 chcpbuild.options 文件,内容如次:

{
   "dev": { "config-file": "https://dev.company_server.com/mobile/www/chcp.json" }, 
   "production": { "config-file": "https://company_server.com/mobile/www/chcp.json" }, 
   "QA": { "config-file": "https://test.company_server.com/mobile/www/chcp.json" }
}

build app 的时分,转为开发要用的服务器,可执行:

cordova build -- chcp-dev

结果就是, 特定平台下的 config.xml 文件(譬如, /Cordova/TestProject/platforms/android/res/xml/config.xml) 变成:

chcp config-file url="https://dev.company_server.com/mobile/www/chcp.json"//chcp

你可能注意到 - 我们用的命令有个 chcp-. 这个是必须的, 这样插件才知道, 这个参变量是为它设置的. 而且, 不会和其他插件的命令参变量冲突.
假如你的app可以测试了 - 你可以用下边的命令build, 就指定了测试服务器:

cordova build -- chcp-QA

特定平台下的 config.xml 便会成为:

chcp config-file url="https://test.company_server.com/mobile/www/chcp.json"//chcp

当我们需要上架app的时候 (Google Play, App Store) - 我们正常build:

cordova build --release

这样config.xml 是不会变更的,假如没有设置 chcpbuild.options - 插件会使用 config.xml 里面默认的值.

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,233评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,013评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,030评论 0 241
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,827评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,221评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,542评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,814评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,513评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,225评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,497评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,998评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,342评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,986评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,055评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,812评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,560评论 2 271
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,461评论 2 266

推荐阅读更多精彩内容

  • 简介 关于Cordova的热更新问题,国内的资料比较少,许多博客上都是胡乱的抄袭,准确性极低,无任何实用性,并且步...
    cl9000阅读 6,273评论 10 15
  • 热更新:当用户初次打开app,它会将所有的web内容复制一份到外部存储。此后从外部存储加载web内容,而并不加载打...
    方千竹阅读 1,698评论 0 0
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,099评论 18 139
  • 做过移动端native开发的朋友,都应该知道版本的发布是件让人挺头疼的事来的。尤其iOS的版本发布,不但要...
    Jock58阅读 4,179评论 5 1