React Native 原生组件封装:js 调用原生组件方法

注意,这篇文章讨论的是原生组件(Native UI Components),而不是原生模块(Native Modules)。其次,我会假设你已经对原生组件封装有基本的了解,如果还不了解,请看官方文档:Android 篇iOS 篇

开始

也许你并不知道,除了 props,RN 还提供另一种直接调用原生组件方法的机制,通过这种机制,就可以实现 react 组件方法(Refs and the DOM)。内置的原生组件就有这样的实现:ScrollView#scrollToDrawerLayoutAndroid#openDrawer。然而官方文档并没有相关的描述,不过,我们还是可以通过研究内置组件的实现代码,作出一些总结。

废话不多说,直接上结论,下面以 ScrollView#scrollTo 为例

Component

ScrollView.js

// @flow
import React, {PureComponent} from 'react'
import {findNodeHandle, UIManager} from 'react-native'

export default class ScrollView extends PureComponent {
  _sendCommand(command: string, params?: []) {
    UIManager.dispatchViewManagerCommand(
      findNodeHandle(this),
      UIManager.RNScrollView.Commands[command],
      params,
    )
  }
  
  scrollTo(y: number) {
    this._sendCommand('scrollTo', [y])
  }
}
  1. UIManager.dispatchViewManagerCommand 用于发送命令到原生组件
  2. 第1个参数是 component ref
  3. 第2个参数是 command ref,格式为 UIManager[Component].Commands[command]
  4. 第3个参数是 command params,必须是数组

Android

ScrollViewManager.java

public class ScrollViewManager extends ViewGroupManager<ScrollView> {
  public static final int SCROLL_TO = 1;
  
  @Override
  public @Nullable Map<String, Integer> getCommandsMap() {
    return MapBuilder.of("scrollTo", SCROLL_TO);
  }
  
  @Override
  public void receiveCommand(ScrollView root, int commandId, @Nullable ReadableArray args) {
    if (commandId == SCROLL_TO) {
      root.scrollTo(args);
    }
  }
}
  1. 通过 getCommandsMap 定义命令映射,这个映射也就是 js 端的 UIManager[Component].Commands[command]
  2. receiveCommand 里处理命令,js 端传过来的 params 会被转换成 ReadableArray

iOS

ScrollViewManager.m

RCT_EXPORT_METHOD(scrollTo:(nonnull NSNumber *)reactTag y:(NSInteger)y) {
  ScrollView *scrollView = (ScrollView *) viewRegistry[reactTag];
  scrollView.scrollTo(y);
}

iOS 就更简单了,我想已经不需要做太多解释。

最后

有一点需要注意:原生组件的命令机制不能返回数据。不过,退而求其次,可以通过事件的方式向 js 端回传数据。

如果你还是不太确定怎么实现,那么建议你去看 RN 内置组件的源代码。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,214评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,307评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,543评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,221评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,224评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,007评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,313评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,956评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,441评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,925评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,018评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,685评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,234评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,240评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,464评论 1 261
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,467评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,762评论 2 345

推荐阅读更多精彩内容