如果你在开发cordova的HybirdApp项目,那么你可能需要完成一个需求-热更新。
闲话不多说……假设你已经有以下环境:
- 本地服务器(可以使用集成环境,比如wamp)
- 一个cordova项目
正文
使用命令行工具(cmd之类),进入根目录(均代表cordova项目根目录),安装 热更新所需要的插件
// 笔者使用的cnpm,可换成npm、yarn等
$ cnpm install -g cordova-hot-code-push-cli
$ cordova plugin add cordova-hot-code-push-plugin
插件安装完成之后,在根目录创建cordova-hcp.json文件,写入内容(也可以使用cordova-hcp init命令创建):
{
// 自动在native(iOS/Android)下生成文件链接标签
"autogenerated": true,
// 项目名称(自行替换)
"name": "cn.com.cordovaApp",
// 更新的方式,有三个选项:start(app启动时安装更新，默认值)、now(app从后台切换过来的时候安装更新)、resume(web内容下载完毕即安装更新)
"update": "now",
// 项目在服务器上面的地址(这里使用了笔者本地的服务器地址,自行替换)
"content_url": "http://localhost/cordova/www"
}
然后继续在根目录的config.xml文件中加入以下这段:
<chcp>
<config-file url="http://localhost/cordova/www/chcp.json"/>
</chcp>
还有根目录的.chcpenv文件,把路径改为一致:
{
"content_url": "http://localhost/cordova/www",
"config_url": "http://localhost/cordova/www/chcp.json"
}
到这里,基本上配置方面都已经完成了,开始工作:
// 在项目的www目录生成chcp.json以及chcp.manifest
$ cordova-hcp build
// 生成apk
$ cordova build android
// IOS使用xcode完成,此处不讲,因为热更新的方法是相同的
执行完cordova-hcp build可以把www的所有文件复制到http://localhost/cordova/www服务器地址中。
然后安装apk到手机上,此时安装工作也已经完成。
热更新的执行步骤
修改h5项目代码,依旧执行:
// 更新chcp.json的时间戳
$ cordova-hcp build
可以把www的所有文件复制到http://localhost/cordova/www服务器地址中。
重启APP后就可看到改动后的APP了。
注意
如果热更新不生效,可以启动手机的USB调试模式,然后访问Chrome调试工具进行调试(仅限Android):
chcp.fetchUpdate(function(error, data){
console.log(error, data);
});
cordova-hot-code-push在cordova ready事件之后会提供一个全局chcp变量,在控制台打印更新的情况,如果error有值的话,可参考chcp error错误代码来进一步修改。
补充2017-11-14
以上教程的热更新属于自动化的，在用户完全不知情的情况下，于是就有了可选择更新的需求：
<chcp>
<auto-download enabled="false" />
<auto-install enabled="false" />
<config-file url="http://www.xxx.com/project/chcp.json" />
</chcp>
在config.xml改成以上配置，取消自动下载，取消自动安装，然后通过插件提供的jsAPI进行手动更新，以下在deviceready事件触发中示例（仅供参考）：
document.addEventListener('deviceready', () => {
let chcp = window.chcp;
// 检测更新
chcp.fetchUpdate((error, data) => {
// 表示没有更新版本，或者其他错误，详情的信息参考上面的chcp error链接
if (error) {
console.log('--fetchUpdate error--', error.code, error.description);
return;
}
// 这次更新的版本信息
console.log('--fetchUpdate--', data, data.config);
// 检测是否是否可以进行安装了，双重判断吧，有时候会出现有更新版本但是暂时无法安装的情况（也可以去掉这一层）
chcp.isUpdateAvailableForInstallation((error, data) => {
if (error) {
console.log('No update was loaded => nothing to install');
} else {
// 询问用户是否更新
if ( window.confirm('检测到新版本，是否更新') ) {
// 更新中
chcp.installUpdate((error) => {
if (error) {
// 更新失败
console.log('Failed to install the update with error code: ' + error.code);
console.log(error.description);
} else {
// 更新成功
console.log('Update installed!');
}
});
} else {
window.alert('您已拒绝更新');
}
// 对比版本号
console.log('Current content version: ' + data.currentVersion);
console.log('Ready to be installed:' + data.readyToInstallVersion);
}
});
});
});
另外补充个坑（Android上）
笔者是在原用zepto项目一步步重写成vue，使用了vue-router，然后难免有没有重写完成的页面(xxx.html，xxxx.html)，这种我是使用了window.location.href = 'xxx.html'进行跳转（ps:这些xxx.html页面没有使用到原生功能，所以没有引入chcp之类的插件），然后发现在使用了chcp插件后，进行跳转后进行window.history.back()回退到上一个页面（vue页面，使用了chcp插件），会把vue-router的历史记录清空了……
原因应该是chcp初始化的时候，把历史记录清空了，可把这段清空操作注释了，打开cordova项目目录/plugins/cordova-hot-code-push-plugin/src/android/src/com/nordnetab/chcp/main/HotCodePushPlugin.java
搜索webView.clearHistory();，然后注释掉就好了
