美文网首页RN
React Native代码热更新

React Native代码热更新

作者: 沐风雨木 | 来源:发表于2017-06-22 17:18 被阅读391次

    开发React Native (以下简称 RN)主要就是看中他的动态更新和跨平台以及代码复用,本文介绍RN的动态更新,主要记录遇到的坑和为后来人提供参考,用到的是RN中文网推出的代码热更新服务,链接:https://github.com/reactnativecn/react-native-pushy

    1. react-native-update

    版本
    因为React Native不同版本代码结构不同,因而请按下面表格对号入座:

    Paste_Image.png
    优势
    1.命令行工具&网页双端管理,版本发布过程简单便捷,完全可以集成CI。
    2.基于bsdiff算法创建的超小更新包,通常版本迭代后在1-10KB之间,避免数百KB的流量消耗。
    3.支持崩溃回滚,安全可靠。
    4.meta信息及开放API,提供更高扩展性。
    5.跨越多个版本进行更新时,只需要下载一个更新包,不需要逐版本依次更新。

    2. 准备工作

    到这里,已默认你已经有一个基于React Native开发的应用和开发React Native应用的一切环境,包括Node.js、npm、XCode、Android SDK等等。
    如果你之前没安装过,你还必须安装Android NDK,并设置环境变量ANDROID_NDK_HOME,指向你的NDK根目录(例如/Users/tdzl2003/Downloads/android-ndk)。这里我是直接用Android Studio的SDK Manger安装:

    Paste_Image.png
    注:NDK安装在Android SDK的目录中,需要下载什么图中已标注。
    

    安装
    在你的项目根目录下运行以下命令:

    npm install -g react-native-update-cli rnpm
    npm install --save react-native-update@具体版本请看上面的表格
    react-native link react-native-update
    

    版本例:npm install --save react-native-update@4.x

    npm install -g react-native-update-cli rnpm这一句在每一台电脑上仅需运行一次。
    如果RN版本低于0.29,请使用rnpm link代替react-native link命令。

    注:如果访问极慢或者显示网络失败,请设置使用淘宝镜像(也仅需设置一次):
    
    npm config set registry https://registry.npm.taobao.org --global
    npm config set disturl https://npm.taobao.org/dist --global
    

    手动link

    如果第一步的react-native link已成功(iOS工程和安卓工程均能看到依赖),可以跳过此步骤

    IOS

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

    Android

    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(iOS)

    在工程 target 的 Build Phases->Link Binary with Libraries 中加入 libz.tbd、libbz2.1.0.tbd
    在你的 AppDelegate.m 文件中增加如下代码:

    // ... 其它代码
    
    #import "RCTHotUpdate.h"
    
    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
    {
    #if DEBUG
      // 原来的jsCodeLocation
      jsCodeLocation = [NSURL URLWithString:@"http://localhost:8081/index.ios.bundle?platform=ios&dev=true"];
    #else
      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进行登录。

    3. 添加热更新功能

    获取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有三种情况:

    1. {expired: true}:该应用包(原生部分)已过期,需要前往应用市场下载新的版本。

    2. {upToDate: true}:当前已经更新到最新,无需进行更新。

    3. {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服务检查版本并进行更新了。

    4. 发布应用

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

    发布iOS应用

    首先参考文档-在设备上运行, 确定你正在使用离线包。然后点击菜单。
    按照正常的发布流程打包 .ipa 文件(Xcode中运行设备选真机或 Generic iOS Device,然后菜单中选择 Product-Archive),然后运行如下命令

    $ 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
    
    注:Windows系统下去掉 $ 。此时你可能在android文件夹下,需在根目录下运行。
    

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

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

    发布新的热更新版本

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

    $ 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) 
    
    注:Windows环境下命令:pushy bundle --platform
    

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

    Paste_Image.png
      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)
    

    见截图(packageId就是下面截图 1.0(normal) 前面括号中的数组,此时meta info什么意思,我还不明白,谁知道下面留言告诉我,蟹蟹):

    Paste_Image.png

    此时版本已经提交到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: <输入包版本序号,序号就是上面列表中)前面的数字>
    

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

    恭喜你,至此为止,你已经完成了植入代码热更新的全部工作。接下来,你可以查阅常见问题与高级指南了解更多深入的知识,尤其是在实际项目中的运用技巧。

    相关文章

      网友评论

        本文标题:React Native代码热更新

        本文链接:https://www.haomeiwen.com/subject/xksfcxtx.html