在原生和React Native间通信

通过植入原生应用原生UI组件两篇文档,我们学习了React Native和原生组件的互相整合。在整合的过程中,我们会需要在两个世界间互相通信。有些方法已经在其他的指南中提到了,这篇文章总结了所有可行的技术。

简介#

React Native是从React中得到的灵感,因此基本的信息流是类似的。在React中信息是单向的。我们维护了组件层次,在其中每个组件都仅依赖于它父类和自己的状态。通过属性(properties)我们将信息从上而下的从父类传递到子元素。如果一个祖先组件需要自己子孙的状态,推荐的方法是传递一个回调函数给对应的子元素。

React Native也运用了相同的概念。只要我们完全在框架内构建应用,就可以通过属性和回调函数来调动整个应用。但是,当我们混合React Native和原生组件时,我们需要一些特殊的,跨语言的机制来传递信息。

属性#

属性是最简单的跨组件通信。因此我们需要一个方法从原生组件传递属性到React Native或者从React Native到原生组件。

从原生组件传递属性到React Native#

我们使用RCTRootView将React Natvie视图封装到原生组件中。RCTRootView是一个UIView容器,承载着React Native应用。同时它也提供了一个联通原生端和被托管端的接口。

通过RCTRootView的初始化函数你可以将任意属性传递给React Native应用。参数initialProperties必须是NSDictionary的一个实例。这一字典参数会在内部被转化为一个可供JS组件调用的JSON对象。

NSArray *imageList = @[@"http://foo.com/bar1.png",
                  @"http://foo.com/bar2.png"];

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

RCTRootView *rootView = [[RCTRootView alloc] initWithBridge:bridge
                                      moduleName:@"ImageBrowserApp"
                                     initialProperties:props];
'use strict';

var React = require('react-native');
  var {
  View,
  Image
} = React;

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

React.AppRegistry.registerComponent('ImageBrowserApp', () => ImageBrowserApp);

RCTRootView同样提供了一个可读写的属性appProperties。在appProperties设置之后,React Native应用将会根据新的属性重新渲染。当然,只有在新属性和之前的属性有区别时更新才会被触发。

NSArray *imageList = @[@"http://foo.com/bar3.png",
                   @"http://foo.com/bar4.png"];
rootView.appProperties = @{@"images" : imageList};

你可以随时更新属性,但是更新必须在主线程中进行,读取则可以在任何线程中进行。
更新属性时并不能做到只更新一部分属性。我们建议你自己封装一个函数来构造属性。

注意:目前,最顶层的RN组件(即registerComponent方法中调用的那个)的componentWillReceivePropscomponentWillUpdateProps方法在属性更新后不会触发。但是,你可以通过componentWillMount访问新的属性值。

从React Native传递属性到原生组件#

这篇文档详细讨论了暴露原生组件属性的问题。简而言之,在你自定义的原生组件中通过RCT_CUSTOM_VIEW_PROPERTY宏导出属性,就可以直接在React Native中使用,就好像它们是普通的React Native组件一样。

属性的限制#

跨语言属性的主要缺点是不支持回调方法,因而无法实现自下而上的数据绑定。设想你有一个小的RN视图,当一个JS动作触发时你想从原生的父视图中移除它。此时你会发现根本做不到,因为信息需要自下而上进行传递。

虽然我们有跨语言回调(参阅这里,但是这些回调函数并不总能满足需求。最主要的问题是它们并不是被设计来当作属性进行传递。这一机制的本意是允许我们从JS触发一个原生动作,然后用JS处理那个动作的处理结果。

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

如上一章所说,使用属性总会有一些限制。有时候属性并不足以满足应用逻辑,因此我们需要更灵活的解决办法。这一章描述了其他的在React Native中可用的通信方法。他们可以用来内部通信(在JS和RN的原生层之间),也可以用作外部通信(在RN和纯原生部分之间)。

React Native允许使用跨语言的函数调用。你可以在JS中调用原生代码,也可以在原生代码中调用JS。在不同端需要用不同的方法来实现相同的目的。在原生代码中我们使用事件机制来调度JS中的处理函数,而在React Native中我们直接使用原生模块导出的方法。

从原生代码调用React Natvie函数(事件)#

事件的详细用法在这篇文章中进行了讨论。注意使用事件无法确保执行的时间,因为事件的处理函数是在单独的线程中执行。

事件很强大,它可以不需要引用直接修改React Native组件。但是,当你使用时要注意下面这些陷阱:

  • 由于事件可以从各种地方产生,它们可能导致混乱的依赖。
  • 事件共享相同的命名空间,因此你可能遇到名字冲突。冲突不会在编写代码时被探测到,因此很难排错。
  • 如果你使用了同一个React Native组件的多个引用,然后想在事件中区分它们,name你很可能需要在事件中同时传递一些标识(你可以使用原生视图中的reactTag作为标识)。

在React Native中嵌入原生组件时,通常的做法是用原生组件的RCTViewManager作为视图的代理,通过bridge向JS发送事件。这样可以集中在一处调用相关的事件。

从React Native中调用原生方法(原生模块)#

原生模块是JS中也可以使用的Objective-C类。一般来说这样的每一个模块的实例都是在每一次通过JS bridge通信时创建的。他们可以导出任意的函数和常量给React Native。相关细节可以参阅这篇文章

事实上原生模块的单实例模式限制了嵌入。假设我们有一个React Native组件被嵌入了一个原生视图,并且我们希望更新原生的父视图。使用原生模块机制,我们可以导出一个函数,不仅要接收预设参数,还要接收父视图的标识。这个标识将会用来获得父视图的引用以更新父视图。那样的话,我们需要维持模块中标识到原生模块的映射。 虽然这个解决办法很复杂,它仍被用在了管理所有React Native视图的RCTUIManager类中,

原生模块同样可以暴露已有的原生库给JS,地理定位库就是一个现成的例子。

警告:所有原生模块共享同一个命名空间。创建新模块时注意命名冲突。

布局计算流#

当集成原生模块和React Natvie时,我们同样需要一个能协同不同的布局系统的办法。这一章节讨论了常见的布局问题,并且提供了解决机制的简单说明。

在React Native中嵌入一个原生组件#

这个情况在这篇文章中进行了讨论。基本上,由于所有的原生视图都是UIView的子集,大多数类型和尺寸属性将和你期望的一样可以使用。

在原生中嵌入一个React Native组件#

固定大小的React Native内容#

最简单的情况是一个对于原生端已知的,固定大小的React Native应用,尤其是一个全屏的React Native视图。如果我们需要一个小一点的根视图,我们可以明确的设置RCTRootView的frame。 比如说,创建一个200像素高,宿主视图那样宽的RN app,我们可以这样做:

// SomeViewController.m

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

当我们创建了一个固定大小的根视图,则需要在JS中遵守它的边界。换句话说,我们需要确保React Native内容能够在固定的大小中放下。最简单的办法是使用flexbox布局。如果你使用绝对定位,并且React组件在根视图边界外可见,则React Native组件将会和原生视图重叠,导致某些不符合期望的行为。比如说,当你点击根视图边界之外的区域TouchableHighlight将不会高亮。 通过重新设置frame的属性来动态更新根视图的大小是完全可行的。React Native将会关注内容布局的变化。

弹性大小的React Native#

有时候我们需要渲染一些不知道大小的内容。假设尺寸将会在JS中动态指定。我们有两个解决办法。

  • 你可以将React Native视图包裹在ScrollView中。这样可以保证你的内容总是可以访问,并且不会和原生视图重叠。
  • 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和原生中都设置弹性尺寸可能导致不确定的行为。比如--不要在设置RCTRootViewRCTRootViewSizeFlexibilityWidth时同时指定最顶层的RN组件宽度可变(使用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.intrinsicSize;

  rootView.frame = newFrame;
}

在例子中我们使用一个FlexibleSizeExampleView视图来包含根视图。我们创建了根视图,初始化并且设置了代理。代理将会处理尺寸更新。然后,我们设置根视图的弹性尺寸为RCTRootViewSizeFlexibilityHeight,意味着rootViewDidChangeIntrinsicSize:方法将会在每次React Native内容高度变化时进行调用。最后,我们设置根视图的宽度和位置。注意我们也设置了高度,但是并没有效果,因为我们已经将高度设置为根据RN内容进行弹性变化了。

你可以在这里查看完整的例子源代码

动态改变根视图的弹性模式是可行的。改变根视图的弹性模式将会导致布局的重新计算,并且在重新量出内容尺寸时会调用rootViewDidChangeIntrinsicSize方法。

注意:React Native布局是通过一个特殊的线程进行计算,而原生UI视图是通过主线程更新。这可能导致短暂的原生端和React Native端的不一致。这是一个已知的问题,我们的团队已经在着手解决不同源的UI同步更新。 注意:除非根视图成为其他视图的子视图,否则React Native不会进行任何的布局计算。如果你想在还没有获得React Native视图的尺寸之前先隐藏视图,请将根视图添加为子视图并且在初始化的时候进行隐藏(使用UIViewhidden属性),然后在代理方法中改变它的可见性。