[深入剖析React Native]热更新之react-native-pushy使用指南(Android)

本文使用RN版本：0.33.0

react-native-pushy是ReactNative中文网推出的代码热更新服务，github地址：https://github.com/reactnativecn/react-native-pushy

准备工作

首先你应该有一个基于React Native开发的应用，我们把具有package.json的目录叫做你的”应用根目录”。

如果你还没有初始化应用，请参阅开始使用React Native。

所以我们也假设你已经拥有了开发React Native应用的一切环境，包括Node.js、npm、Android Studio、Android SDK等等。

如果你之前没安装过，你还必须安装Android NDK，并设置环境变量ANDROID_NDK_HOME，指向你的NDK根目录。

安装

$ npm install -g react-native-update-cli
$ npm install --save react-native-update
$ react-native link react-native-update

其中，npm install -g react-native-update-cli这一句在每一台电脑上仅需运行一次。
运行结果：

localhost:PushyReact wangdongdong$ npm install -g react-native-update-cli
/usr/local/bin/pushy -> /usr/local/lib/node_modules/react-native-update-cli/lib/cli.js
/usr/local/lib
└── react-native-update-cli@0.1.0 

localhost:PushyReact wangdongdong$ npm install --save react-native-update
npm WARN deprecated lodash-node@2.4.1: This package has been discontinued in favor of lodash@^4.0.0.
npm WARN deprecated minimatch@2.0.10: Please update to minimatch 3.0.2 or higher to avoid a RegExp DoS issue
PushyReact@0.0.1 /Users/wangdongdong/workingcode/react/PushyReact
└─┬ react-native-update@3.0.2 
  ├── cli-arguments@0.2.1 
  ├─┬ fs-promise@0.4.1 
  │ └── any-promise@1.3.0 
  ├─┬ ipa-Metadata@1.4.0 
  │ ├── async@1.2.1 
  │ ├─┬ chalk@1.0.0 
  │ │ ├─┬ has-ansi@1.0.3 
  │ │ │ └── ansi-regex@1.1.1 
  │ │ ├── strip-ansi@2.0.1 
  │ │ └── supports-color@1.3.1 
  │ ├─┬ decompress-zip@0.2.0 
  │ │ ├─┬ binary@0.3.0 
  │ │ │ ├── buffers@0.1.1 
  │ │ │ └─┬ chainsaw@0.1.0 
  │ │ │   └── traverse@0.3.9 
  │ │ ├─┬ graceful-fs@3.0.11 
  │ │ │ └── natives@1.1.0 
  │ │ ├── mkpath@0.1.0 
  │ │ └─┬ touch@0.0.3 
  │ │   └── nopt@1.0.10 
  │ ├─┬ entitlements@1.2.0 
  │ │ └─┬ simple-plist@0.0.4 
  │ │   └─┬ plist@1.1.0 
  │ │     ├── base64-js@0.0.6 
  │ │     ├── util-deprecate@1.0.0 
  │ │     └── xmlbuilder@2.2.1 
  │ ├─┬ glob@5.0.10 
  │ │ └── minimatch@2.0.10 
  │ ├── lodash@3.9.3 
  │ ├─┬ meow@3.1.0 
  │ │ ├─┬ camelcase-keys@1.0.0 
  │ │ │ └── camelcase@1.2.1 
  │ │ ├── indent-string@1.2.2 
  │ │ └── object-assign@2.1.1 
  │ ├─┬ provisioning@1.4.0 
  │ │ ├── cert-downloader@0.1.0 
  │ │ └─┬ simple-plist@0.0.4 
  │ │   └─┬ plist@1.1.0 
  │ │     ├── base64-js@0.0.6 
  │ │     ├── util-deprecate@1.0.0 
  │ │     └── xmlbuilder@2.2.1 
  │ ├─┬ rimraf@2.4.0 
  │ │ └── glob@4.5.3 
  │ ├─┬ simple-plist@0.0.4 
  │ │ └─┬ plist@1.1.0 
  │ │   ├── base64-js@0.0.6 
  │ │   ├── util-deprecate@1.0.0 
  │ │   └─┬ xmlbuilder@2.2.1 
  │ │     └── lodash-node@2.4.1 
  │ └─┬ temporary@0.0.8 
  │   └── package@1.0.1 
  ├── mkdir-recursive@0.2.3 
  ├─┬ node-apk-parser@0.2.3 
  │ ├── adm-zip@0.4.7 
  │ └── debug@0.7.4 
  ├── read@1.0.7 
  ├─┬ request@2.75.0 
  │ ├── aws-sign2@0.6.0 
  │ ├── aws4@1.4.1 
  │ ├── caseless@0.11.0 
  │ ├─┬ combined-stream@1.0.5 
  │ │ └── delayed-stream@1.0.0 
  │ ├── forever-agent@0.6.1 
  │ ├─┬ form-data@2.0.0 
  │ │ └── asynckit@0.4.0 
  │ ├─┬ har-validator@2.0.6 
  │ │ └─┬ is-my-json-valid@2.14.0 
  │ │   ├── generate-function@2.0.0 
  │ │   ├─┬ generate-object-property@1.2.0 
  │ │   │ └── is-property@1.0.2 
  │ │   └── jsonpointer@2.0.0 
  │ ├─┬ hawk@3.1.3 
  │ │ ├── boom@2.10.1 
  │ │ ├── cryptiles@2.0.5 
  │ │ └── sntp@1.0.9 
  │ ├─┬ http-signature@1.1.1 
  │ │ ├── assert-plus@0.2.0 
  │ │ ├─┬ jsprim@1.3.1 
  │ │ │ ├── extsprintf@1.0.2 
  │ │ │ ├── json-schema@0.2.3 
  │ │ │ └── verror@1.3.6 
  │ │ └─┬ sshpk@1.10.0 
  │ │   ├── asn1@0.2.3 
  │ │   ├── assert-plus@1.0.0 
  │ │   ├─┬ bcrypt-pbkdf@1.0.0 
  │ │   │ └── tweetnacl@0.14.3 
  │ │   ├─┬ dashdash@1.14.0 
  │ │   │ └── assert-plus@1.0.0 
  │ │   ├── ecc-jsbn@0.1.1 
  │ │   ├─┬ getpass@0.1.6 
  │ │   │ └── assert-plus@1.0.0 
  │ │   ├── jodid25519@1.0.2 
  │ │   ├── jsbn@0.1.0 
  │ │   └── tweetnacl@0.13.3 
  │ ├── is-typedarray@1.0.0 
  │ ├── isstream@0.1.2 
  │ ├── json-stringify-safe@5.0.1 
  │ ├── oauth-sign@0.8.2 
  │ ├── qs@6.2.1 
  │ ├── stringstream@0.0.5 
  │ └── tough-cookie@2.3.1 
  ├── yauzl@2.4.1 
  └── yazl@2.3.0 

localhost:PushyReact wangdongdong$ react-native link react-native-update
rnpm-install info Linking react-native-update android dependency 
rnpm-install info Android module react-native-update has been successfully linked 
rnpm-install info Linking react-native-update ios dependency 
rnpm-install info iOS module react-native-update has been successfully linked

注意：如果访问极慢或者显示网络失败，请使用淘宝镜像：
npm config set registry https://registry.npm.taobao.org –global
npm config set disturl https://npm.taobao.org/dist –global

手动安装(本步骤可选)

如果第一步已成功(安卓工程均能看到依赖),可以跳过此步骤。
1.在android/settings.gradle中添加如下代码:

include ':react-native-update' 
project(':react-native-update').projectDir = new File(rootProject.projectDir,'../node_modules/react-native-update/android')

2.在android/app/build.gradle的 dependencies 部分增加如下代码:

compile project(':react-native-update')

3.检查你的RN版本,如果是0.29及以上,打开android/app/src/main/java/[…]/MainApplication.java,否则打开android/app/src/main/java/[…]/MainActivity.java:
- 在文件开头增加 import cn.reactnative.modules.update.UpdatePackage;
- 在getPackages() 方法中增加 new UpdatePackage()(注意上一行可能要增加一个逗号)
效果如图：

配置Bundle URL

在你的MainApplication.java中增加如下代码：

// ... 其它代码

import cn.reactnative.modules.update.UpdateContext;
public class MainApplication extends Application implements ReactApplication {

  private final ReactNativeHost mReactNativeHost = new ReactNativeHost(this) {
    @Override
    protected String getJSBundleFile() {
        return UpdateContext.getBundleUrl(MainApplication.this);
    }
    // ... 其它代码
  }
}

登录与创建应用

先到Pushy注册注册地址

到命令行，在你的项目根目录下运行以下命令：

$ pushy login
email: <输入你的注册邮箱>
password: <输入你的密码>

这会在项目文件夹下创建一个.update文件，注意不要把这个文件上传到Git等CVS系统上。你可以在.gitignore末尾增加一行.update来忽略这个文件。

登录之后可以创建应用。注意iOS平台和安卓平台需要分别创建：
（本文先演示Android的，IOS请见下一篇文章。）

$ pushy createApp --platform android

注意：目前（2016.09.22）一个账户只能创建最多3个应用，多了会报错。

创建好后，会在你的Pushy管理页面中生成你的项目。

注意：如果你已经在网页端或者其它地方创建过应用，也可以直接选择应用：

$ pushy selectApp --platform android
3627) WangReact(android)
3692) PushyReact(android)

Total 2 ios apps
Enter appId: <输入应用前面的编号>

选择或者创建过应用后，你将可以在文件夹下看到update.json文件，其内容类似如下形式：

{
    "android": { "appId": 3692,"appKey": "<一串随机字符串>" } }

你可以安全的把update.json上传到Git等CVS系统上，与你的团队共享这个文件，它不包含任何敏感信息。当然，他们在使用任何功能之前，都必须首先输入pushy login进行登录。

至此应用的创建/选择就已经成功了。

在代码中添加热更新功能

获取appKey

检查更新时必须提供你的appKey，这个值保存在update.json中，并且根据平台不同而不同。你可以用如下的代码获取：

import {
  Platform,} from 'react-native';

import _updateConfig from './update.json';
const {appKey} = _updateConfig[Platform.OS];

如果你不使用pushy命令行，你也可以从网页端查看到你的应用appKey，并根据平台的不同来选择。

检查更新、下载更新

异步函数checkUpdate可以检查当前版本是否需要更新：

checkUpdate(appKey) .then(info => { })

返回的info有三种情况：

{expired: true}：该应用包(原生部分)已过期，需要前往应用市场下载新的版本。
{upToDate: true}：当前已经更新到最新，无需进行更新。
{update: true}：当前有新版本可以更新。 info的name、description字段可以用于提示用户，而MetaInfo字段则可以根据你的需求自定义其它属性(如是否静默更新、是否强制更新等等)。另外还有几个字段，包含了完整更新包或补丁包的下载地址， react-native-update会首先尝试耗费流量更少的更新方式。将info对象传递给downloadUpdate作为参数即可。

切换版本

downloadUpdate的返回值是一个hash字符串，它是当前版本的唯一标识。

你可以使用switchVersion函数立即切换版本(此时应用会立即重新加载)，或者选择调用 switchVersionLater，让应用在下一次启动的时候再加载新的版本。

downloadUpdate(info).then(hash => {
      Alert.alert('提示','下载完毕,是否重启应用?',[
        {text: '是',onPress: ()=>{switchVersion(hash);}},{text: '否',},{text: '下次启动时',onPress: ()=>{switchVersionLater(hash);}},]);
    }).catch(err => { 
      Alert.alert('提示','更新失败.');
    });

首次启动、回滚

在每次更新完毕后的首次启动时，isFirstTime常量会为true。你必须在应用退出前合适的任何时机，调用markSuccess，否则应用下一次启动的时候将会进行回滚操作。这一机制称作“反触发”，这样当你应用启动初期即遭遇问题的时候，也能在下一次启动时恢复运作。

你可以通过isFirstTime来获知这是当前版本的首次启动，也可以通过isRolledBack来获知应用刚刚经历了一次回滚操作。你可以在此时给予用户合理的提示。

componentWillMount(){
    if (isFirstTime) {
      Alert.alert('提示','这是当前版本第一次启动,是否要模拟启动失败?失败将回滚到上一版本',onPress: ()=>{throw new Error('模拟启动失败,请重启应用')}},onPress: ()=>{markSuccess()}},]);
    } else if (isRolledBack) {
      Alert.alert('提示','刚刚更新失败了,版本被回滚.');
    }
  }

完整的示例

/**
 * Sample React Native App
 * https://github.com/facebook/react-native
 * @flow
 */

import React,{ Component } from 'react';
import {
  AppRegistry,StyleSheet,Platform,Text,View,Alert,TouchableOpacity,Linking,} from 'react-native';

import {
  isFirstTime,isRolledBack,packageVersion,currentVersion,checkUpdate,downloadUpdate,switchVersion,switchVersionLater,markSuccess,} from 'react-native-update';

import _updateConfig from './update.json';
const {appKey} = _updateConfig[Platform.OS];

class PushyReact extends Component {

  componentWillMount(){
    if (isFirstTime) {
      Alert.alert('提示',版本被回滚.');
    }
  }

  doUpdate = info => {
    downloadUpdate(info).then(hash => {
      Alert.alert('提示','更新失败.');
    });
  }

  checkUpdate = () => {
    checkUpdate(appKey).then(info => {
      //Alert.alert('提示','info expired:'+info.expired+ ' upToDate:'+info.upToDate+' update:'+info.update);
      if (info.expired) {
        Alert.alert('提示','您的应用版本已更新,请前往应用商店下载新的版本',[
          {text: '确定',onPress: ()=>{info.downloadUrl && Linking.openURL(info.downloadUrl)}},]);
      } else if (info.upToDate) {
        Alert.alert('提示','您的应用版本已是最新.');
      } else {
        Alert.alert('提示','检查到新的版本'+info.name+',是否下载?\n'+ info.description,[
          {text: '是',onPress: ()=>{this.doUpdate(info)}},]);
      }
    }).catch(err => { 
      Alert.alert('提示','更新失败.');
    });
  }

  render() {
    return (
      <View style={styles.container}>
        <Text style={styles.welcome}>
          欢迎使用热更新服务
        </Text>
        <Text style={styles.instructions}>
          这是版本一 {'\n'}
          当前包版本号: {packageVersion}{'\n'}
          当前版本Hash: {currentVersion||'(空)'}{'\n'}
        </Text>
        <TouchableOpacity onPress={this.checkUpdate}>
          <Text style={styles.instructions}>
            点击这里检查更新
          </Text>
        </TouchableOpacity>
      </View>
    );
  }
}

const styles = StyleSheet.create({
  container: {
    flex: 1,justifyContent: 'center',alignItems: 'center',backgroundColor: '#F5FCFF',welcome: {
    fontSize: 20,textAlign: 'center',margin: 10,instructions: {
    textAlign: 'center',color: '#333333',marginBottom: 5,});

AppRegistry.registerComponent('PushyReact',() => PushyReact);

现在，你的应用已经可以通过update服务检查版本并进行更新了。下一步，你可以开始尝试发布应用包和版本。

发布应用包和版本

现在你的应用已经具备了检测更新的功能，下面我们来尝试发布并更新它。

注意，从update上传发布版本到发布版本正式上线期间，不要修改任何脚本和资源，这会影响update 获取本地代码，从而导致版本不能更新。如果在发布之前修改了脚本或资源，请在网页端删除之前上传的版本并重新上传。

发布Android应用

首先参考文档-生成已签名的APK设置签名，然后在android文件夹下运行./gradlew assembleRelease，你就可以在android/app/build/outputs/apk/app-release.apk中找到你的应用包。

然后运行如下命令

$ pushy uploadApk android/app/build/outputs/apk/app-release.apk

即可上传apk以供后续版本比对之用。

随后你可以选择往应用市场发布这个版本，也可以先往设备上直接安装这个apk文件以进行测试。

发布新的热更新版本

你可以尝试修改一行代码(譬如将版本一修改为版本二)，然后生成新的热更新版本。

$ pushy bundle --platform android
Bundling with React Native version:  0.33.0
<各种进度输出>
Bundled saved to: build/output/android.1474609357661.ppk
Would you like to publish it?(Y/N)

如果想要立即发布，此时输入Y。当然，你也可以在将来使用pushy publish --platform android <ppkFile>来发布版本。

Uploading [========================================================] 100% 0.0s
Enter version name: <输入版本名字，如1.0.10>
Enter description: <输入版本描述>
Enter Meta info: {"ok":1}
Ok.
Would you like to bind packages to this version?(Y/N)

此时版本已经提交到update服务，但用户暂时看不到此更新，你需要先将特定的包版本绑定到此热更新版本上。
此时输入Y立即绑定，你也可以在将来使用pushy update --platform android来使得对应包版本的用户更新。除此以外，你还可以在网页端操作，简单的将对应的包版本拖到此版本下即可。

Would you like to bind packages to this version?(Y/N) Y
2273) 1.0(normal) (newest)

Total 1 packages.
Enter packageId: 2273
Ok.

版本绑定完毕后，客户端就应当可以检查到更新并进行更新了。

恭喜你，至此为止，你已经完成了植入代码热更新的全部工作。

更多关注项目：react-native-pushy

转载请标注地址：Geek马走日
Follow个人Github : mazouri