跳至主要内容

原生和 React Native 之间的通信

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

简介

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

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

属性

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

将属性从原生传递到 React Native

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

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

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];
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 应用将使用新的属性重新渲染。仅当新的更新后的属性与之前的属性不同时,才会执行更新。

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 中使用,RCTUIManager 是一个管理所有 React Native 视图的内部 React Native 类。

原生模块也可用于将现有的原生库公开给 JS。 地理位置库 是这个想法的一个活生生的例子。

警告

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

布局计算流程

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

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

本文 介绍 了这种情况。概括地说,由于我们所有的原生 react 视图都是 UIView 的子类,因此大多数样式和大小属性将按预期工作。

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

具有固定大小的 React Native 内容

一般情况下,我们会遇到一个具有固定大小的 React Native 应用,并且原生端知道这个大小。特别是全屏 React Native 视图属于这种情况。如果我们想要一个更小的根视图,可以显式设置 RCTRootView 的 frame。

例如,要创建一个高度为 200(逻辑像素)且宽度与宿主视图相同的 RN 应用,我们可以执行以下操作

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 和原生中都使尺寸灵活会导致未定义的行为。例如,不要在使用 RCTRootViewSizeFlexibilityWidth 宿主 RCTRootView 的同时,使顶级 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 属性)。然后在委托方法中更改其可见性。