React Native 如何用 Pushy 进行热更新

一、准备工作


此篇文章假设我们已经满足以上所有需要的准备工作。

记得【关注】,感谢支持,后期还会有更新。

先上一张 gif 图 ~~ 看看效果。

hotupdate.gif

二、安装

  • 在你项目的根目录运行以下指令
// 这一句指令在每一台电脑上只需要运行一次即可
$ npm install -g react-native-update-cli rnpm
  • 如果你访问速度过慢或者网络链接失败,请将镜像源换成国内镜像源
$ npm config set registry https://registry.npm.taobao.org --global
$ npm config set disturl https://npm.taobao.rog/dist --global
  • 安装保存指定的版本到你的项目
$ npm install --save react-native-update@具体版本号参看下面表格;
// 例如
$ npm install --save react-native-update@4.x
屏幕快照 2016-12-08 下午6.07.09.png
  • 链接
    • 使用指令链接
$ react-native link react-native-update;
// 如果你安装的 React Native 版本低于 0.29 则使用下面这条指令
$ npm link react-native-update

这时候如果 react-native link 成功的话 ( iOS 跟 Android 的工程中能够看到依赖 )
如果指令链接失败使用下面的手动链接

  • 使用手动链接
    • iOS
      1. 在 Xcode 中打开你的项目,选择项目然后右键 Show in Finder 进入项目的目录
      2. 找到你的 React Native 安装的位置,也就是 node_modules 文件夹
      3. 进入 node_modules 文件夹找到 react-native-update 里面的 ios 文件夹
      4. 将 RCTHotUpdate.xcodeproj 拖入到你的 Xcode 中
      5. 在项目的 Build Phases 找到 Link Binary With Libraries 点击下方的 + 加号
      6. 依次添加 RCTHotUpdate.alibz.tbd 还有 libbz2.1.0.tbd
      7. 完成后使用 Command + B 编译之后不报错就是 OK 啦
        Snip20161208_38.png
    • 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
  4. 在文件开头增加
import cn.reactnative.modules.update.UpdatePackage;
在 getPackages() 方法中增加 new UpdatePackage() (注意ES5的话,函数与函数之间要加一个逗号)

三、配置Bundle URL 在源生代码中使用

  • iOS

一般情况下是在 appDelegate 中 新增如下代码

#import "RCTHotUpdate.h"
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
        NSURL *jsCodeLocation;
#if DEBUG
        jsCodeLocation = [NSURL URLWithString:@"http://localhost:8081/index.ios.bundle?platform=ios&dev=true"];
#else 
        jsCodeLocation=[RCTHotUpdate bundleURL];
#endif 
        // ... 其它代码
}
  • Android

项目中 React Native 版本 >= 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);
    } 
    // ... 其它代码 
 }
}

项目中 React Native 版本 <= 0.28 在你的 MainActivity 中增加如下代码:

// ... 其它代码
import cn.reactnative.modules.update.UpdateContext;
public class MainActivity extends ReactActivity { 
      @Override protected String getJSBundleFile() {
         return UpdateContext.getBundleUrl(this);
      } 
      // ... 其它代码
}

四、登录与创建应用登录

  • 注册账号

http://update.reactnative.cn 注册账号

  • 登录

在你项目的根目录执行登录指令

$ pushy login
email: <你注册时的邮箱>
password: <你的登录密码>
登录.png

登录成功之后会在你项目的根目录创建一个 .update 文件

Snip20161209_8.png

需要注意的是不要把这个文件上传到 Git 中
你可以在 .gitignore 的末尾增加一行 .update 来忽略这个文件

Paste_Image.png
  • 创建应用
$ pushy createApp --platform ios
App Name: <输入你应用的名字>
$ pushy createApp --platform android
App Name: <输入你应用的名字>

两次输入的名字可以相同,不会有任何影响

  • 如果你在网页端或者其他地方创建过应用,可以直接选择应用
$ pushy selectApp --plateform ios
1) 微信
2) 微博
Total 2 ios apps
Enter appId: <输入应用前面的编号>
Paste_Image.png

选择完应用之后,会在你的根目录创建一个 update.json 的文件,其内容类似如下形式

{
      "ios": {
          "appId" : "1",
          "appKey" : "一串随机字符串",
      },
      "android": {
          "appId" : "2",
          "appKey" : "一串随机字符串",
      },
}

你可以把 update.json 文件上传到 Git 服务器,与你的团队共享这个文件
当然他们在使用任何功能时,都必须使用 pushy loagin 进行登录

五、使用热更新功能

  • 获取 appKey
    检查更新时必须提供你的 appKey 这个值保存在你项目的 update.json 文件中,并且根据平台不同而不同
    你可以使用如下代码进行获取相对应的 appKey
import {
    Platform,
} from 'react-native';
//-------------------------   华丽的分割线   -------------------------
import _updateConfig from './update.json';
const {appKey} = _updateConfig[Platform.OS];
  • 检查更新、下载更新
    • 异步函数 checkUpdate 可以检查当前版本是否需要更新
checkUpdate(appKey)
    .then(info =>{
        // 返回的 info 有三种情况
        // 1. {upToDate: true} 当前已经更新到最新版本,无需进行更新
        // 2. {expired: 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 ChiefSteward 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('ChiefSteward', () => ChiefSteward);

现在,你的应用已经可以通过 update 服务检查版本并进行更新了。

六、发布与更新

  • 首先需要注意的是

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

  • 发布 iOS 应用
    • 首先确保你的应用 release 模式下 能够在真机上使用离线包。如果不能下面的文章也许是你需要的
      React Native 在 release 模式真机运行

    • 然后点击菜单,按照正常的发布流程打一个 ipa 的包
      在 Xcode 中运行设备选 真机Generic iOS Device 然后菜单中选择 Product-Archive
      然后在你项目的根目录运行如下命令

$ pushy uploadIpa <把你打的 ipa 的包拖拽到这里>

此处上传 ipa 是为了后续版本对比之用。

  • 发布 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 <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)

如果想要立即发布,此时输入 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: <输入包版本序号,序号就是上面列表中)前面的数字>

来一张完成的图


Paste_Image.png

版本绑定完毕后,客户端就应当可以检查到更新并进行更新了。
恭喜你,至此为止,你已经完成了植入代码热更新的全部工作。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,088评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,715评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,361评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,099评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 60,987评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,063评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,486评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,175评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,440评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,518评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,305评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,190评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,550评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,880评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,152评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,451评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,637评论 2 335

推荐阅读更多精彩内容