React Native 实现热更新code-pushy

时间 2019-12-20

标签 react native 实现更新 code pushy 栏目 React 繁體版

原文原文链接

如下内容大部分转载至： https://github.com/reactnativ...

（一）准备工做

安装

在你的项目根目录下运行如下命令：javascript

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这一句在每一台电脑上仅需运行一次。html

注意

建议设置使用淘宝镜像（也仅需设置一次）：java

npm config set registry https://registry.npm.taobao.org --global
npm config set disturl https://npm.taobao.org/dist --global

版本

由于React Native不一样版本代码结构不一样，于是请按下面表格对号入座：node

React Native版本	react-native-update版本
0.26及如下	1.0.x
0.27 - 0.28	2.x
0.29 - 0.33	3.x
0.34 - 0.45	4.x
0.46及以上	5.x

安装命令示例：react

npm install --save react-native-update@5.x

手动link

若是第一步的react-native link已成功能够跳过此步骤android

iOS

在XCode中的Project Navigator里,右键点击Libraries ➜ Add Files to [你的工程名]
进入node_modules ➜ react-native-update ➜ ios 并选中 RCTHotUpdate.xcodeproj`
在XCode中的project navigator里,选中你的工程,在 Build Phases ➜ Link Binary With Libraries 中添加 libRCTHotUpdate.a
继续在Build Settings里搜索Header Search Path，添加$(SRCROOT)/../node_modules/react-native-update/ios
Run your project (Cmd+R)

Android

在android/settings.gradle中添加以下代码:ios

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

在android/app/build.gradle的 dependencies 部分增长以下代码:git
```
compile project(':react-native-update')
```
检查你的RN版本,若是是0.29及以上, 打开android/app/src/main/java/[...]/MainApplication.java,不然打开android/app/src/main/java/[...]/MainActivity.javagithub
- 在文件开头增长 import cn.reactnative.modules.update.UpdatePackage;
- 在getPackages() 方法中增长 new UpdatePackage()(注意上一行可能要增长一个逗号)

配置Bundle URL(iOS)

在工程target的Build Phases->Link Binary with Libraries中加入libz.tbd、libbz2.1.0.tbdobjective-c

在你的AppDelegate.m文件中增长以下代码：

// ... 其它代码

#import "RCTHotUpdate.h"

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
#if DEBUG
  // 原来的jsCodeLocation保留在这里
  jsCodeLocation = ..........
#else
  // 非DEBUG状况下启用热更新
  jsCodeLocation=[RCTHotUpdate bundleURL];
#endif
  // ... 其它代码
}

配置Bundle URL(Android)

0.29及之后版本：在你的MainApplication中增长以下代码：

// ... 其它代码

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);
    }
    // ... 其它代码
  }
}

0.28及之前版本：在你的MainActivity中增长以下代码：

// ... 其它代码

import cn.reactnative.modules.update.UpdateContext;

public class MainActivity extends ReactActivity {

    @Override
    protected String getJSBundleFile() {
        return UpdateContext.getBundleUrl(this);
    }
    // ... 其它代码
}

iOS的ATS例外配置

从iOS9开始，苹果要求以白名单的形式在Info.plist中列出外部的非https接口，以督促开发者部署https协议。在咱们的服务部署https协议以前，请在Info.plist中添加以下例外（右键点击Info.plist，选择open as - source code）：

<key>NSAppTransportSecurity</key>
<dict>
    <key>NSExceptionDomains</key>
    <dict>
        <key>reactnative.cn</key>
        <dict>
            <key>NSIncludesSubdomains</key>
            <true/>
            <key>NSExceptionAllowsInsecureHTTPLoads</key>
            <true/>
        </dict>
   </dict>
</dict>

登陆与建立应用

首先请在http://update.reactnative.cn注册账号，而后在你的项目根目录下运行如下命令：

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

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

登陆以后能够建立应用。注意iOS平台和安卓平台须要分别建立：

$ pushy createApp --platform ios
App Name: <输入应用名字>
$ pushy createApp --platform android
App Name: <输入应用名字>

两次输入的名字能够相同，这没有关系。

若是你已经在网页端或者其它地方建立过应用，也能够直接选择应用：

$ pushy selectApp --platform ios
1) 鱼多多(ios)
3) 招财旺(ios)

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

选择或者建立过应用后，你将能够在文件夹下看到update.json文件，其内容相似以下形式：

{
    "ios": {
        "appId": 1,
        "appKey": "<一串随机字符串>"
    },
    "android": {
        "appId": 2,
        "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，让应用在下一次启动的时候再加载新的版本。

首次启动、回滚

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

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

完整的示例

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 MyProject extends Component {
  componentWillMount(){
    if (isFirstTime) {
      Alert.alert('提示', '这是当前版本第一次启动,是否要模拟启动失败?失败将回滚到上一版本', [
        {text: '是', onPress: ()=>{throw new Error('模拟启动失败,请重启应用')}},
        {text: '否', onPress: ()=>{markSuccess()}},
      ]);
    } else if (isRolledBack) {
      Alert.alert('提示', '刚刚更新失败了,版本被回滚.');
    }
  }
  doUpdate = info => {
    downloadUpdate(info).then(hash => {
      Alert.alert('提示', '下载完毕,是否重启应用?', [
        {text: '是', onPress: ()=>{switchVersion(hash);}},
        {text: '否',},
        {text: '下次启动时', onPress: ()=>{switchVersionLater(hash);}},
      ]);
    }).catch(err => { 
      Alert.alert('提示', '更新失败.');
    });
  };
  checkUpdate = () => {
    checkUpdate(appKey).then(info => {
      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)}},
          {text: '否',},
        ]);
      }
    }).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('MyProject', () => MyProject);

如今，你的应用已经能够经过update服务检查版本并进行更新了。

发布应用

如今你的应用已经具有了检测更新的功能，下面咱们来尝试发布并更新它。

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

发布iOS应用

首先参考文档-在设备上运行，
肯定你正在使用离线包。而后点击菜单。

按照正常的发布流程打包.ipa文件;

Xcode打包ipa详解

运行打包命令：npm run bundle-ios
- 将main.ios.jsbundle、assets拖入项目；
- 选择Create folder references；
Xcode中运行设备选真机或Generic iOS Device，而后菜单中选择Product > Archive;
导出：

选择最后一项：

选择None，会默认选择全部机型；

下一步，不用改；

导出：

而后运行以下命令

(把你的ipa直接拖过来，会自动填充文件路径)

$ pushy uploadIpa <your-package.ipa>

便可上传ipa以供后续版本比对之用。

随后你能够选择往AppStore发布这个版本，也能够先经过Test flight等方法进行测试。

发布安卓应用

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

而后运行以下命令

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

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

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

将Ipa安装到设备

打开Xcode，选择设备

*选择刚才打包好的ipa。

发布新的热更新版本

你能够尝试修改一行代码(譬如将版本一修改成版本二)，而后生成新的热更新版本。

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

若是遇到报错：

解决办法：

打开node_module > react-native-update > local-cli > lib > budle.js;
找到439行，metro-bundler改成metro；

若是想要当即发布，此时输入Y。固然，你也能够在未来使用pushy publish --platform <ios|android> <ppkFile>来发布版本。

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

此时版本已经提交到update服务，但用户暂时看不到此更新，你须要先将特定的包版本绑定到此热更新版本上。

此时输入Y当即绑定，你也能够在未来使用pushy update --platform <ios|android>来使得对应包版本的用户更新。
除此之外，你还能够在网页端操做，简单的将对应的包版本拖到此版本下便可。

Offset 0
1) FvXnROJ1 1.0.1 (no package)
2) FiWYm9lB 1.0 [1.0]
Enter versionId or page Up/page Down/Begin(U/D/B) <输入序号,U/D翻页,B回到开始，序号就是上面列表中)前面的数字>

1) 1.0(normal) - 3 FiWYm9lB (未命名)

Total 1 packages.
Enter packageId: <输入包版本序号，序号就是上面列表中)前面的数字>

版本绑定完毕，能够去客户端就检查到更新并进行更新；