跳到主要内容
版本:0.80

原生与 React Native 之间的通信

《集成到现有应用》指南《原生 UI 组件》指南 中,我们学习了如何在原生组件中嵌入 React Native,反之亦然。当我们混合使用原生和 React Native 组件时,我们最终会发现需要在这两个世界之间进行通信。其他指南中已经提到了一些实现方法。本文总结了可用的技术。

简介

React Native 的灵感来自 React,因此信息流的基本思想是相似的。React 中的流是单向的。我们维护一个组件层级,其中每个组件仅依赖于其父组件及其自身的内部状态。我们通过属性来实现这一点:数据以自上而下的方式从父组件传递给其子组件。如果祖先组件依赖于其后代的状态,则应该传递一个回调供后代使用以更新祖先。

同样的概念也适用于 React Native。只要我们纯粹在框架内构建应用程序,我们就可以通过属性和回调来驱动我们的应用。但是,当我们混合使用 React Native 和原生组件时,我们需要一些特定的跨语言机制,以便在它们之间传递信息。

属性

属性是最直接的跨组件通信方式。因此,我们需要一种方法既可以从原生传递属性到 React Native,也可以从 React Native 传递属性到原生。

从原生传递属性到 React Native

为了在原生组件中嵌入 React Native 视图,我们使用 RCTRootViewRCTRootView 是一个持有 React Native 应用的 UIView。它还提供了原生端和托管应用之间的接口。

RCTRootView 有一个初始化方法,允许你将任意属性传递给 React Native 应用。initialProperties 参数必须是 NSDictionary 的实例。该字典在内部被转换为一个 JSON 对象,顶层 JS 组件可以引用该对象。

objectivec
NSArray *imageList = @[@"https://dummyimage.com/600x400/ffffff/000000.png",
@"https://dummyimage.com/600x400/000000/ffffff.png"];

NSDictionary *props = @{@"images" : imageList};

RCTRootView *rootView = [[RCTRootView alloc] initWithBridge:bridge
moduleName:@"ImageBrowserApp"
initialProperties:props];
tsx
import React from 'react';
import {View, Image} from 'react-native';

export default class ImageBrowserApp extends React.Component {
renderImage(imgURI) {
return <Image source={{uri: imgURI}} />;
}
render() {
return <View>{this.props.images.map(this.renderImage)}</View>;
}
}

RCTRootView 还提供了一个读写属性 appProperties。设置 appProperties 后,React Native 应用将使用新属性重新渲染。仅当新更新的属性与之前的属性不同时,才会执行更新。

objectivec
NSArray *imageList = @[@"https://dummyimage.com/600x400/ff0000/000000.png",
@"https://dummyimage.com/600x400/ffffff/ff0000.png"];

rootView.appProperties = @{@"images" : imageList};

随时更新属性是可以的。但是,更新必须在主线程上执行。你可以在任何线程上使用 getter。

备注

目前,已知存在一个问题,即在桥接启动期间设置 appProperties 时,更改可能会丢失。有关更多信息,请参阅 https://github.com/facebook/react-native/issues/20115。

无法一次只更新少数几个属性。我们建议你将其构建到自己的包装器中。

从 React Native 传递属性到原生

暴露原生组件属性的问题在 这篇文章 中有详细说明。简而言之,在你的自定义原生组件中使用 RCT_CUSTOM_VIEW_PROPERTY 宏导出属性,然后在 React Native 中使用它们,就像该组件是普通 React Native 组件一样。

属性的限制

跨语言属性的主要缺点是不支持回调,这将允许我们处理自下而上的数据绑定。想象一下,你有一个小的 RN 视图,由于 JS 动作的结果,你希望将其从原生父视图中移除。使用 props 无法做到这一点,因为信息需要自下而上传递。

虽然我们有一种跨语言回调的形式(此处描述),但这些回调并不总是我们需要的。主要问题是它们不打算作为属性传递。相反,这种机制允许我们从 JS 触发原生动作,并在 JS 中处理该动作的结果。

其他跨语言交互方式(事件和原生模块)

正如前一章所述,使用属性有一些限制。有时属性不足以驱动我们应用的逻辑,我们需要一个提供更灵活性的解决方案。本章涵盖了 React Native 中可用的其他通信技术。它们可用于内部通信(RN 中 JS 和原生层之间)以及外部通信(RN 和你应用的“纯原生”部分之间)。

React Native 使你能够执行跨语言函数调用。你可以从 JS 执行自定义原生代码,反之亦然。不幸的是,根据我们工作的端不同,我们通过不同的方式实现相同的目标。对于原生端——我们使用事件机制来调度 JS 中处理函数的执行,而对于 React Native,我们直接调用原生模块导出的方法。

从原生调用 React Native 函数(事件)

事件在 这篇文章 中有详细说明。请注意,使用事件并不能保证执行时间,因为事件是在单独的线程上处理的。

事件很强大,因为它们允许我们更改 React Native 组件而无需对它们的引用。但是,在使用它们时可能会陷入一些陷阱:

  • 由于事件可以从任何地方发送,它们可能会在你的项目中引入面条式依赖。
  • 事件共享命名空间,这意味着你可能会遇到一些名称冲突。冲突不会被静态检测到,这使得它们难以调试。
  • 如果你使用同一个 React Native 组件的多个实例,并且你想从事件的角度区分它们,你可能需要引入标识符并随事件一起传递它们(你可以使用原生视图的 reactTag 作为标识符)。

我们在 React Native 中嵌入原生时使用的常见模式是将原生组件的 RCTViewManager 作为视图的代理,通过桥接将事件发送回 JavaScript。这将相关的事件调用保持在一个地方。

从 React Native 调用原生函数(原生模块)

原生模块是 JS 中可用的 Objective-C 类。通常每个 JS 桥接为每个模块创建一个实例。它们可以向 React Native 导出任意函数和常量。它们在 这篇文章 中有详细说明。

原生模块是单例这一事实限制了嵌入上下文中的机制。假设我们有一个嵌入在原生视图中的 React Native 组件,并且我们想要更新原生的父视图。使用原生模块机制,我们将导出一个函数,该函数不仅接受预期的参数,还接受父原生视图的标识符。该标识符将用于检索父视图的引用以进行更新。也就是说,我们需要在模块中保持从标识符到原生视图的映射。

虽然这个解决方案很复杂,但它用于 RCTUIManager,这是一个管理所有 React Native 视图的内部 React Native 类。

原生模块也可用于向 JS 暴露现有的原生库。Geolocation 库 就是这个想法的一个活生生的例子。

警告

所有原生模块共享相同的命名空间。创建新模块时要注意名称冲突。

布局计算流

在集成原生和 React Native 时,我们还需要一种方法来整合两种不同的布局系统。本节涵盖了常见的布局问题,并简要描述了解决这些问题的机制。

嵌入在 React Native 中的原生组件的布局

这种情况在 这篇文章 中有涵盖。总之,由于我们所有的原生 react 视图都是 UIView 的子类,大多数样式和尺寸属性都会像预期的那样开箱即用。

嵌入在原生的 React Native 组件的布局

固定大小的 React Native 内容

一般场景是当我们有一个固定大小的 React Native 应用时,原生侧知道这个大小。特别是,全屏 React Native 视图属于这种情况。如果我们想要一个较小的根视图,我们可以显式设置 RCTRootView 的 frame。

例如,要使一个 RN 应用高 200(逻辑)像素,宽与宿主视图相同,我们可以这样做:

SomeViewController.m
- (void)viewDidLoad
{
[...]
RCTRootView *rootView = [[RCTRootView alloc] initWithBridge:bridge
moduleName:appName
initialProperties:props];
rootView.frame = CGRectMake(0, 0, self.view.width, 200);
[self.view addSubview:rootView];
}

当我们有一个固定大小的根视图时,我们需要在 JS 端尊重其边界。换句话说,我们需要确保 React Native 内容可以包含在固定大小的根视图内。确保这一点的最简单方法是使用 Flexbox 布局。如果你使用绝对定位,并且 React 组件在根视图的边界之外可见,你将与原生视图重叠,导致某些功能表现异常。例如,'TouchableHighlight' 不会高亮显示根视图边界之外的触摸。

通过重新设置其 frame 属性来动态更新根视图的大小是完全可以的。React Native 将负责内容的布局。

灵活大小的 React Native 内容

在某些情况下,我们希望渲染初始大小未知的内容。假设大小将在 JS 中动态定义。我们有两个解决方案。

  1. 你可以将 React Native 视图包装在 ScrollView 组件中。这保证你的内容将始终可用,并且不会与原生视图重叠。
  2. React Native 允许你在 JS 中确定 RN 应用的大小,并将其提供给宿主 RCTRootView 的拥有者。然后拥有者负责重新布局子视图并保持 UI 一致。我们通过 RCTRootView 的灵活性模式来实现这一点。

RCTRootView 支持 4 种不同的大小灵活性模式:

RCTRootView.h
typedef NS_ENUM(NSInteger, RCTRootViewSizeFlexibility) {
RCTRootViewSizeFlexibilityNone = 0,
RCTRootViewSizeFlexibilityWidth,
RCTRootViewSizeFlexibilityHeight,
RCTRootViewSizeFlexibilityWidthAndHeight,
};

RCTRootViewSizeFlexibilityNone 是默认值,它使根视图的大小固定(但仍然可以使用 setFrame: 更新)。其他三种模式允许我们跟踪 React Native 内容的大小更新。例如,将模式设置为 RCTRootViewSizeFlexibilityHeight 将导致 React Native 测量内容的高度并将该信息传回 RCTRootView 的代理。可以在代理内执行任意操作,包括设置根视图的 frame,以便内容适配。仅当内容大小发生变化时才会调用代理。

警告

在 JS 和原生中都将维度设置为灵活会导致未定义的行为。例如——当你在宿主 RCTRootView 上使用 RCTRootViewSizeFlexibilityWidth 时,不要使顶层 React 组件的宽度灵活(使用 flexbox)。

让我们看一个例子。

FlexibleSizeExampleView.m
- (instancetype)initWithFrame:(CGRect)frame
{
[...]

_rootView = [[RCTRootView alloc] initWithBridge:bridge
moduleName:@"FlexibilityExampleApp"
initialProperties:@{}];

_rootView.delegate = self;
_rootView.sizeFlexibility = RCTRootViewSizeFlexibilityHeight;
_rootView.frame = CGRectMake(0, 0, self.frame.size.width, 0);
}

#pragma mark - RCTRootViewDelegate
- (void)rootViewDidChangeIntrinsicSize:(RCTRootView *)rootView
{
CGRect newFrame = rootView.frame;
newFrame.size = rootView.intrinsicContentSize;

rootView.frame = newFrame;
}

在示例中,我们有一个持有根视图的 FlexibleSizeExampleView 视图。我们创建根视图,初始化它并设置代理。代理将处理大小更新。然后,我们将根视图的大小灵活性设置为 RCTRootViewSizeFlexibilityHeight,这意味着每次 React Native 内容更改其高度时,都会调用 rootViewDidChangeIntrinsicSize: 方法。最后,我们设置根视图的宽度和位置。请注意,我们也设置了高度,但它没有效果,因为我们使高度依赖于 RN。

你可以在此处查看示例的完整源代码 这里

动态更改根视图的大小灵活性模式是可以的。更改根视图的灵活性模式将调度布局重新计算,一旦内容大小已知,代理 rootViewDidChangeIntrinsicSize: 方法将被调用。

备注

React Native 布局计算在单独的线程上执行,而原生 UI 视图更新在主线程上完成。 这可能会导致原生和 React Native 之间暂时的 UI 不一致。这是一个已知问题,我们的团队正在努力同步来自不同来源的 UI 更新。

备注

React Native 直到根视图成为其他视图的子视图之前不会执行任何布局计算。 如果你想隐藏 React Native 视图直到其尺寸已知,请将根视图添加为子视图并使其初始隐藏(使用 UIViewhidden 属性)。然后在代理方法中更改其可见性。