一、安裝注冊code-push
1.安裝code-push
$ npm install -g code-push-cli
2.注冊賬號
$ code-push register
這時候會自動啟動瀏覽器打開網頁并提供一個codePush AccessKey,然后命令行里出現需要輸入access key
Enter your access key:
輸入access key?登錄
3.添加一個CodePush應用(myProject是應用名字)
$ code-push app add ?myProject
出現
|| name || Deployment Key ||
|| Production || (一串37位的key) ||
|| Staging || (一串37位的key) ||
如上有兩個發布鍵值。一個Production是對應生產環境的,二Staging是對應開發環境的。當然我們還可以添加其他的發布鍵值。
這個值在后面我們集成工程里面要用到。
二、react-native應用接入code-push
1.安裝react-native-code-push
在項目根目錄運行
$ npm install react-native-code-push --save
2.cocoapods導入code-push
-
ios
修改Podfile文件,添加:
pod 'CodePush', :path => './node_modules/react-native-code-push'
運行
$ pod install
-
android
-
RNPM
安裝 RNPM(依次運行)
如果 React Native 版本 >= 0.27 (因為 rnpm link 已經被合并到React Native CLI)$ react-native link react-native-code-push
否則
$ npm i -g rnpm
$ rnpm link react-native-code-push
-
手動
在android/settings.gradle文件里添加
include ':app'
include ':react-native-code-push'
project(':react-native-code-push').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-code-push/android/app')
在android/app/build.gradle文件里添加
dependencies {
...
compile project(':react-native-code-push')
}
在android/app/build.gradle文件里添加
...
apply from: "../../node_modules/react-native/react.gradle"
apply from: "../../node_modules/react-native-code-push/android/codepush.gradle"
...
修改MainApplication.java文件
...
// 1. Import the plugin class.
import com.microsoft.codepush.react.CodePush;// public class MainActivity extends ReactActivity { // For React Native v0.19 - v0.28 public class MainApplication extends Application implements ReactApplication { // For React Native >= 0.29 private final ReactNativeHost mReactNativeHost = new ReactNativeHost(this) { ... // 2. Override the getJSBundleFile method in order to let // the CodePush runtime determine where to get the JS // bundle location from on each app start @Override protected String getJSBundleFile() { return CodePush.getJSBundleFile(); } @Override protected List<ReactPackage> getPackages() { // 3. Instantiate an instance of the CodePush runtime and add it to the list of // existing packages, specifying the right deployment key. If you don't already // have it, you can run "code-push deployment ls <appName> -k" to retrieve your key. return Arrays.<ReactPackage>asList( new MainReactPackage(), new CodePush("deployment-key-here", MainApplication.this, BuildConfig.DEBUG) ); } }; }
在android/app/build.gradle文件中(應用版本codepush需要三位數)
android{
defaultConfig{
versionName "1.0.0"
}
}
Background React Instances
This section is only necessary if you're explicitly launching a React Native instance without an Activity
(for example, from within a native push notification receiver). For these situations, CodePush must be told how to find your React Native instance.*
In order to update/restart your React Native instance, CodePush must be configured with a ReactInstanceHolder
before attempting to restart an instance in the background. This is usually done in your Application
implementation.
修改MainApplication.java文件
// For React Native >= v0.29
...
// 1. Declare your ReactNativeHost to extend ReactInstanceHolder.
// ReactInstanceHolder is a subset of ReactNativeHost, so no additional implementation is needed.
import com.microsoft.codepush.react.ReactInstanceHolder;
public class MyReactNativeHost extends ReactNativeHost implements ReactInstanceHolder {
// ... usual overrides
}
// 2. Provide your ReactNativeHost to CodePush.
public class MainApplication extends Application implements ReactApplication {
private final MyReactNativeHost mReactNativeHost = new MyReactNativeHost(this);
@Override public void onCreate() {
CodePush.setReactInstanceHolder(mReactNativeHost);
super.onCreate();
}
}
// For React Native v0.19 - v0.28
// 1. Provide your ReactNativeHost to CodePush.
public class MainApplication extends Application {
// ... initialize your instance holder
@Override public void onCreate() {
CodePush.setReactInstanceHolder(mReactNativeHost);
super.onCreate();
}
}
以上的操作,即可成功集成CodePush。
3.配置相關文件
-
IOS
1.修改js程序入口文件
RN應用是appDelegate.m
原生應用是ReactView.m
#ifdef DEBUG
jsCodeLocation = [NSURL URLWithString:@"http://192.168.1.103:8081/index.ios.bundle?platform=ios"];
#else
jsCodeLocation = [CodePush bundleURLForResource:@"index"];
#endif
2.修改info.plist文件
<key>CodePushDeploymentKey</key>
<string>前面添加應用得到的發布key(注意這里要選擇是正式版的key還是測試版的key,不是發布到appstore可以用Staging的key)</string>
命令行里面輸入
$ code-push
可以看到code-push各個命令
三、更新策略(js)
1、導入react-native-code-push
import codePush from "react-native-code-push";
2、策略
默認情況下,CodePush會在app每次啟動的時候去檢測是否有更新,如果有,app會自動下載并在下次打開app時安裝
class MyApp extends Component {}
MyApp = codePush(MyApp);
// For ES7
import codePush from "react-native-code-push";
@codePush
class MyApp extends Component {}
每次打開app時檢測更新并下載,下次打開app時安裝
// Sync for updates everytime the app resumes.
class MyApp extends Component {}
MyApp = codePush({
checkFrequency: codePush.CheckFrequency.ON_APP_RESUME,
installMode: codePush.InstallMode.ON_NEXT_RESUME
})(MyApp);
實時檢測更新并下載,下載完成后立即安裝
// Active update, which lets the end user know
// about each update, and displays it to them
// immediately after downloading it
class MyApp extends Component {}
MyApp = codePush({
updateDialog: true,
installMode: codePush.InstallMode.IMMEDIATE
})(MyApp);
記錄app檢測、下載、安裝的狀態(可以實現進度條當做友好提示)
// Make use of the event hooks to keep track of
// the different stages of the sync process.
class MyApp extends Component {
codePushStatusDidChange(status) {
switch(status) {
case codePush.SyncStatus.CHECKING_FOR_UPDATE:
console.log("Checking for updates.");
break;
case codePush.SyncStatus.DOWNLOADING_PACKAGE:
console.log("Downloading package.");
break;
case codePush.SyncStatus.INSTALLING_UPDATE:
console.log("Installing update.");
break;
case codePush.SyncStatus.UP_TO_DATE:
console.log("Installing update.");
break;
case codePush.SyncStatus.UPDATE_INSTALLED:
console.log("Update installed.");
break;
}
}
codePushDownloadDidProgress(progress) {
console.log(progress.receivedBytes + " of " + progress.totalBytes + " received.");
}
}
MyApp = codePush(MyApp);
CodePushOptions
- checkFrequency (codePush.CheckFrequency) - 檢測更新的時機
方法 | 描述 |
---|---|
ON_APP_START(0) | app啟動后 |
ON_APP_RESUME(1) | app從后臺切換過來時 |
ON_APP_MANUAL(2) | 不能自動檢測,只有在調用 codePush.sync() 時觸發 |
- deploymentKey (String) - 部署key,可以在js里動態修改
- installMode (codePush.InstallMode) - 安裝時機
方法 | 描述 |
---|---|
IMMEDIATE(0) | 立即安裝并重啟app |
ON_NEXT_RESTART(1) | 下次啟動app時安裝 |
ON_NEXT_RESUME(2) | app從后臺切換過來時安裝 |
-
mandatoryInstallMode (codePush.InstallMode) - 同
codePush.InstallMode.IMMEDIATE
-
minimumBackgroundDuration (Number) - app在后臺切換過來安裝的最小秒數,配合
installMode.ON_NEXT_RESUME
使用 - updateDialog (UpdateDialogOptions) - 對話框
屬性 | 描述 |
---|---|
appendReleaseDescription(Boolean) | 是否發送通知消息顯示給用戶,默認為false |
descriptionPrefix(String) | 描述的前綴,默認為“Description:” |
mandatoryContinueButtonLabel(String) | 強制更新下的繼續按鈕的文本,默認為“Continue” |
mandatoryUpdateMessage(String) | 強制更新的通知消息文本,默認為“An update is available that must be installed.” |
optionalIgnoreButtonLabel(String) | 忽略按鈕的文本,默認為“Ignore” |
optionalUpdateMessage(String) | 通知消息文本,默認為“An update is available. Would you like to install it?” |
title(String) | 對話框的標題,默認為“Update available” |
optionalUpdateMessage | 通知消息文本 |
codePushStatusDidChange
用于監聽檢測、下載、安裝的狀態——SyncStatus
方法 | 描述 |
---|---|
CHECKING_FOR_UPDATE (0) | 查詢更新 |
AWAITING_USER_ACTION (1) | 有更新并且有對話框顯示給最終用戶(這只是適用updateDialog時使用) |
DOWNLOADING_PACKAGE (2) | 正在下載 |
INSTALLING_UPDATE (3) | 正在安裝 |
UP_TO_DATE (4) | 更新完成 |
UPDATE_IGNORED (5) | 提示更新后,用戶選擇了忽視(這只是適用updateDialog時使用) |
UPDATE_INSTALLED (6) | 已經安裝,并將運行syncStatusChangedCallback函數返回后立即或下次啟動更新,在InstallMode SyncOptions中指定。 |
SYNC_IN_PROGRESS (7) | 有一個正在進行的同步操作運行,防止當前的調用被執行。 |
UNKNOWN_ERROR (-1) | 同步操作遇到了一個未知錯誤。 |
codePushDownloadDidProgress
下載進度
返回參數 | 描述 |
---|---|
totalBytes (number) | 預計大小 |
receivedBytes(number) | 已下載大小 |
disallowRestart/allowRestart
class OnboardingProcess extends Component {
...
componentWillMount() {
// Ensure that any CodePush updates which are
// synchronized in the background can't trigger
// a restart while this component is mounted. codePush.disallowRestart();
}
componentWillUnmount() {
// Reallow restarts, and optionally trigger
// a restart if one was currently pending.
codePush.allowRestart();
}
...
}
四、發布版本
1、打包
$ code-push release myProject ./bundle/index.jsbundle 1.20.1 --mandatory true
myProject代表我們要更新的項目名稱,就是前面我們注冊的index.jsbundle是我們要更新的內容,1.20.1是我們在appstore發布的版本號,注意這個地方是我們程序二進制文件的版本號,其實這句命令就是:更新myProject 1.20.1的版本二進制文件,只有1.20.1的版本才能收到更新。最后面的參數是是否強制更新。這段命令沒有指定更新的環境是正式環境還是測試環境,默認的是測試環境,如果要發布到正式環境需要指定一下
code-push release wanna ./bundle/index.jsbundle 1.20.1 -d "Production" --mandatory true。
后面還可以在后面添加參數比如1.20.1版本的多少用戶可以更新–rollout 20,代表百分之20的myProject 1.20.1的用戶可以收到這個更新
2、修改發布后版本的參數
比如上面,我們發布更新到了1.20.1的測試版本,更新百分之20的用戶,可是我們發布完成之后,想更新百分之30的用戶:
$ code-push patch wanna 1.20.1 --rollout 20
code-push for redux -- react-native-code-push-saga
注意:
- 蘋果不允許應用內有彈框提示更新