diff --git a/README.md b/README.md index c1d9f46..29f1c24 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ ### 快速开始 -请查看[文档](https://pushy.reactnative.cn/docs/getting-started) +请查看[文档](https://pushy.reactnative.cn/docs/getting-started.html) ### 优势 diff --git a/docs/.nojekyll b/docs/.nojekyll deleted file mode 100644 index e69de29..0000000 diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 4cf03c8..0000000 --- a/docs/README.md +++ /dev/null @@ -1,53 +0,0 @@ -# react-native-update [![npm version](https://badge.fury.io/js/react-native-update.svg)](http://badge.fury.io/js/react-native-update) - -本组件是面向 React Native 提供热更新功能的组件，请结合[Update 服务](https://update.reactnative.cn/)使用。 - -
- -注意，在 iOS 上使用热更新有被拒的可能。被拒之后可以按此步骤单独屏蔽 iOS 端(`react-native-update`版本需 >= 5.3.2)： - - -1. 如果 RN 版本>=0.60，在项目根目录下编辑或创建 react-native.config.js，添加如下内容 - -```js -// react-native.config.js -module.exports = { - dependencies: { - 'react-native-update': { - platforms: { - ios: null, // 阻止ios模块自动链接 - }, - }, - }, -}; -``` - -2. 如果在原生代码端尚未配置，则跳过下面文档中的 ios 端的配置。如果已经配置，则按文档的步骤反向操作（添加的 ios 代码删去）。 -3. 如果是 0.60 以上版本或使用了 cocoapods，在 ios 目录中再次运行 pod install，确保 Podfile 和 Podfile.lock 中都没有'react-native-update'。如果 RN 版本<0.60，则运行`react-native unlink react-native-update`。 -4. 在 js 代码里调用 checkUpdate()方法前，判断 Platform.OS，如果是 ios 平台则直接 return 跳过。 -
- -### 优势 - -1. 命令行工具&网页双端管理，版本发布过程简单便捷，完全可以集成 CI。 -2. 基于 bsdiff 算法创建的**超小更新包**，通常版本迭代后在 1-10KB 之间，避免数百 KB 的流量消耗。 -3. 支持崩溃回滚，安全可靠。 -4. meta 信息及开放 API，提供更高扩展性。 -5. 跨越多个版本进行更新时，只需要下载**一个更新包**，不需要逐版本依次更新。 - -### 本地开发 - -``` -$ git clone git@github.com:reactnativecn/react-native-pushy.git -$ cd react-native-pushy/Example/testHotUpdate -$ yarn -$ yarn start -``` - -本地库文件使用 yarn link 链接，因此可直接在源文件中修改，在 testHotUpdate 项目中调试。 - -### 关于我们 - -本组件由[React Native 中文网](https://reactnative.cn/)独家发布，如有定制需求可以[联系我们](https://reactnative.cn/about.html#content)。 - -关于此插件发现任何问题，可以前往[Issues](https://github.com/reactnativecn/react-native-pushy/issues)或者[中文社区](http://bbs.reactnative.cn/category/7)发帖提问。 diff --git a/docs/_sidebar.md b/docs/_sidebar.md deleted file mode 100644 index b27d4f0..0000000 --- a/docs/_sidebar.md +++ /dev/null @@ -1,10 +0,0 @@ -- 安装与快速入门 - - - [准备工作](guide.md) - - [添加热更新功能](guide2.md) - - [发布版本](guide3.md) - - [常见问题与高级指南](faq_advance.md) - -- [API接口](api.md) -- [命令行工具](cli.md) -- [最近更新](changelog.md) \ No newline at end of file diff --git a/docs/api.md b/docs/api.md deleted file mode 100644 index 7fa3031..0000000 --- a/docs/api.md +++ /dev/null @@ -1,65 +0,0 @@ -# API - -### downloadRootDir - -下载的根目录。你可以使用react-native-fs等第三方组件检查其中的内容。 - -### packageVersion - -当前应用原生包的版本。其中android取自`versionName`字段(位于`android/build.gralde`中)。ios取自`CFBundleShortVersionString`字段(位于`ios/项目名/Info.plist`中)。 - -### currentVersion - -当前热更新版本（jsbundle文件）的Hash号。 - -### isFirstTime - -是否更新后的首次启动。当此项为真时，你需要在合适的时候调用`markSuccess()`以确保更新成功。否则应用下一次启动时将会回滚。 - -### isRolledBack - -是否刚刚经历了一次回滚。 - -### async function checkUpdate(appKey) - -检查更新，返回值有三种情形： - -1. `{expired: true}`：该应用原生包已过期，需要前往应用市场下载新的版本。 -``` - { - expired: true, - downloadUrl: 'http://appstore/downloadUrl', - } -``` -2. `{upToDate: true}`：当前已经更新到最新，无需进行更新。 - -3. `{update: true}`：当前有新版本可以更新。info的`name`、`description`字段可 -以用于提示用户，而`metaInfo`字段则可以根据你的需求自定义其它属性(如是否静默更新、 -是否强制更新等等)。另外还有几个字段，包含了热更新文件的下载地址， -``` - { - update: true, - name: '1.0.3-rc', - hash: 'hash', - description: '添加聊天功能\n修复商城页面BUG', - metaInfo: '{"silent":true}', - pdiffUrl: 'http://update-packages.reactnative.cn/hash', - diffUrl: 'http://update-packages.reactnative.cn/hash', - } -``` - -### async function downloadUpdate(info) - -下载更新版本。info为checkUpdate函数的返回值，并且仅当`update:true`时实际进行下载。 - -### function switchVersion(hash) - -立即重启应用，并加载已经下载完毕的版本。 - -### function switchVersionLater(hash) - -在下一次启动应用的时候加载已经下载完毕的版本。 - -### function markSuccess() - -在isFirstTime为true时需在应用成功启动后调用此函数， diff --git a/docs/changelog.md b/docs/changelog.md deleted file mode 100644 index ddbf01c..0000000 --- a/docs/changelog.md +++ /dev/null @@ -1,91 +0,0 @@ -### 最近更新 - -## 5.5.8 (2020-04-02) - -1. 提供setCustomInstanceManager方法，方便自己集成RN的用户调用 - -## 5.5.6 (2020-02-11) - -1. bundle时清除缓存 -2. 修复更新包过大时可能出现的崩溃 -3. publish时检查文件格式 - -## 5.5.5 (2020-01-18) - -1. 提升服务健壮性 - -## 5.5.4 (2020-01-13) - -1. 防止某些情况下安卓找不到bundle文件引起的崩溃 - -## 5.5.3 (2019-12-18) - -1. 忽略hermes的输出避免buffer溢出 - -## 5.5.2 (2019-12-06) - -1. 修复使用use_frameworks时无法读取时间戳的问题 - -## 5.5.0 (2019-11-24) - -1. 打包时加入时间戳 - -## 5.4.0 (2019-11-16) - -1. 修改类名方法名 - -## 5.3.2 (2019-10-25) - -1. 可以禁用ios端以避免审核被拒 - -## 5.3.0 (2019-09-19) - -1. 替换 apk reader 以避免某些环境读取 apk 版本号报错的问题 - -## 5.2.9 (2019-09-18) - -1. 添加 proguard 混淆规则以解决开启混淆后闪退的问题 - -## 5.2.8 - -1. 解决某些情形下 Android 调用 switchVersion 不能重启的问题 - -## 5.2.7 - -1. 改进 windows 端打更新包的兼容性（部分 windows 机器上会产生空 ppk 文件） - -## 5.2.4 - -1. 支持 RN 0.61 的 hermes（路径变化） -2. iOS 端使用第三方的 SSZipArchive 以减少重名冲突 - -## 5.2.2 - -1. 修复一处导致 iOS 回滚的问题 - -## 5.2.1 - -1. 检测如果开启了 hermes，则自动编译为 hermes 字节码格式 - -## 5.2.0 - -1. 添加 typescript 声明 -2. 支持 cocoapods - -## 5.1.9 - -1. 重写 bundle 命令以提升版本兼容性 -2. 改进命令行的输出样式 - -## 5.1.8 - -1. 服务器迁移到 https -2. android 支持 64 位 - -## 5.1.6 - -解决 Android 热更新后部分图片丢失问题： - -同一个项目中放置了多个完全相同的文件，在 5.1.0 至 5.1.5 之间的版本中，更新后有时会出现其中的部分无法显示。此问题在 5.1.6 版本修复。 - -修复此问题涉及原生部分，需要重新打包。 diff --git a/docs/cli.md b/docs/cli.md deleted file mode 100644 index 489f883..0000000 --- a/docs/cli.md +++ /dev/null @@ -1,118 +0,0 @@ -# 命令行工具 - -## 安装 - -``` -$ npm install -g react-native-update-cli -$ npm install react-native-update -``` - -## 使用 - -#### pushy bundle - -生成资源包 - -* platform: ios|android 对应的平台 -* entryFile: 入口脚本文件 -* intermediaDir: 临时文件输出目录 -* output: 最终ppk文件输出路径 -* dev: 是否打包开发版本 -* verbose: 是否展现打包过程的详细信息 - -#### pushy diff - -提供两个ppk文件，生成从origin到next版本的差异更新包。 - -* output: diff文件输出路径 - -#### pushy diffFromApk - -提供一个apk文件和一个ppk文件，生成从apk文件到next版本的差异更新包。 - -如果使用热更新开放平台，你不需要自己执行此命令。 - -* output: diff文件输出路径 - -#### pushy diffFromIpa - -提供一个ipa文件和一个ppk文件，生成从ipa文件到next版本的差异更新包。 - -如果使用热更新开放平台，你不需要自己执行此命令。 - -* output: diff文件输出路径 - -#### pushy login [] [] - -登录热更新开放平台。你需要先登录才能使用下面的命令。 - -#### pushy logout - -登出并清除本地的登录信息 - -#### pushy me - -查看自己是否已经登录，以及昵称等信息。 - -#### pushy createApp - -创建应用并立刻绑定到当前工程。这项操作也可以在网页管理端进行。 - -- platform: ios|android 对应的平台 -- name: 应用名称 -- downloadUrl: 应用安装包的下载地址 - -#### pushy deleteApp [appId] - -删除已有应用。所有已创建的应用包、热更新版本都会被同时删除。这项操作也可以在网页管理端进行。 - -- platform: ios|android 对应的平台 - -#### pushy apps - -查看当前已创建的全部应用。这项操作也可以在网页管理端进行。 - -- platform: ios|android 对应的平台 - -#### pushy selectApp [appId] - -绑定应用到当前工程。 - -- platform: ios|android 对应的平台 - -#### pushy uploadIpa - -上传 ipa 文件到开放平台。 - -#### pushy uploadApk - -上传 apk 文件到开放平台。 - -#### pushy packages - -查看已经上传的原生包。这项操作也可以在网页管理端进行。 - -- platform: ios|android 对应的平台 - -#### pushy publish - -发布新的热更新版本（ppk文件）。 - -- platform: ios|android 对应的平台 -- name: 当前热更新版本的名字(版本号) -- description: 当前热更新版本的描述信息，可以对用户进行展示 -- metaInfo: 当前热更新版本的元信息，可以用来保存一些额外信息 - -#### pushy versions - -分页列举可用的版本。这项操作也可以在网页管理端进行。 - -- platform: ios|android 对应的平台 - -#### pushy update - -为一个原生包版本绑定一个热更新版本。这项操作也可以在网页管理端进行。 - -- platform: ios|android 对应的平台 -- versionId: 要绑定的热更新版本 ID -- packageId: 要绑定的原生包 ID diff --git a/docs/faq_advance.md b/docs/faq_advance.md deleted file mode 100644 index 9516a8f..0000000 --- a/docs/faq_advance.md +++ /dev/null @@ -1,71 +0,0 @@ -## 常见问题 - -#### 报错 NDK not configured. - -你需要下载并安装NDK，然后设置到环境变量`ANDROID_NDK_HOME`中。 - -#### 报错 Execution failed for task ':react-native-update:compileReleaseNdk' -参看 https://github.com/reactnativecn/react-native-pushy/issues/64#issuecomment-287967742 -  -#### iOS报错 Unable to execute JS call: __fbBatchedBridge is undefined - -如果直接修改了jsCodeLocation，将不能在iOS模拟器上运行。可以使用真机测试。要在发布之前测试热更新功能，可以用adhoc方式发布测试包并进行测试。adhoc发布的包可以用于uploadIpa和生成差异包。 - -#### XCode报错 "_BZ2_bzRead", referenced from 等 - -在工程target的Build Phases->Link Binary with Libraries中加入libz.tbd、libbz2.1.0.tbd - -## 高级指南 - -#### 过期的版本 - -你可以删除掉过期很久的版本。在一段时间后，版本会被真正清理。 - -如果有用户还处在已经被清理的版本上，当他发起更新的时候，将不能通过版本差异比对进行更新，即只能进行全量更新。 - -#### CI的集成 - -在开发环境中，每次bundle都会生成一个不同名字的ppk文件，这不利于持续集成(CI)系统的引入。 - -要解决这个问题,你可以使用`--output`参数来指定输出ppk文件的名字和路径，便于进行自动发布。 - -#### 版本测试与发布 - -我们强烈建议您先发布一个测试包，再发布一个除了版本号以外均完全相同的发布包。 -在每次往发布包发起热更新之前，先往对应的测试包进行更新操作，基本测试通过之后，可以将发布包更新到完全相同的热更新版本之上。 -如果在测试包中发现了重大问题，你就可以先进行修复，再次更新测试通过后，再将发布包更新至修复后的版本。 -这样，可以最大程度的避免用户通过热更新获得一个有问题的版本。 - -#### 元信息(Meta Info)的使用 - -在发布热更新版本时，或者在网页端，你可以编辑版本的元信息。 -这是一段在检查更新时可以获得的字符串，你可以在其中按你所想的格式保存一些信息。 - -举例来说，可能某个版本包含一些重要的更新内容，所以用户会得到一个不同样式的通知。如何使用元信息，完全取决于您的想象力！ - -下面会列举一些实战中更有意义的元信息的使用。 - -#### Hot-fix - -有时候我们不小心发布了一个有严重问题的版本，所以需要进行一个紧急的修复， -此时我们可能希望之前已经更新到有问题版本的用户进行紧急甚至静默进行更新。 - -这时候,我们可以在元信息中包含有问题的版本的列表，而在客户端检查更新时，将从元信息里取到的列表与当前版本(currentVersion)比对， -如果匹配成功，我们就进行静默更新，否则则按照一般的更新流程提示用户。 - -#### 这个热更新服务收费吗？ - -目前我们的热更新服务完全免费，但限制每个账号不超过3个应用；每个应用不超过10个活跃的包和100个活跃的热更新版本；每个应用每个月不超过10000次下载。iOS和Android版本记做不同的应用。 - -已经移除的应用、原生包版本、热更新版本不在统计之列，所以你可以移除测试时产生的和已过期版本来更有效的利用空间。 - -我们会在将来推出付费的升级版本，针对用户量较大、版本迭代较快的用户提供扩容方案。如果您有急迫的需求，可以[联系我们](https://reactnative.cn/about.html#content)。 - -#### 我是否可以搭建自己的热更新服务？ - -你可以单独使用本组件的原生部分(不包括js模块)和命令行工具中的`bundle`、`diff`、`diffFromIpa`、`diffFromApk`四个功能。 - -这些功能都不会使用我们的热更新服务，也无需注册或登录账号。但你可能要编写自己的js模块来与不同的热更新服务器通讯。 - -如果您有兴趣使用我们的成果，搭建私有云服务，可以[联系我们](https://reactnative.cn/about.html#content)。 - diff --git a/docs/guide.md b/docs/guide.md deleted file mode 100644 index 77edf52..0000000 --- a/docs/guide.md +++ /dev/null @@ -1,228 +0,0 @@ -# 快速入门-准备工作 - -首先你应该有一个基于React Native开发的应用，我们把具有package.json的目录叫做你的"应用根目录"。 - -如果你还没有初始化应用，请参阅[开始使用React Native](https://reactnative.cn/docs/getting-started.html#content)。 - -所以我们也假设你已经拥有了开发React Native应用的一切环境，包括`Node.js`、`npm`、`XCode`、`Android SDK`等等。 - -## 安装 - -在你的项目根目录下运行以下命令： - -```bash -npm i -g react-native-update-cli -npm i react-native-update -``` - -> 如果下载极慢或者显示网络失败，请设置使用淘宝镜像`npx nrm use taobao` - -如果你的RN版本 >= 0.60，请在iOS目录下执行: - -```bash -pod install -``` - -如果你的RN版本 < 0.60，那么还需要[手动link](#一手动link) - - -
- -如果你的RN版本比较老（< 0.46），请点击这里的注意事项 - - -如果你的RN版本比较老，请按下面表格尝试老一些的版本（但这些版本我们已不再维护，不能保证可以使用）： - -| 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 | - -安装命令示例： -``` -npm i react-native-update@4.x -``` - -如果RN的版本是0.45及以下，你还必须安装[Android NDK](http://androiddevtools.cn)，版本最好选用r10e，并设置环境变量`ANDROID_NDK_HOME`，指向你的NDK根目录(例如`/Users/tdzl2003/Downloads/android-ndk-r10e`)。 -
- - -请记得一定要重新编译（react-native run-ios或run-android命令编译，或在Xcode/Android Studio中重新编译）。 - - -## 手动link - -如果RN版本 >= 0.60则可以跳过此步骤 - -### iOS - -
-RN < 0.60且使用CocoaPods（推荐） - -1. 在ios/Podfile中添加 -``` -pod 'react-native-update', path: '../node_modules/react-native-update' -``` -2. 在项目的ios目录下运行`pod install` -3. 重新编译 - -
- -
-RN < 0.60且不使用CocoaPods - -1. 在XCode中的Project Navigator里,右键点击`Libraries` ➜ `Add Files to [你的工程名]` -2. 进入`node_modules` ➜ `react-native-update` ➜ `ios 并选中 `RCTPushy.xcodeproj` -3. 在XCode中的project navigator里,选中你的工程,在 `Build Phases` ➜ `Link Binary With Libraries` 中添加 `libRCTPushy.a` -4. 继续在`Build Settings`里搜索`Header Search Path`，添加$(SRCROOT)/../node_modules/react-native-update/ios -5. 在`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`文件添加进去。 - -6. 重新编译 - -
- -### Android - - -
-RN < 0.60 -1. 在`android/settings.gradle`中添加如下代码: - ``` - 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 部分增加如下代码: - ``` - implementation project(':react-native-update') - ``` - -3. 打开`android/app/src/main/java/[...]/MainApplication.java`, - - 在文件开头增加 `import cn.reactnative.modules.update.UpdatePackage;` - - 在`getPackages()` 方法中增加 `new UpdatePackage()`(注意上一行可能要增加一个逗号) -
- -## 配置Bundle URL - -注意此步骤无论任何版本，目前都需要手动配置。 - -### iOS - -1. (RN >= 0.60或者使用CocoaPods集成此步可跳过)在工程target的Build Phases->Link Binary with Libraries中加入`libz.tbd`、`libbz2.1.0.tbd` - -2. 在你的AppDelegate.m文件中增加如下代码： - -```objective-c -// ... 其它代码 - -#import "RCTPushy.h" - -// 如果RN版本 >= 0.59，修改sourceURLForBridge -- (NSURL *)sourceURLForBridge:(RCTBridge *)bridge -{ -#if DEBUG - return [[RCTBundleURLProvider sharedSettings] jsBundleURLForBundleRoot:@"index" fallbackResource:nil]; -#else -  // 非DEBUG情况下替换为热更新bundle - return [RCTPushy bundleURL]; -#endif -} - -// 如果RN版本 < 0.59，修改didFinishLaunchingWithOptions -- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions -{ -#if DEBUG -  // 原来的jsCodeLocation保留在这里 -  jsCodeLocation = .......... -#else -  // 非DEBUG情况下替换为热更新bundle -  jsCodeLocation = [RCTPushy bundleURL]; -#endif - // ... 其它代码 -} - -``` - -### Android - -在MainApplication中增加如下代码： - -```java -// ... 其它代码 - -// 请注意不要少了这句import -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); - } - // ... 其它代码 - } -} -``` - -## 登录与创建应用 - -首先请在注册帐号，然后在你的项目根目录下运行以下命令： - -```bash -$ pushy login -email: <输入你的注册邮箱> -password: <输入你的密码> -``` - -这会在项目文件夹下创建一个`.update`文件，注意不要把这个文件上传到Git等CVS系统上。你可以在`.gitignore`末尾增加一行`.update`来忽略这个文件。 - -登录之后可以创建应用。注意iOS平台和安卓平台需要分别创建： - -```bash -$ pushy createApp --platform ios -App Name: <输入应用名字> -$ pushy createApp --platform android -App Name: <输入应用名字> -``` - -> 两次输入的名字可以相同，这没有关系。 - -如果你已经在网页端或者其它地方创建过应用，也可以直接选择应用： - -```bash -$ pushy selectApp --platform ios -1) 鱼多多(ios) -2) 招财旺(ios) - -Total 2 ios apps -Enter appId: <输入应用前面的编号> -``` - -选择或者创建过应用后，你将可以在文件夹下看到`update.json`文件，其内容类似如下形式： - -```bash -{ - "ios": { - "appId": 1, - "appKey": "<一串随机字符串>" - }, - "android": { - "appId": 2, - "appKey": "<一串随机字符串>" - } -} -``` - -你可以安全的把`update.json`上传到Git等CVS系统上，与你的团队共享这个文件，它不包含任何敏感信息。当然，他们在使用任何功能之前，都必须首先输入`pushy login`进行登录。 - -至此应用的创建/选择就已经成功了。下一步，你需要给代码添加相应的功能，请参阅[添加热更新功能](guide2.md) diff --git a/docs/guide2.md b/docs/guide2.md deleted file mode 100644 index 33c05ba..0000000 --- a/docs/guide2.md +++ /dev/null @@ -1,177 +0,0 @@ -# 快速入门-添加热更新功能 - -## 获取appKey - -检查更新时必须提供你的`appKey`，这个值保存在`update.json`中，并且根据平台不同而不同。你可以用如下的代码获取： - -```javascript -import { - Platform, -} from 'react-native'; - -import _updateConfig from './update.json'; -const {appKey} = _updateConfig[Platform.OS]; -``` - -如果你不使用pushy命令行，你也可以从网页端查看到两个应用appKey，并根据平台的不同来选择。 - -## 检查更新、下载更新 - -异步函数checkUpdate可以检查当前版本是否需要更新： - -```javascript -const info = await checkUpdate(appKey) -``` - -返回的info有三种情况： - -1. `{expired: true}`：该应用原生包已过期（已从pushy服务器中删除），开发者应该在pushy控制台添加一个更新下载链接，并自行提示用户下载。 - -2. `{upToDate: true}`：当前已经更新到最新，无需进行更新。 - -3. `{update: true}`：当前有新版本可以更新。info的`name`、`description`字段可 -以用于提示用户，而`metaInfo`字段则可以根据你的需求自定义其它属性(如是否静默更新、 -是否强制更新等等)。另外还有几个字段，包含了完整更新包或补丁包的下载地址， -react-native-update会首先尝试耗费流量更少的更新方式。将info对象传递给downloadUpdate作为参数即可。 - -## 切换版本 - -downloadUpdate的返回值是一个hash字符串，它是当前热更新版本的唯一标识。 - -你可以使用`switchVersion`函数立即切换版本(此时应用会立即重新加载)，或者选择调用 -`switchVersionLater`，让应用在下一次启动的时候再加载新的版本。 - -## 首次启动、回滚 - -在每次更新完毕后的首次启动时，`isFirstTime`常量会为`true`。 -你必须在应用退出前合适的任何时机，调用`markSuccess`，否则应用下一次启动的时候将会进行回滚操作。 -这一机制称作“反触发”，这样当你应用启动初期即遭遇问题的时候，也能在下一次启动时恢复运作。 - -你可以通过`isFirstTime`来获知这是当前版本的首次启动，也可以通过`isRolledBack`来获知应用刚刚经历了一次回滚操作。 -你可以在此时给予用户合理的提示。 - -## 完整的示例 - -```javascript -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 { - componentDidMount(){ - if (isFirstTime) { - Alert.alert('提示', '这是当前版本第一次启动,是否要模拟启动失败?失败将回滚到上一版本', [ - {text: '是', onPress: ()=>{throw new Error('模拟启动失败,请重启应用')}}, - {text: '否', onPress: ()=>{markSuccess()}}, - ]); - } else if (isRolledBack) { - Alert.alert('提示', '刚刚更新失败了,版本被回滚.'); - } - } - doUpdate = async (info) => { - try { - const hash = await downloadUpdate(info); - Alert.alert('提示', '下载完毕,是否重启应用?', [ - {text: '是', onPress: ()=>{switchVersion(hash);}}, - {text: '否',}, - {text: '下次启动时', onPress: ()=>{switchVersionLater(hash);}}, - ]); - } catch(err) { - Alert.alert('提示', '更新失败.'); - } - }; - checkUpdate = async () => { - if (__DEV__) { - // 开发模式不支持热更新，跳过检查 - return; - } - let info; - try { - info = await checkUpdate(appKey); - } catch (err) { - console.warn(err); - return; - } - 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: '否',}, - ]); - } - }; - render() { - return ( - - - 欢迎使用热更新服务 - - - 这是版本一 {'\n'} - 当前原生包版本号: {packageVersion}{'\n'} - 当前热更新版本Hash: {currentVersion||'(空)'}{'\n'} - - - - 点击这里检查更新 - - - - ); - } -} - -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服务检查版本并进行更新了。下一步，你可以开始尝试发布应用包和版本，请参阅[发布应用](guide3.md) diff --git a/docs/guide3.md b/docs/guide3.md deleted file mode 100644 index 2ecde94..0000000 --- a/docs/guide3.md +++ /dev/null @@ -1,80 +0,0 @@ -# 快速入门-发布应用 - -现在你的应用已经具备了检测更新的功能，下面我们来尝试发布并更新它。 - -> **注意**，从update上传发布版本到发布版本正式上线期间，不要修改任何脚本和资源，这会影响update -获取本地代码，从而导致版本不能更新。如果在发布之前修改了脚本或资源，请在网页端删除之前上传的版本并重新上传。 - -## 发布iOS应用 - -首先参考[文档-在设备上运行](https://reactnative.cn/docs/running-on-device-ios.html#content)， -确定你正在使用离线包。然后点击菜单。 - -按照正常的发布流程打包`.ipa`文件(Xcode中运行设备选真机或Generic iOS Device，然后菜单中选择Product-Archive)，然后运行如下命令 - -```bash -$ pushy uploadIpa -``` - -即可上传ipa以供后续版本比对之用。此ipa的`CFBundleShortVersionString`字段(位于`ios/项目名/Info.plist`中)会被记录为原生版本号`packageVersion`。 - -随后你可以选择往AppStore发布这个版本，也可以先通过Test flight等方法进行测试。 - -## 发布安卓应用 - -首先参考[文档-生成已签名的APK](https://reactnative.cn/docs/signed-apk-android.html#content)设置签名， -然后在android文件夹下运行`./gradlew assembleRelease`或`./gradlew aR`，你就可以在`android/app/build/outputs/apk/release/app-release.apk`中找到你的应用包。 - -然后运行如下命令 - -```bash -$ pushy uploadApk android/app/build/outputs/apk/release/app-release.apk -``` - -即可上传apk以供后续版本比对之用。此apk的`versionName`字段(位于`android/build.gralde`中)会被记录为原生版本号`packageVersion`。 - -随后你可以选择往应用市场发布这个版本，也可以先往设备上直接安装这个apk文件以进行测试。 - -## 发布新的热更新版本 - -你可以尝试修改一行代码(譬如将版本一修改为版本二)，然后生成新的热更新版本。 - -```bash -$ pushy bundle --platform -Bundling with React Native version: 0.22.2 -<各种进度输出> -Bundled saved to: build/output/android.1459850548545.ppk -Would you like to publish it?(Y/N) -``` - -如果想要立即发布，此时输入Y。当然，你也可以在将来使用`pushy publish --platform `来发布版本。 - -``` - 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 `来使得对应原生包版本的用户更新。 -除此以外，你还可以在网页端操作，简单的将对应的原生包版本拖到此热更新版本下即可。 - -``` -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: <输入原生包版本序号，序号就是上面列表中)前面的数字> -``` - -版本绑定完毕后，客户端就应当可以检查到更新并进行更新了。 - -恭喜你，至此为止，你已经完成了植入代码热更新的全部工作。接下来，你可以查阅[常见问题与高级指南](faq_advance.md)了解更多深入的知识，尤其是在实际项目中的运用技巧。 diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index 32f3860..0000000 --- a/docs/index.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - - react-native-update - react-native hot update - - - - - - -
- - - -