React Native CodePush實踐小結

前言

CodePush是微軟提供的一套可用于React Native和Cordova的熱更新服務,國內(nèi)也有類似的服務Pushy,從關注度和使用人數(shù)來說,CodePush完勝于Pushy(截至目前,CodePush在Github上Star數(shù)2900+,Pushy Star數(shù)600+,畢竟大公司的產(chǎn)品更讓開發(fā)者心里有底,但CodePush是否真的絕對比Pushy要好不做評價)

CodePush 安裝與注冊

1.安裝 CodePush CLI

使用命令npm install -g code-push-cli安裝CodePush終端

ps.都在開發(fā)React Native了,npm安裝就無需贅言了吧。

2.注冊CodePush 賬號

CodePush終端安裝完成后就可以使用code-push命令了。
在終端輸入code-push register,會跳轉(zhuǎn)授權網(wǎng)頁。在這個網(wǎng)頁可以選擇Github?;蛘呶④涀鳛槭跈嗵峁┱?,不過我覺得90%的開發(fā)者都會選擇Github。

授權完成后,CodePush會顯示你的Access Key,復制輸入到終端即可完成注冊并登陸。
ps.只要不主動退出(通過code-push logout命令),登陸狀態(tài)會一直有效。

在CodePush服務器中創(chuàng)建App

在終端輸入code-push app add <appName>即可完成創(chuàng)建,注冊完成之后會返回一套deployment key,包括Staging和Production。該key在后面步驟中會用到。

enter description here
enter description here

心得:如果你的應用分為Android和iOS版,那么在向CodePush注冊應用的時候需要注冊兩個App獲取兩套deployment key,如:
code-push app add AppDemo-Android
code-push app add AppDemo-iOS
因為發(fā)布的時候使用的打包命令是有所不同的,因此需要做區(qū)分。

code-push相關常見命令如下:

Usage: code-push app <command>
命令:
  add       創(chuàng)建一個新的App
  remove    刪除App
  rm        刪除App
  rename    重命名已經(jīng)存在App
  list      列出與你賬戶關聯(lián)的所有App
  ls        列出與你賬戶關聯(lián)的所有App
  transfer  將一個App的所有權轉(zhuǎn)讓給另一個帳戶

CodePush集成

這里跟進使用端分Android集成iOS集成,但二者都有共通的部分

  • 在React Native項目中安裝codePush依賴:npm install --save react-native-code-push
  • 通過react-native link命令自動構建關聯(lián),這里會要求輸入 deployment key,直接Enter跳過即可,因為我們會在后續(xù)步驟中通過更加靈活的方式配置

接下來的步驟,AndroidiOS有所不同,因此分開來說。

Android端集成

  1. 打開android/app/build.gradle文件,修改android-buildTypes節(jié)點成如下
 buildTypes {
        debug{
            //省略了其他配置
            buildConfigField "String", "CODEPUSH_KEY", '""'
        }
        releaseStaging {
            buildConfigField "String", "CODEPUSH_KEY", '"此處填寫Staging key"'
        }
        release {
            //省略了其他配置
            buildConfigField "String", "CODEPUSH_KEY", '"此處填寫Production key"'
        }
    }
  1. 在android/app/build.gradle設置好deployment-key之后呢,我們就可以使用了:
    修改MainApplication.java文件中的getPackages()方法為如下:
 protected List<ReactPackage> getPackages() {
            return Arrays.<ReactPackage>asList(
                    new MainReactPackage(),
                    new RCTSwipeRefreshLayoutPackage(),
                    new VectorIconsPackage(),
                    new CodePush(BuildConfig.CODEPUSH_KEY, MainApplication.this, BuildConfig.DEBUG)// Add/change this line.
            );
        }

3.修改VersionName
在 android/app/build.gradle中有個 android.defaultConfig.versionName屬性,我們需要把 應用版本改成 三位,比如1.0,需要修改成1.0.0

至此,CodePush在Android端的集成工作已經(jīng)完成了。

iOS端集成

  1. 使用Xcode打開項目,Xcode的項目導航視圖中的PROJECT下選擇你的項目, 選擇Info頁簽 ,在Configurations節(jié)點下單擊 + 按鈕 ,選擇Duplicate "Release Configaration , 輸入Staging。
enter description here
enter description here
  1. 在build Settings頁簽中單擊 + 按鈕然后選擇添加User-Defined Setting,然后輸入CODEPUSH_KEY(名稱隨意),然后填入deployment key。

ps.可以通過code-push deployment ls Flow800-Android -k查看deployment key

enter description here
enter description here
enter description here
enter description here

3.打開 Info.plist文件,在CodePushDeploymentKey中輸入$(CODEPUSH_KEY),并修改Bundle versions為三位,如下圖

enter description here
enter description here

至此,iOS端集成也完成了。

使用react-native-code-psuh進行熱更新

該配置的都已經(jīng)配置完了,接下來就是使用了。
在使用之前需要考慮的是檢查更新時機,更新是否強制,更新是否要求即時等等。

更新時機

一般常見的應用內(nèi)更新時機分為兩種,一種是打開APP就檢查更新,一種是放在設置界面讓用戶主動檢查更新并安裝。

  • 打開APP就檢查更新
    最為簡單的使用方式在React Natvie的根組件的componentDidMount方法中通過
    codePush.sync()(需要先導入codePush包:import codePush from 'react-native-code-push')方法檢查并安裝更新,如果有更新包可供下載則會在重啟后生效。不過這種下載和安裝都是靜默的,即用戶不可見。如果需要用戶可見則需要額外的配置。具體可以參考codePush官方API文檔,下面是個人的一些實踐過的配置:
codePush.sync({
      updateDialog: {
        appendReleaseDescription: true,
        descriptionPrefix:'\n\n更新內(nèi)容:\n',
        title:'更新',
        mandatoryUpdateMessage:'',
        mandatoryContinueButtonLabel:'更新',
      },
      mandatoryInstallMode:codePush.InstallMode.IMMEDIATE,
      deploymentKey: CODE_PUSH_PRODUCTION_KEY,
    });

上面的配置在檢查更新時會彈出提示對話框, mandatoryxxx表示強制更新,appendReleaseDescription表示在發(fā)布更新時的描述會顯示到更新對話框上讓用戶可見

來個更加接近實際應用的:在用戶點擊檢查更新按鈕后進行檢查,如果有更新則彈出提示框讓用戶選擇是否更新,如果用戶點擊立即更新按鈕,則會進行安裝包的下載(實際上這時候應該顯示下載進度,這里省略了)下載完成后會立即重啟并生效(也可配置稍后重啟)
ps.這里面還有個神坑,下文再說。

codePush.checkForUpdate(deploymentKey).then((update) => {
                            if (!update) {
                                Alert.alert("提示", "已是最新版本--", [
                                    {
                                        text: "Ok", onPress: () => {
                                        console.log("點了OK");
                                    }
                                    }
                                ]);
                            } else {
                                codePush.sync({
                                        deploymentKey: deploymentKey,
                                        updateDialog: {
                                            optionalIgnoreButtonLabel: '稍后',
                                            optionalInstallButtonLabel: '立即更新',
                                            optionalUpdateMessage: '有新版本了,是否更新?',
                                            title: '更新提示'
                                        },
                                        installMode: codePush.InstallMode.IMMEDIATE,

                                    },
                                    (status) => {
                                        switch (status) {
                                            case codePush.SyncStatus.DOWNLOADING_PACKAGE:
                                                console.log("DOWNLOADING_PACKAGE");
                                                break;
                                            case codePush.SyncStatus.INSTALLING_UPDATE:
                                                console.log(" INSTALLING_UPDATE");
                                                break;
                                        }
                                    },
                                    (progress) => {
                                        console.log(progress.receivedBytes + " of " + progress.totalBytes + " received.");
                                    }
                                );
                            }
                    }

更新是否強制

如果是強制更新需要在發(fā)布的時候指定,發(fā)布命令中配置--m true,下文在細說

更新是否要求即時

在更新配置中通過指定installMode來決定安裝完成的重啟時機,亦即更新生效時機

  • codePush.InstallMode.IMMEDIATE:表示安裝完成立即重啟更新
  • codePush.InstallMode.ON_NEXT_RESTART:表示安裝完成后會在下次重啟后進行更新
  • codePush.InstallMode.ON_NEXT_RESUME:表示安裝完成后會在應用進入后臺后重啟更新

發(fā)布CodePush更新包

codepush的更新包發(fā)布其實很簡單。在終端輸入命令

code-push release-react <Appname> <Platform> --t <本更新包面向的舊版本號> --des <本次更新說明>

CodePush默認是更新 Staging 環(huán)境的,如果發(fā)布生產(chǎn)環(huán)境的更新包,需要指定--d參數(shù):--d Production ,如果發(fā)布的是強制更新包,需要加上 --m true強制更新

示例:

code-push release-react Flow800-Android android --t 2.0.0 --dev false --d Production --des "1.全新頁面\n2.上線流量商城\n3.已知bug修復" --m ture

常用部署命令如下:

Usage: code-push deployment <command>
命令:
  add      在已存在的App中創(chuàng)建一個部署
  clear    清除與部署相關的發(fā)布歷史記錄
  remove   在App中刪除一個部署
  rm       在App中刪除一個部署
  rename   重命名一個已存在的部署
  list     列出App中的所有部署
  ls       列出App中的所有部署
  history  列出一個部署的發(fā)布歷史記錄
  h        列出一個部署的發(fā)布歷史記錄

至此,一個完整的發(fā)布,檢查,安裝流程已經(jīng)基本描述完了。下面來看下更新的效果:

enter description here
enter description here

實踐經(jīng)驗小結

  1. 在Android端進行調(diào)試時,在更新之前需要修改Debug Server地址和端口為任意字符串,讓其訪問不到真正Debug Server,否則更新重啟后,就直接訪問了Debug Server導致新的安裝包沒有安裝上。


    enter description here
    enter description here

    也可以直接打Android離線包,這樣子就不需要理會Debug Server的影響

  2. 在iOS端調(diào)試時,需要打離線包并拖拽到Xcode工程中。
    打包命令:

react-native bundle --entry-file index.ios.js --bundle-output ./bundle/ios/main.jsbundle --platform ios --assets-dest ./bundle/ios --dev false
enter description here
enter description here

拖拽完成后目錄結構如上。
此外,還需要對AppDelegate.m文件進行修改:

enter description here
enter description here

否則更新重啟后還是舊版的App。

3.發(fā)布更新包時,切記--t參數(shù)指定的是本次更新包的目標版本號,而不是本次更新包的版本號

4.如果不是在根組件的componentDidMount()方法通過codePush.sync()方法進行更新檢查與安裝,比如像我在設置中通過一個檢查更新按鈕,這時候就需要十分小心了。必須在根組件的componentDidMount()方法中添加 codePush.notifyAppReady(),否則應用會出現(xiàn)第一次重啟是更新版,第二次重啟又回滾到舊版的現(xiàn)象。

5.一個App通常不會是一個人開發(fā),因此codePush添加合作者是很常見的。通過 code-push collaborator來操作合作者相關命令。

Usage: code-push collaborator <command>
命令:
  add     對指定的項目添加一個新的合作者
  remove  刪除指定的項目中的合作者
  rm      刪除指定的項目中的合作者
  list    列出指定項目中的所有合作者
  ls      列出指定項目中的所有合作者
示例:
    code-push collaborator add AppDemo foo@bar.com 添加一個合作者foo@bar.com到AppDemo這個App中

6.最后說一下CodePush的缺陷,因為是國外服務器,所以有時候下載速度并不是很理想。此外CodePush現(xiàn)在是免費服務,以后會不會收費還是個未知數(shù)。因此已經(jīng)有人提出了自建codePush服務器,可見于此:code-push-server

更多常見問題及API使用方法請參見以下資料

參考資料

微軟官方ReactNative CodePush文檔
React Native熱更新部署/熱更新-CodePush最新集成總結(新)
react-native-code-push Github
基本上所有問題都可以在官方文檔或者github的issue中找到答案。

最后編輯于
?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

相關閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容