React Native 實現熱更新code-pushy

如下內容大部分轉載至: 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

  1. 在XCode中的Project Navigator裏,右鍵點擊LibrariesAdd Files to [你的工程名]
  2. 進入node_modulesreact-native-updateios 並選中 RCTHotUpdate.xcodeproj`
  3. 在XCode中的project navigator裏,選中你的工程,在 Build PhasesLink 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中添加以下代碼:ios

    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 部分增長以下代碼:git

    compile project(':react-native-update')
  3. 檢查你的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)

在工程targetBuild Phases->Link Binary with Libraries中加入libz.tbdlibbz2.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有三種狀況:

  1. {expired: true}:該應用包(原生部分)已過時,須要前往應用市場下載新的版本。
  2. {upToDate: true}:當前已經更新到最新,無需進行更新。
  3. {update: true}:當前有新版本能夠更新。info的namedescription字段可

以用於提示用戶,而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.jsbundleassets拖入項目;
    • 選擇Create folder references;
    • clipboard.png
  • Xcode中運行設備選真機或Generic iOS Device,而後菜單中選擇Product > Archive;
  • 導出:

clipboard.png

  • 選擇最後一項:

clipboard.png

  • 選擇None,會默認選擇全部機型;

clipboard.png

  • 下一步,不用改;

clipboard.png

  • 導出:

clipboard.png


而後運行以下命令

(把你的ipa直接拖過來,會自動填充文件路徑)

clipboard.png

$ pushy uploadIpa <your-package.ipa>

便可上傳ipa以供後續版本比對之用。

隨後你能夠選擇往AppStore發佈這個版本,也能夠先經過Test flight等方法進行測試。
clipboard.png

發佈安卓應用

首先參考文檔-生成已簽名的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,選擇設備

    • clipboard.png

clipboard.png

*選擇剛纔打包好的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)

若是遇到報錯:
clipboard.png

解決辦法:

  1. 打開node_module > react-native-update > local-cli > lib > budle.js;
  2. 找到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: <輸入包版本序號,序號就是上面列表中)前面的數字>

版本綁定完畢,能夠去客戶端就檢查到更新並進行更新;

相關文章
相關標籤/搜索