Shopify 实践:在 React Native 中创建接受子视图的原生组件

本文基于 Shopify 的工程实践,详细阐述了在 React Native 中创建接受子视图的原生组件(如 Bottom Sheet)的技术实现。核心在于使用 Android 的 `ViewGroupManager` 继承类,通过重写 `createViewInstance` 膨胀原生 XML 布局,并重写 `addView` 方法将 React 传入的子视图分发到原生容器的不同区域。同时,通过 `@ReactProp` 接收状态并监听原生事件回传状态变化,实现了原生组件与 React 视图的双向无缝集成。

READ

Shopify 的工程实践展示了如何在 React Native 中突破纯 JavaScript 的限制,通过原生模块(Native Modules)实现复杂的原生交互(如 Bottom Sheet),并无缝集成 React 子视图。该方案的核心在于利用 Android 的 ViewGroupManager 机制,将 React Native 渲染的视图作为子视图添加到原生容器中,从而实现原生性能与 React 灵活性的结合。

核心实现机制:ViewGroupManager

在 Android 端,实现接受子视图的原生组件主要依赖于继承 ViewGroupManager<T>。该类充当了 React Native 与原生 ViewGroup 之间的桥梁,负责管理子视图的生命周期和布局。

1. 基础组件定义

创建原生组件类(如 ReactNativeBottomSheet.kt),必须实现以下核心方法:

  • getName(): 返回组件在 React Native 侧引用的名称。
  • createViewInstance(): 实例化原生视图并进行初始设置。
class ReactNativeBottomSheetManager : ViewGroupManager<CoordinatorLayout>() {
    override fun getName() = "ReactNativeBottomSheet"

    override fun createViewInstance(reactContext: ReactApplicationContext): CoordinatorLayout {
        // 初始化原生容器
        return CoordinatorLayout(reactContext)
    }
}

2. 通过 XML 膨胀布局

为了简化原生 UI 的构建,通常使用 XML 布局文件来定义原生容器的结构。在 createViewInstance 中,通过 Context 膨胀 XML 布局,并保存对关键子视图的引用,以便后续管理 React 传入的子视图。

override fun createViewInstance(reactContext: ReactApplicationContext): CoordinatorLayout {
    val view = LayoutInflater.from(reactContext)
        .inflate(R.layout.bottom_sheet, null) as CoordinatorLayout
    // 保存对内部容器的引用,用于添加 React 子视图
    this.container = view.findViewById(R.id.container)
    this.bottomSheet = view.findViewById(R.id.bottom_sheet)
    return view
}
  • container: 用于放置主屏幕内容(第一个子视图)。
  • bottomSheet: 用于放置底部抽屉内容(第二个子视图)。

处理 React 子视图的生命周期

默认情况下,ViewGroupManager 会将所有传入的子视图添加到根 CoordinatorLayout 中,这不符合 Bottom Sheet 的设计需求(需要区分主内容和抽屉内容)。因此,需要重写 addView 方法来手动控制子视图的放置位置。

子视图分发逻辑

通过检查当前容器的子视图数量,可以将传入的 React 子视图分发到不同的原生容器中:

  1. 第一个子视图:添加到主内容容器(container)。
  2. 第二个子视图:添加到底部抽屉容器(bottomSheet)。
  3. 后续子视图:根据设计需求,通常也添加到 bottomSheet 或抛出异常。
override fun addView(parent: CoordinatorLayout, child: View, index: Int) {
    // 不调用 super.addView,而是手动分发
    if (index == 0) {
        container.addView(child)
    } else {
        bottomSheet.addView(child)
    }
}

这种机制允许 React Native 组件以声明式的方式传递子视图,而原生代码负责将其映射到正确的原生 UI 层级中。

状态同步与事件处理

为了实现双向交互,原生组件需要能够接收来自 React 的状态更新,并将原生交互(如手势滑动)产生的状态变化回传给 React。

1. 接收 React 状态 (Props)

通过 @ReactProp 注解定义属性,允许 React 组件传递状态(如展开/折叠状态)给原生组件。

@ReactProp(name = "sheetState")
fun setSheetState(view: CoordinatorLayout, state: String?) {
    val behavior = view.getBehavior(bottomSheet)
    if (behavior is BottomSheetBehavior) {
        if (state == "expanded") {
            behavior.state = BottomSheetBehavior.STATE_EXPANDED
        } else {
            behavior.state = BottomSheetBehavior.STATE_COLLAPSED
        }
    }
}

2. 回传状态变化 (Events)

当用户通过手势改变 Bottom Sheet 状态时,原生代码需要监听状态变化并触发 React 事件。

// 在初始化时添加监听器
behavior.stateChangeCallback = object : BottomSheetBehavior.BottomSheetCallback() {
    override fun onStateChanged(@RawRes newState: Int) {
        val eventName = if (newState == BottomSheetBehavior.STATE_EXPANDED) "expanded" else "collapsed"
        // 触发 React 事件
        view.dispatchEvent("BottomSheetStateChange

## React 侧集成

在 React Native 侧,通过 `requireNativeComponent` 将原生组件包装为标准的 React 组件,并定义 Props 接口。

```typescript
import { requireNativeComponent } from 'react-native';

interface BottomSheetProps {
  sheetState?: string;
  onStateChange?: (event: any) => void;
}

const NativeBottomSheet = requireNativeComponent<BottomSheetProps>('ReactNativeBottomSheet');

export const BottomSheet = ({ sheetState, onStateChange }: BottomSheetProps) => {
  return (
    <NativeBottomSheet
      sheetState={sheetState}
      onStateChange={onStateChange}
    >
      {/* 第一个子视图:主内容 */}
      <View style={styles.mainContent}>
        <Text>Main Screen Content</Text>
      </View>
      {/* 第二个子视图:底部抽屉 */}
      <View style={styles.bottomSheetContent}>
        <Text>Bottom Sheet Content</Text>
      </View>
    </NativeBottomSheet>
  );
};

这种集成方式使得开发者可以在 React 中像使用普通组件一样使用原生组件,同时享受原生性能。

总结

Shopify 的这一实践展示了在 React Native 中混合使用原生和 JS 代码的有效模式:

  1. 突破 JS 限制:对于需要高性能动画或复杂原生交互的场景,使用原生模块实现核心逻辑。
  2. 无缝集成:通过 ViewGroupManager 和 addView 重写,将 React 子视图映射到原生布局中,保持 React 的声明式 UI 优势。
  3. 双向通信:通过 Props 和 Events 实现原生与 JS 之间的状态同步。

该方案适用于需要复用现有原生组件或实现复杂原生交互的跨平台应用开发场景。

参考资料

Conversation

评论

正在加载评论