前言

目前采用的热更新方案是微软提供的（ cordova-plugin-code-push ）

主要从以下几方面说明：

本公司热更新部署流程
code-push部署规范
- mac端环境部署
- code-push服务器连接
- 命令介绍
- app环境部署
- 用法介绍

项目实际发布时场景

使用命令：

安装code-push控制台 npm install -g code-push-cli
注册：code-push register <私有服务器url，不填默认微软>
登录：code-push login
退出：code-push logout
登录私有服务器：code-push login <私有服务器url>
列出账号下所有项目：code-push app list
列出某一应用的部署信息：code-push deployment ls <appName>
查看部署的历史版本信息：code-push deployment history <appName>
发布版本更新：code-push release-cordova <appName> <os> <options>
把更新推送到另一个环境：code-push promote <appName> Staging Production
修改某个更新版本：code-push patch <appName> Staging [--label version --des "" -x true ...]

Options常用参数介绍：

--deploymentName（-d），指定部署类型，默认Staging，常用类型：Staging（测试）、Production（生产）
--label（-l），指定标签版本信息，默认最新
--description（--des），版本描述信息
--mandatory（-m），指定是否需要强制更新：[bool]，默认false
--targetBinaryVersion（-t），指定推送版本号（见下文【版本号发布规范】）
--rollout（-r），指定需要安装更新的用户比例（如50，则代指50%用户可安）
--disabled（-x），是否禁用当前更新 :[bool]

版本号发布规范：

--targetBinaryVersion（-t）使用规范

code-push部署规范

1、Mac端环境准备

全局安装code-push-cli
npm install -g code-push-cli

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

2、登录code-push-cli服务端

主要流程：

2.1、命令行登录code-push服务器
code-push login

该命令会打开浏览器窗口让我们登录code-push服务端

2.2、登录成功后会获取授权token

此处用github登录，成功后会返回一个授权token，复制此token

2.3、终端输入授权token

将获取到的token复制到命令行，回车则登录成功，如图

屏幕快照 2019-03-26 上午10.07.44.png

至此，code-push服务端算是登录成功了。

3、code-push 命令介绍

此处先介绍api，伴随api强调注意事项：

3.1、给app在热更新服务端创建应用
code-push app add <appName> <os> <platform>

eg> code-push app add test-ios ios cordova

<appName> : 应用在服务端名称（建议以app名称加"android"或"ios"后缀,以防忘记）
<os> : 应用所属系统（ios \ android），全小写
<platform> : 平台名称，此处都为 cordova

注意事项：

注意的是服务端在创建应用的时候会默认为每个应用生成两种部署类型("Production"和"Staging"),这两种类型分别代表生产环境和开发环境,一定要记下该过程中生成的这四个key值,key是用来连接客户端和服务端的

屏幕快照 2019-03-26 上午10.10.25.png

3.2、删除应用
code-push app rm <appName>
3.3、查看热更新服务端上创建的应用
code-push app list
3.4、发布应用
code-push release-cordova <appName> <platform > [options]
Options参数（常用的几个）：见上文

案例说明：

// 1、发布更新
code-push release-cordova test-ios ios --des "描述"
// 2、部署“Production”更新
code-push release-cordova test-ios ios -d "Production" --des "" -t "1.0.0"
// 3、添加强制更新
code-push release-cordova test-ios ios -m

注意事项：

一般生产环境的包是压缩过的，所以在发布正式热更新环境之前，先执行“cordova build --prod”压缩代码；
用“-m”设置为强制更新后，code-push插件从服务端下载完代码，会立即重启app
每次app发布新应用到商店的时候都应该同时往code-push服务器推送一个初始版本（后续每次提交版本，都会与初始版本比较并生成补丁包）

3.5、查看部署状态
code-push deployment list <appName>

eg:

// 查看test-ios部署状态

code-push deployment list test-ios

//查看test-ios部署状态及key值（忘记key值可以这样找）

code-push deployment list test-ios -k

3.6、清空部署纪录
code-push deployment clear <appName> <deploymentName>

eg:

// 清空test-ios 在Staging状态下的部署纪录

code-push deployment clear test-ios Staging

3.7、添加部署状态

默认只有“Staging”和“Production”两种状态
code-push deployment add <appName> <deploymentName>

eg:

code-push deployment add test-ios Staging

3.8、删除自定义部署状态
code-push deployment rm <appName> <deploymentName>
3.9、修改更新

code-push patch <appName> <deploymentName> [--label <label>] [--description <description>] [--disabled] [--mandatory] [--rollout <rolloutPercentage>
//eg:
//1、修改myApp在Staging环境下v3版本为不可用版本
code-push patch myApp Staging --label v3 --des "修改Staging环境下v3版本信息为不可用" -x true
//2、修改myApp在Staging下的更新推送范围为50%
code-push patch myApp Staging --des "修改更新" -r 50

3.10、升级环境

code-push promote <appName> <sourceDeploymentName> <destDeploymentName> <options>
//eg:
//1、将myApp中Staging部署的最新版本更新到Production中
code-push promote myApp Staging Production 
//2、在1的基础上，体现options约束
code-push promote myApp Staging Production --des "" -r 20

3.11、回滚更新

code-push rollback <appName> <deploymentName> [--targetRelease <releaseLabel>]
//--targetRelease,-r 指定回归到哪个标签，默认回滚到上一个更新
//eg：
//将myApp中Staging部署回滚到v3版本
code-push rollback myApp Staging -r v3

注意事项：不能跨app版本号回滚

4、app环境准备

4.1、进入app目录，安装热更新插件及插件依赖

cd "app目录"
cordova plugin add cordova-plugin-code-push

4.2、查看是否安装白名单插件，没有则安装

// 查看命令
cordova plugin list
// 安装命令
cordova plugin add cordova-plugin-whitelist

4.3、配置config.xml环境代码

添加如下配置以允许code-push服务器通讯

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

4.4、配置热更新key

在config.xml中添加deployment key，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>

4.5、配置index.html

在index.html中添加如下代码

<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 *" />

目的也是为了允许code-push服务器通讯

5、code-push api介绍

5.1、询问code-push服务端是否有更新
codePush.checkForUpdate(onSuccess, onError?, deploymentKey?: String);
eg：

codePush.checkForUpdate(function (update) {
    if (!update) {
        console.log("The app is up to date.");
    } else {
        console.log("An update is available! Should we download it?");
    }
});

6、用法

6.1、在app deviceready时直接使用
codePush.sync()
6.2、如果希望app能够尽快的获取更新信息，则

document.addEventListener("resume", function () {
    codePush.sync();
});

6.3、其他

7、工程中用法

if (window.cordova) {
        // if(this.platform.is("")){
        //
        // }
        if (window.codePush) {

            function syncStatus(status) {
                console.log('#', status)
            }

            function downloadProgress(downloadProgress) {
                if (downloadProgress) {
                    // console.log('##',downloadProgress);
                    // Update "downloading" modal with current download %
                    console.log("Downloading " + downloadProgress.receivedBytes + " of " + downloadProgress.totalBytes);
                    console.log("-----this-time------ "+new Date());
                }
            }

            window.codePush.sync(syncStatus, null, downloadProgress);
        }
        window.screen.orientation.lock('portrait-primary');
    }

code-push热更新部署方案