跳到主要内容

AppRegistry

AppRegistry 是运行所有 React Native 应用的 JS 入口点。应用根组件应使用 AppRegistry.registerComponent 注册自身，然后原生系统可以加载应用的 bundle，并在应用准备就绪后通过调用 AppRegistry.runApplication 实际运行应用。

React TSX
import {Text, AppRegistry} from 'react-native';

const App = () => (
  <View>
    <Text>App1</Text>
  </View>
);

AppRegistry.registerComponent('Appname', () => App);

当视图应被销毁时，调用 AppRegistry.unmountApplicationComponentAtRootTag 并传入传递给 runApplication 的 tag，以“停止”应用。这两个方法应始终成对使用。

应在 require 序列的早期引入 AppRegistry，以确保在引入其他模块之前设置好 JS 执行环境。

参考

方法​

getAppKeys()​

React TSX
static getAppKeys(): string[];

返回字符串数组。

getRegistry()​

React TSX
static getRegistry(): {sections: string[]; runnables: Runnable[]};

返回一个 Registry 对象。

getRunnable()​

React TSX
static getRunnable(appKey: string): : Runnable | undefined;

返回一个 Runnable 对象。

参数：

名称类型
appKey
必填
string

getSectionKeys()​

React TSX
static getSectionKeys(): string[];

返回字符串数组。

getSections()​

React TSX
static getSections(): Record<string, Runnable>;

返回一个 Runnables 对象。

registerCancellableHeadlessTask()​

React TSX
static registerCancellableHeadlessTask(
  taskKey: string,
  taskProvider: TaskProvider,
  taskCancelProvider: TaskCancelProvider,
);

注册一个可取消的 headless 任务。headless 任务是一段无需 UI 即可运行的代码。

参数：

名称类型描述
taskKey
必填
string调用 startHeadlessTask 时使用的此任务实例的原生 id。
taskProvider
必填
TaskProvider一个返回 promise 的函数，它将原生端传递的某些数据作为唯一参数。当 promise 被解析或拒绝时，原生端会收到此事件的通知，并可能决定销毁 JS 上下文。
taskCancelProvider
必填
TaskCancelProvider一个返回 void 且不接受参数的函数；当请求取消时，taskProvider 执行的函数应完成收尾工作并尽快返回。

registerComponent()​

React TSX
static registerComponent(
  appKey: string,
  getComponentFunc: ComponentProvider,
  section?: boolean,
): string;

参数：

名称类型
appKey
必填
string
componentProvider
必填
ComponentProvider
sectionboolean

registerConfig()​

React TSX
static registerConfig(config: AppConfig[]);

参数：

名称类型
config
必填
AppConfig[]

registerHeadlessTask()​

React TSX
static registerHeadlessTask(
  taskKey: string,
  taskProvider: TaskProvider,
);

注册一个 headless 任务。headless 任务是一段无需 UI 即可运行的代码。

这是一种在应用处于后台时运行 JavaScript 任务的方式。例如，它可用于同步最新数据、处理推送通知或播放音乐。

参数：

名称类型描述
taskKey
必填
string调用 startHeadlessTask 时使用的此任务实例的原生 id。
taskProvider
必填
TaskProvider一个返回 promise 的函数，它将原生端传递的某些数据作为唯一参数。当 promise 被解析或拒绝时，原生端会收到此事件的通知，并可能决定销毁 JS 上下文。

registerRunnable()​

React TSX
static registerRunnable(appKey: string, func: Runnable): string;

参数：

名称类型
appKey
必填
string
run
必填
function

registerSection()​

React TSX
static registerSection(
  appKey: string,
  component: ComponentProvider,
);

参数：

名称类型
appKey
必填
string
component
必填
ComponentProvider

runApplication()​

React TSX
static runApplication(appKey: string, appParameters: any): void;

加载 JavaScript bundle 并运行应用。

参数：

名称类型
appKey
必填
string
appParameters
必填
any

setComponentProviderInstrumentationHook()​

React TSX
static setComponentProviderInstrumentationHook(
  hook: ComponentProviderInstrumentationHook,
);

参数：

名称类型
hook
必填
function

有效的 hook 函数接受以下参数：

名称类型
component
必填
ComponentProvider
scopedPerformanceLogger
必填
IPerformanceLogger

该函数还必须返回一个 React Component。

setWrapperComponentProvider()​

React TSX
static setWrapperComponentProvider(
  provider: WrapperComponentProvider,
);

参数：

名称类型
provider
必填
ComponentProvider

startHeadlessTask()​

React TSX
static startHeadlessTask(
  taskId: number,
  taskKey: string,
  data: any,
);

仅由原生代码调用。启动一个 headless 任务。

参数：

名称类型描述
taskId
必填
number用于跟踪此任务实例执行情况的原生 id。
taskKey
必填
string要启动的任务的键。
data
必填
any要传递给任务的数据。

unmountApplicationComponentAtRootTag()​

React TSX
static unmountApplicationComponentAtRootTag(rootTag: number);

当视图应被销毁时停止应用。

参数：

名称类型
rootTag
必填
number

类型定义​

AppConfig​

registerConfig 方法的应用配置。

类型
object

属性：

名称类型
appKey
必填
string
componentComponentProvider
runfunction
sectionboolean
备注

每个配置都应设置 component 或 run 函数中的一个。

Registry​

类型
object

属性：

名称类型
runnablesRunnables 数组
sections字符串数组

Runnable​

类型
object

属性：

名称类型
componentComponentProvider
runfunction

Runnables​

一个以 appKey 为键、以 Runnable 类型为值的对象。

类型
object

Task​

Task 是一个接受任意数据作为参数并返回一个解析为 undefined 的 Promise 的函数。

类型
function

TaskCanceller​

TaskCanceller 是一个不接受参数并返回 void 的函数。

类型
function

TaskCancelProvider​

有效的 TaskCancelProvider 是一个返回 TaskCanceller 的函数。

类型
function

TaskProvider​

有效的 TaskProvider 是一个返回 Task 的函数。

类型
function