API参考 – Pushy 极速热更新

JavaScript 常量

downloadRootDir

下载的根目录。你可以使用react-native-fs等第三方组件读取其中的内容。

packageVersion

当前应用原生包的版本。其中 android 取自versionName字段(位于android/app/build.gradle中)。ios 取自CFBundleShortVersionString字段(位于ios/项目名/Info.plist中)。

currentVersion

当前热更新版本（jsbundle 文件）的 Hash 号。

isFirstTime

是否更新后的首次启动。当此项为真时，你需要在合适的时候调用markSuccess()以确保更新成功。否则应用下一次启动时将会回滚。

isRolledBack

是否刚刚经历了一次回滚。

JavaScript 方法

async function checkUpdate(appKey)

检查更新，返回值有三种情形：

{expired: true}：该应用原生包已过期（三种情况：1. 主动设置为过期状态，2. 主动删除，3. 从未上传），需要前往应用市场下载新的版本(在设置中填写 downloadUrl)。

{
    expired: true,
    downloadUrl: 'http://appstore/downloadUrl',
}

{upToDate: true}：当前已经更新到最新，无需进行更新。
{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, callbacks)

下载更新版本。info为checkUpdate函数的返回值，并且仅当update:true时实际进行下载。

从v5.8.3版本开始新增接受第二个可选参数，为下载进度的回调函数（onDownloadProgress）。可根据回调参数自行设计进度的展示。示例：

const hash = await downloadUpdate(
  info,
  // 下载回调为可选参数，自v5.8.3版本起可用
  {
    onDownloadProgress: ({ received, total }) => {
      // 已下载的字节数, 总字节数
      console.log(received, total);
    },
  }
);

async function downloadAndInstallApk({ url, onDownloadProgress })

下载更新的 apk 包并直接安装。url必须为可直接下载到 apk 文件的地址，onDownloadProgress为可选的下载进度回调函数，可根据回调参数自行设计进度的展示。自v5.9.0版本起可用。

注意要使用这个功能还需要在AndroidManifest.xml中手动添加安装权限，如果需要考虑 Android 7.0 以下的客户，则还需要添加外部存储权限。

<uses-permission android:name="android.permission.REQUEST_INSTALL_PACKAGES" />
 
<!-- 如果需要考虑Android 7.0以下的客户，则还需要添加外部存储权限 -->
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

注意某些应用市场可能会因为上述权限拒绝应用上架。去掉上述两个权限并不影响热更新功能。

function markSuccess()

在isFirstTime为true时，必须调用此函数作为更新成功的标记（否则下次启动会默认失败自动回滚）。

async function getCurrentVersionInfo()

获取当前已热更版本的信息（如尚未热更过则返回空对象）。

返回值示例：

{
    name: '1.0.3-rc',
    description: '添加聊天功能\n修复商城页面BUG',
    metaInfo: '{"silent":true}',
}

function switchVersion(hash)

立即重启应用，并加载已经下载完毕的版本。

function switchVersionLater(hash)

在下一次启动应用的时候加载已经下载完毕的版本。

function simpleUpdate(App: ComponentType, { appKey: string; onPushyEvents?: ({ type: EventType; data: EventData }) => void })

极简热更新集成，示例请见集成文档，其中onPushyEvents参数请看下面的方法说明。

function onPushyEvents(({ type: EventType; data: EventData }) => void)

发生某个事件时的回调，可用于上报统计数据。自v8.4.0版本后可用。其中回调参数构型具体如下：

// 回调事件类型
export type EventType =
  | "rollback" // 回滚
  | "errorChecking" // 查询热更时出错
  | "checking" // 正在查询热更
  | "downloading" // 正在下载热更
  | "errorUpdate" // 热更时出错
  | "markSuccess" // 热更后成功标记
  | "downloadingApk" // 正在下载apk
  | "rejectStoragePermission" // 下载apk前申请存储权限被用户拒绝
  | "errorStoragePermission" // 下载apk前申请存储权限出错
  | "errowDownloadAndInstallApk"; // 下载或安装apk时出错
 
// 回调事件数据
export interface EventData {
  currentVersion: string; // 当前版本hash
  cInfo: {
    pushy: string; // 当前pushy版本
    rn: string; // 当前rn版本
    os: string; // 当前操作系统及版本
    uuid: string; // 用户标识符
  };
  packageVersion: string; // 原生包版本
  buildTime: number; // 原生包编译时间戳
  message?: string; // 相关说明信息
  rolledBackVersion?: string; // 热更失败，回滚后的版本hash
  newVersion?: string; // 已下载但热更失败的hash
}

Android 方法

UpdateContext.setCustomInstanceManager(ReactInstanceManager instanceManager)

如果是集成/混编 Android 方案，则可以使用此方法传入你自行创建的 ReactInstanceManager。自v5.5.8版本起可用。

示例：

import cn.reactnative.modules.update.UpdateContext
 
mReactInstanceManager = ReactInstanceManager.builder()
                // ...各种setter，但注意不要调用setBundleAssetName
                .setJSBundleFile(UpdateContext.getBundleUrl(mContext, "assets://index.android.bundle"))
                .build();
UpdateContext.setCustomInstanceManager(mReactInstanceManager);

发布流程命令行工具