Skip to content

Latest commit

 

History

History
109 lines (71 loc) · 3.49 KB

README_CN.md

File metadata and controls

109 lines (71 loc) · 3.49 KB
Raw

Herina

Build bundle with Herina.

介绍

Herina 是为 React Native App 提供动态化能力的开发套件。通过提供简单易用的 JS API，为你能够轻而易举地为 App 加入热更新功能。并且，你还可以使用 import() 从远程服务器动态导入模块，使用此项功能无需额外配置。

在底层，Herina 使用 Metro 作为 Bundle 构建工具。它们之间的关系就像 Vite 之于 Rollup 或 ESBuild。当构建完成之后，Herina 生成 Bundle 的 AST 分析代码，并将里面的模块拆分到不同类型的 Chunk 内。

功能

  • Bundle 构建
  • 将 Bundl 拆分为 Chunk
  • 使用 import() 动态导入模块
  • 构建和应用递增式更新
  • 简单易用的 JS API
  • 自动回滚 Bundle 当发生错误
  • 支持 iOS 与 Android
  • 支持 TypeScript

安装

yarn add @herina-rn/core @herina-rn/client
cd ios && pod install

代码拆分

Herina 将 Bundle 拆分为三种不同的 Chunk：

  • 业务包: 包含 App 的业务代码；
  • 动态包: 包含使用 import(...) 导入的模块；
  • 基础包: 包含 node_modules 内的依赖于 Herina 运行时

使用

Herina 提供两种更新方式：全量更新、递增式更新。

在更新之前，请先调用 registerUpdateManager 注册 UpdateManager。第一个参数是可选的，它代表的是所访问资源（通常为生成的 Bundle、Chunk）的 Base URL，若此参数未被定义，将读取原始 Bundle 内的 Base URL。

import { registerUpdateManager } from "@herina-rn/client";

const manager = registerUpdateManager("https://hector.im");

全量更新

若使用全量更新，将从服务器下载新的 Bundle 以替换原始的 Bundle。

import { getUpdateManager } from "@herina-rn/client";

const onUpdateBundle = async () => {
  // 已调用 `registerUpdateManager`
  const manager = getUpdateManager();

  await manager.requestBundleUpdate();

  // 若此参数为 true，将在 Bundle 替换后重载 App
  manager.applyBundleUpdate(true);
};

递增式更新

若使用递增式更新，运行时将发送一个请求知晓是否有可用的更新，并将更新下载下来，然后生成一个新的 Bundle 替换来原始的。

import { getUpdateManager } from "@herina-rn/client";

const onUpdateByIncremental = async () => {
  const manager = getUpdateManager();

  await manager.requestIncrementalUpdates();

  manager.applyIncrementalUpdate(true);
};

使用要求

为使用 Herina，需要对原生代码进行修改。若你没有 iOS 或 Android 的原生开发经验，你可参考文档中的配置章节。

使用限制

目前，Herina 仅限用于生产模式，并且不会输出 Sourcemap。若你正在使用如 Sentry 这样的性能监控，我正在开发为它提供支持。

联系 & 支持

Herina 按现状提供。供您参考，Herina 目前是我工作的一部分，但这不意味这是永久性的。如果我被安排到其它工作，我将仍尽量抽出时间提供技术支持。

不必犹豫提交 Issue 或 Pull Request。如果你有想法要和我分享，你可以联系我，我会尽快回复。

License

MIT