0. 安装 react-native-code-push 插件
# cd 到工程根目录
# 在项目中安装 react-native-code-push 插件
$ npm install --save react-native-code-push@latest
1. iOS 端:
CodePush 提供 RNPM、CocoaPods 与 手动 三种在 iOS 项目中集成 CodePush 的方式。以下按照 链接 、配置 两个步骤进行整理:
链接篇:
- RNPM - React Native包管理器(RNPM)是一个非常棒的工具,它为React Native插件提供了最简单的安装体验。(该方式集合了链接、配置两个步骤 - 推荐)
# cd 到工程根目录
#
# 通过命令自动在 iOS 中链接、配置好设置
$ rnpm link react-native-code-push
# 在终端运行此命令之后,终端会提示让你输入 `deployment key`,如果不输入则直接单击`enter`跳过
从 React Native v0.27 版本开始,
rnpm link
已经被合并到 React Native CLI 中。只需运行:react-native link react-native-code-push
即可。如果您的应用程序使用的版本低于 v0.27 的 React Native,请运行以下命令:
rnpm link react-native-code-push
如果您尚未安装 RNPM,可以通过运行
npm i -g rnpm
安装 RNPM ,然后执行上述命令来完成。
deployment key
的值可以通过 CodePush CLI 注册、查询得到。
如需更改项目中的deployment key
可在 "iOS 工程文件"->"info.plist"->"CodePushDeploymentKey" 下图位置更改:
-
CocoaPods (该方式目前只是在 iOS 中进行了插件链接,需继续配置)
将 CodePush 插件依赖项添加到您的Podfile
,指向工程文件中的安装路径
# Podfile文件
pod 'CodePush', :path => '../node_modules/react-native-code-push'
执行 pod
安装
# cd 到 iOS 工程目录 执行
$ pod install
注:需继续进行配置,见配置篇步骤。
- 手动集成(该方式目前只是在 iOS 中进行了插件链接,需继续配置)
1.在 Xcode 中打开应用项目
-
2.将工程文件目录下 "node_modules/react-native-code-push/ios" 中的 "CodePush.xcodeproj" 文件拖动到 Xcode 工程节点 Libraries 里,如下图:
3.在 Xcode 中选择项目节点,并选择项目配置的 "Build Phases" 选项卡。
-
4.从 "Libraries/CodePush.xcodeproj/Products" 拖动 "libCodePush.a" 到项目"Build Phases" 的 "Link Binary With Libraries" 。
-
5.单击 "Link Binary With Libraries" 列表下方的加号,添加 "libz.tbd"。
注:需继续进行配置,见配置篇步骤。
配置篇:
注:如果您使用了 RNPM 的集成方式,那么您可以跳过此部分。
当你的 iOS 项目链接到 CodePush 插件,你需要配置你的应用程序来咨询 CodePush 的 JS包 的位置,因为它负责将其与发布到 CodePush 服务器的更新同步。
步骤:
- 打开
AppDelegate.m
文件,并引入CodePush
头文件:
#import <CodePush/CodePush.h>
- 找到以下代码行:
jsCodeLocation = [[NSBundle mainBundle] URLForResource:@"main" withExtension:@"jsbundle"];
- 将其替换为此行:
jsCodeLocation = [CodePush bundleURL];
此更改将应用配置为始终加载应用的
jsbundle
的最新版本 。在通过 CodePush 推送更新前,他只会使用应用程序编译的文件。但是,在通过 CodePush 推送更新后,它将返回最近安装更新的位置。
注意:
该bundleURL
方法假定应用程序的jsbundle
为默认的main.jsbundle
。如果你更改了应用程序jsbundle
的文件名,则只需调用方法bundleURLForResource:
或bundleURLForResource:withExtension:
以覆盖默认的行为。
建议使用 DEBUG 宏预处理器
,实现在开发模式下调试 和 在生产模式下使用 CodePush 热更新之间动态切换。具体代码如下:
NSURL *jsCodeLocation;
#ifdef DEBUG
jsCodeLocation = [[RCTBundleURLProvider sharedSettings] jsBundleURLForBundleRoot:@"index.ios" fallbackResource:nil];
#else
jsCodeLocation = [CodePush bundleURL];
#endif
在应用程序中添加 CodePushDeploymentKey
为了要让程序在执行
[CodePush bundleURL]
时知道它应该查询哪个部署更新,需要在应用程序 "Info.plist" 文件中,添加一个新的条目CodePushDeploymentKey
,其值是你在 CodePush CLI 中注册此应用程序的Deployment Key
值。
你可以通过运行
code-push deployment ls <appName> -k
在 CodePush CLI 中检索此值。
2. ReactNative 端:
设置更新控制策略:
在使用 CodePush 更新你的应用之前,需要先设置一下更新控制策略,即:
- 什么时候检查更新?(在APP启动的时候?在设置页面添加一个检查更新按钮?设置一个固定的间隔周期性的检查?)
- 什么时候可以更新,如何将更新呈现给客户端用户?
最简单的方式是在根组件中进行策略控制:
import codePush from "react-native-code-push";
class MyApp extends Component {
}
MyApp = codePush(MyApp);
或者
import codePush from 'react-native-code-push'
class MyApp extends Component {
componentDidMount() {
codePush.sync();
}
}
默认情况下,在应用程序启动的时候 CodePush 将检查更新。
- 如果有可用的更新,它将被静默下载,并在下次应用程序重新启动时安装更新,确保用户看到的是最新版本。
- 如果可用更新是强制性的,更新文件下载好之后会立即进行更新。
如果你希望应用程序更快地发现更新,可以在每次应用程序从后台恢复时与 CodePush 服务器同步,检查更新:
let codePushOptions = { checkFrequency: codePush.CheckFrequency.ON_APP_RESUME };
class MyApp extends Component {
}
MyApp = codePush(codePushOptions)(MyApp);
发布更新
可参考 React Native 热更新 -- CodePush CLI 安装及基本使用 中 4.发布更新 的提示进行操作。