安装配置 – Pushy 极速热更新

请注意，当前版本的api经过了完全重构，与之前的版本(v10.0以下)不兼容。如果你需要查看之前版本的文档，请点击这里 (opens in a new tab)

首先你应该有一个基于 React Native 开发的应用，我们把具有 package.json 的目录叫做你的应用根目录。如果你还没有初始化应用，请参阅开始使用 React Native (opens in a new tab)。

我们假设你已经拥有了开发 React Native 应用的一切环境，包括Node.js、Xcode、Android SDK等等。

安装

在你的项目根目录下运行以下命令：

# 先全局安装命令行工具，每台电脑只用装一次
npm i -g react-native-update-cli
 
# 然后在项目目录中安装热更新模块
npm i react-native-update
 
# 然后进入ios目录安装iOS模块
cd ios && pod install

如果下载极慢或者显示网络失败，请设置使用淘宝镜像 npx nrm use taobao

⚠️

注意请不要混用npm/yarn/pnpm等包管理器及对应的lock文件，团队成员请坚持使用同一包管理器，且仅保留统一格式的lock文件

请记得，任意在 ios 和 android 目录下的修改，一定要重新编译（使用 npx react-native run-ios 或 run-android 命令编译，或在 Xcode/Android Studio 中重新编译）才能生效。

手动 link

如果 RN 版本 >= 0.60 则不需要此手动 link 步骤。

⚠️

注意：如果是混编 RN 项目，或monorepo，或任何其他自定义的情况，由于自定义的配置可能不完整或不适应RN的目录结构，导致自动 link 的功能可能不能正常工作。此时即便 RN 版本 >= 0.60，你可能也需要执行手动 link 操作。

iOS

RN < 0.60且使用CocoaPods（推荐）

在 ios/Podfile 中添加

pod 'react-native-update', path: '../node_modules/react-native-update'

在项目的 ios 目录下运行pod install
重新编译

RN < 0.60且不使用CocoaPods

在 XCode 中的 Project Navigator 里,右键点击Libraries ➜ Add Files to [你的工程名]
进入node_modules ➜ react-native-update ➜ ios 并选中RCTPushy.xcodeproj`
在 XCode 中的 project navigator 里,选中你的工程,在 Build Phases ➜ Link Binary With Libraries 中添加 libRCTPushy.a、libz.tbd、libbz2.1.0.tbd
继续在Build Settings里搜索Header Search Path，添加$(SRCROOT)/../node_modules/react-native-update/ios，勾选recursive。
在Build Phases添加一个New Run Script Phase运行脚本，内容如下

#!/bin/bash
set -x
DEST="../node_modules/react-native-update/ios/"
date +%s > "$DEST/pushy_build_time.txt"

尝试编译一下，顺利的话就会在../node_modules/react-native-update/ios/文件夹下面生成一个pushy_build_time.txt文件。然后在Copy Bundle Resources里把生成的pushy_build_time.txt文件添加进去。

Android

RN < 0.60 或其他不能自动 link 的情况

在android/settings.gradle中添加如下代码:

include ':react-native-update'
project(':react-native-update').projectDir = new File(rootProject.projectDir, 	'../node_modules/react-native-update/android')

在android/app/build.gradle的 dependencies 部分增加如下代码:
```
implementation project(':react-native-update')
```
打开android/app/src/main/java/[...]/MainApplication.java,

在文件开头增加 import cn.reactnative.modules.update.UpdatePackage;
在getPackages() 方法中增加 new UpdatePackage()(注意上一行可能要增加一个逗号)

配置 Bundle URL

注意此步骤无论任何版本，目前都需要手动配置。

iOS

在你的 AppDelegate.mm 或 AppDelegate.m 文件（不同 RN 版本可能后缀名不同）中增加如下代码：

// ... 其它代码
#import "AppDelegate.h"
 
#import "RCTPushy.h"  // <-- import头文件，注意要放到if条件外面
 
// 可能项目里有一些条件编译语句，例如有些版本RN自带的flipper
// #if DEBUG
// 注意**不要**在这里面引入"RCTPushy.h"
// #import <FlipperKit/FlipperClient.h>
// ...
// #endif
 
 
// rn 版本 >= 0.74 需要修改 bundleURL 方法
- (NSURL *)bundleURL
{
#if DEBUG
  // 原先DEBUG这里的写法不作修改(所以DEBUG模式下不可热更新)
  return [[RCTBundleURLProvider sharedSettings] jsBundleURLForBundleRoot:@"index"];
#else
  return [RCTPushy bundleURL];  // <--  把这里非DEBUG的情况替换为热更新bundle
#endif
}
 
 
// rn 版本 < 0.74 需要修改sourceURLForBridge方法
- (NSURL *)sourceURLForBridge:(RCTBridge *)bridge
{
#if DEBUG
  // 原先DEBUG这里的写法不作修改(所以DEBUG模式下不可热更新)
  return [[RCTBundleURLProvider sharedSettings] jsBundleURLForBundleRoot:@"index"];
#else
  return [RCTPushy bundleURL];  // <--  把这里非DEBUG的情况替换为热更新bundle
#endif
}

Android

在 MainApplication 中增加如下代码（如果是混编原生的项目或其他原因没有使用 ReactApplication，请使用此 api 集成)：

// ... 其它代码
 
// ↓↓↓请注意不要少了这句import
import cn.reactnative.modules.update.UpdateContext;
// ↑↑↑
 
class MainApplication : Application(), ReactApplication {
 
  override val reactNativeHost: ReactNativeHost =
      object : DefaultReactNativeHost(this) {
 
        // ↓↓↓将下面这一段添加到 DefaultReactNativeHost 内部！
        override fun getJSBundleFile(): String? {
          return UpdateContext.getBundleUrl(this@MainApplication)
        }
        // ↑↑↑
 
        // ...其他代码
      }
}

请记得，任意在 ios 和 android 目录下的修改，一定要重新编译（npx react-native run-ios 或 run-android 命令编译，或在 Xcode/Android Studio 中重新编译）才能生效。

禁用 android 的 crunch 优化

android 会在生成 apk 时自动对 png 图片进行压缩，此操作既耗时又影响增量补丁的生成。为了保证补丁能正常生成，您需要在android/app/build.gradle中关闭此操作：

// 在 android/app/build.gradle 文件中
 
android {
    // ...
    signingConfigs {
      // ...
    }
    buildTypes {
        release {
            // ...
            // 添加下面这行以禁用crunch
            crunchPngs false
        }
    }
}

禁用 aab 包的资源分割（如果你需要在 Google Play 上架）

如果你需要打 aab 包以在 Google Play 上架，则需要禁用 aab 包的资源分割：

// 在 android/app/build.gradle 文件中
 
android {
    bundle {
        density {
            // 请禁用资源分割
            // 否则热更后可能遇到图片无法显示的问题
            enableSplit = false
        }
    }
}

登录与创建应用

首先请在 https://pushy-admin.reactnative.cn (opens in a new tab) 注册帐号，然后在你的项目根目录下运行以下命令：

$ 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)
2) 招财旺(ios)
 
Total 2 ios apps
Enter appId: <输入应用前面的编号>

选择或者创建过应用后，你将可以在文件夹下看到update.json文件，其内容类似如下形式：

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

你可以安全的把update.json上传到 Git 等 CVS 系统上，与你的团队共享这个文件，它不包含任何敏感信息。当然，他们在使用任何功能之前，都必须首先输入pushy login进行登录。

至此应用的创建/选择就已经成功了。下一步，你需要给代码添加相应的功能，请参阅代码集成。

代码集成