跳到主要内容
版本:0.77

Android 原生 UI 组件

信息

Native Module 和 Native Components 是我们旧架构中使用的稳定技术。 当新架构稳定后,它们将在未来被弃用。新架构使用 Turbo Native ModuleFabric Native Components 来实现类似的结果。

这里有大量的原生 UI 控件可用于最新的应用程序——其中一些是平台的一部分,另一些可作为第三方库使用,还有更多可能就在您自己的作品集中使用。React Native 已经封装了几个最关键的平台组件,例如 ScrollViewTextInput,但并不是全部,当然也不是您可能为之前的应用程序自己编写的组件。幸运的是,我们可以封装这些现有组件,以便与您的 React Native 应用程序无缝集成。

像原生模块指南一样,这也是一个更高级的指南,假设您对 Android SDK 编程有一定的了解。本指南将向您展示如何构建原生 UI 组件,带您逐步实现核心 React Native 库中现有的 ImageView 组件的子集。

信息

您也可以使用一个命令设置包含原生组件的本地库。阅读 本地库设置 指南以获取更多详情。

ImageView 示例

在这个示例中,我们将逐步介绍在 JavaScript 中使用 ImageView 的实现要求。

原生视图是通过扩展 ViewManager 或更常见的 SimpleViewManager 来创建和操作的。SimpleViewManager 在这种情况下很方便,因为它应用了常见的属性,如背景颜色、不透明度和 Flexbox 布局。

这些子类本质上是单例的——桥接只为每个子类创建一个实例。它们将原生视图发送给 NativeViewHierarchyManager,后者再委托它们根据需要设置和更新视图的属性。ViewManager 通常也是视图的代理,通过桥接将事件发送回 JavaScript。

要发送视图:

  1. 创建 ViewManager 子类。
  2. 实现 createViewInstance 方法
  3. 使用 @ReactProp(或 @ReactPropGroup)注解暴露视图属性设置器
  4. 在应用程序包的 createViewManagers 中注册管理器。
  5. 实现 JavaScript 模块

1. 创建 ViewManager 子类

在这个示例中,我们创建了视图管理器类 ReactImageManager,它扩展了 ReactImageView 类型的 SimpleViewManagerReactImageView 是管理器管理的对象类型,这将是自定义原生视图。getName 返回的名称用于从 JavaScript 引用原生视图类型。

java
public class ReactImageManager extends SimpleViewManager<ReactImageView> {

public static final String REACT_CLASS = "RCTImageView";
ReactApplicationContext mCallerContext;

public ReactImageManager(ReactApplicationContext reactContext) {
mCallerContext = reactContext;
}

@Override
public String getName() {
return REACT_CLASS;
}
}

2. 实现 createViewInstance 方法

视图在 createViewInstance 方法中创建,视图应在其默认状态下初始化自身,任何属性将通过后续调用 updateView 来设置。

java
  @Override
public ReactImageView createViewInstance(ThemedReactContext context) {
return new ReactImageView(context, Fresco.newDraweeControllerBuilder(), null, mCallerContext);
}

3. 使用 @ReactProp(或 @ReactPropGroup)注解暴露视图属性设置器

要在 JavaScript 中反映的属性需要暴露为用 @ReactProp(或 @ReactPropGroup)注解的 setter 方法。Setter 方法应将要更新的视图(当前视图类型)作为第一个参数,属性值作为第二个参数。Setter 应该是 public 且不返回值(即在 Java 中返回类型应为 void,在 Kotlin 中为 Unit)。发送到 JS 的属性类型是根据 setter 值参数的类型自动确定的。目前支持以下类型的值(在 Java 中):boolean, int, float, double, String, Boolean, Integer, ReadableArray, ReadableMap。Kotlin 中对应的类型是 Boolean, Int, Float, Double, String, ReadableArray, ReadableMap

注解 @ReactProp 有一个必需参数 name,类型为 String。分配给链接到 setter 方法的 @ReactProp 注解的名称用于在 JS 端引用该属性。

除了 name@ReactProp 注解还可以接受以下可选参数:defaultBoolean, defaultInt, defaultFloat。这些参数应具有相应的类型(在 Java 中分别为 boolean, int, float,在 Kotlin 中为 Boolean, Int, Float),并且当 setter 引用的属性已从组件中移除时,提供的值将传递给 setter 方法。请注意,“默认”值仅针对基本类型提供,当 setter 是某种复杂类型时,如果相应属性被移除,null 将作为默认值提供。

使用 @ReactPropGroup 注解的方法的 Setter 声明要求与 @ReactProp 不同,请参阅 @ReactPropGroup 注解类文档以获取更多信息。重要! 在 ReactJS 中,更新属性值将导致 setter 方法调用。请注意,我们更新组件的一种方式是通过移除之前已设置的属性。在这种情况下,setter 方法也会被调用以通知视图管理器属性已更改。在这种情况下,将提供“默认”值(对于基本类型,“默认”值可以使用 @ReactProp 注解的 defaultBoolean, defaultFloat 等参数指定,对于复杂类型,setter 将以 null 值调用)。

java
  @ReactProp(name = "src")
public void setSrc(ReactImageView view, @Nullable ReadableArray sources) {
view.setSource(sources);
}

@ReactProp(name = "borderRadius", defaultFloat = 0f)
public void setBorderRadius(ReactImageView view, float borderRadius) {
view.setBorderRadius(borderRadius);
}

@ReactProp(name = ViewProps.RESIZE_MODE)
public void setResizeMode(ReactImageView view, @Nullable String resizeMode) {
view.setScaleType(ImageResizeMode.toScaleType(resizeMode));
}

4. 注册 ViewManager

最后一步是将 ViewManager 注册到应用程序,这与 原生模块 类似,通过应用程序包的成员函数 createViewManagers 进行。

java
  @Override
public List<ViewManager> createViewManagers(
ReactApplicationContext reactContext) {
return Arrays.<ViewManager>asList(
new ReactImageManager(reactContext)
);
}

5. 实现 JavaScript 模块

最后一步是创建 JavaScript 模块,该模块定义了新视图用户的 Java/Kotlin 和 JavaScript 之间的接口层。建议您在此模块中记录组件接口(例如,使用 TypeScript、Flow 或普通注释)。

ImageView.tsx
import {requireNativeComponent} from 'react-native';

/**
* 组合了 `View`。
*
* - src: Array<{url: string}>
* - borderRadius: number
* - resizeMode: 'cover' | 'contain' | 'stretch'
*/
export default requireNativeComponent('RCTImageView');

requireNativeComponent 函数接受原生视图的名称。请注意,如果您的组件需要做任何更复杂的事情(例如自定义事件处理),您应该将原生组件包装在另一个 React 组件中。这在下面的 MyCustomView 示例中进行了说明。

事件

所以现在我们知道如何暴露我们可以从 JS 自由控制的原生视图组件,但是我们如何处理来自用户的事件,如捏缩或平移?当原生事件发生时,原生代码应向视图的 JavaScript 表示发出事件,这两个视图通过 getId() 方法返回的值链接。

java
class MyCustomView extends View {
...
public void onReceiveNativeEvent() {
WritableMap event = Arguments.createMap();
event.putString("message", "MyMessage");
ReactContext reactContext = (ReactContext)getContext();
reactContext
.getJSModule(RCTEventEmitter.class)
.receiveEvent(getId(), "topChange", event);
}
}

要将 topChange 事件名称映射到 JavaScript 中的 onChange 回调属性,请通过在 ViewManager 中重写 getExportedCustomBubblingEventTypeConstants 方法来注册它:

java
public class ReactImageManager extends SimpleViewManager<MyCustomView> {
...
public Map getExportedCustomBubblingEventTypeConstants() {
return MapBuilder.builder().put(
"topChange",
MapBuilder.of(
"phasedRegistrationNames",
MapBuilder.of("bubbled", "onChange")
)
).build();
}
}

此回调使用原始事件调用,我们通常在包装组件中处理它以制作更简单的 API:

MyCustomView.tsx
import {useCallback} from 'react';
import {requireNativeComponent} from 'react-native';

const RCTMyCustomView = requireNativeComponent('RCTMyCustomView');

export default function MyCustomView(props: {
// ...
/**
* 当用户拖动地图时持续调用的回调。
*/
onChangeMessage: (message: string) => unknown;
}) {
const onChange = useCallback(
event => {
props.onChangeMessage?.(event.nativeEvent.message);
},
[props.onChangeMessage],
);

return <RCTMyCustomView {...props} onChange={onChange} />;
}

与 Android Fragment 集成的示例

为了将现有的原生 UI 元素集成到你的 React Native 应用中,你可能需要使用 Android Fragments,以便比从 ViewManager 返回 View 更细粒度地控制你的原生组件。如果你想借助 生命周期方法 添加绑定到视图的自定义逻辑,例如 onViewCreatedonPauseonResume,你将需要这样做。以下步骤将展示如何操作:

1. 创建一个示例自定义视图

首先,让我们创建一个扩展自 FrameLayoutCustomView 类(此视图的内容可以是你想要渲染的任何视图)

CustomView.java
// 替换为你的包名
package com.mypackage;

import android.content.Context;
import android.graphics.Color;
import android.widget.FrameLayout;
import android.widget.ImageView;
import android.widget.TextView;

import androidx.annotation.NonNull;

public class CustomView extends FrameLayout {
public CustomView(@NonNull Context context) {
super(context);
// 设置内边距和背景颜色
this.setPadding(16,16,16,16);
this.setBackgroundColor(Color.parseColor("#5FD3F3"));

// 添加默认文本视图
TextView text = new TextView(context);
text.setText("Welcome to Android Fragments with React Native.");
this.addView(text);
}
}

2. 创建一个 Fragment

MyFragment.java
// 替换为你的包名
package com.mypackage;

import android.os.Bundle;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import androidx.fragment.app.Fragment;

// 替换为你的视图的导入
import com.mypackage.CustomView;

public class MyFragment extends Fragment {
CustomView customView;

@Override
public View onCreateView(LayoutInflater inflater, ViewGroup parent, Bundle savedInstanceState) {
super.onCreateView(inflater, parent, savedInstanceState);
customView = new CustomView(this.getContext());
return customView; // 这个 CustomView 可以是你想要渲染的任何视图
}

@Override
public void onViewCreated(View view, Bundle savedInstanceState) {
super.onViewCreated(view, savedInstanceState);
// 执行任何应该在 `onCreate` 方法中发生的逻辑,例如:
// customView.onCreate(savedInstanceState);
}

@Override
public void onPause() {
super.onPause();
// 执行任何应该在 `onPause` 方法中发生的逻辑
// 例如:customView.onPause();
}

@Override
public void onResume() {
super.onResume();
// 执行任何应该在 `onResume` 方法中发生的逻辑
// 例如:customView.onResume();
}

@Override
public void onDestroy() {
super.onDestroy();
// 执行任何应该在 `onDestroy` 方法中发生的逻辑
// 例如:customView.onDestroy();
}
}

3. 创建 ViewManager 子类

MyViewManager.java
// 替换为你的包名
package com.mypackage;

import android.view.Choreographer;
import android.view.View;
import android.view.ViewGroup;
import android.widget.FrameLayout;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.fragment.app.FragmentActivity;

import com.facebook.react.bridge.ReactApplicationContext;
import com.facebook.react.bridge.ReadableArray;
import com.facebook.react.common.MapBuilder;
import com.facebook.react.uimanager.annotations.ReactProp;
import com.facebook.react.uimanager.annotations.ReactPropGroup;
import com.facebook.react.uimanager.ViewGroupManager;
import com.facebook.react.uimanager.ThemedReactContext;

import java.util.Map;

public class MyViewManager extends ViewGroupManager<FrameLayout> {

public static final String REACT_CLASS = "MyViewManager";
public final int COMMAND_CREATE = 1;
private int propWidth;
private int propHeight;

ReactApplicationContext reactContext;

public MyViewManager(ReactApplicationContext reactContext) {
this.reactContext = reactContext;
}

@Override
public String getName() {
return REACT_CLASS;
}

/**
* 返回一个随后将持有 Fragment 的 FrameLayout
*/
@Override
public FrameLayout createViewInstance(ThemedReactContext reactContext) {
return new FrameLayout(reactContext);
}

/**
* 将 "create" 命令映射为一个整数
*/
@Nullable
@Override
public Map<String, Integer> getCommandsMap() {
return MapBuilder.of("create", COMMAND_CREATE);
}

/**
* 处理 "create" 命令(从 JS 调用)并调用 createFragment 方法
*/
@Override
public void receiveCommand(
@NonNull FrameLayout root,
String commandId,
@Nullable ReadableArray args
) {
super.receiveCommand(root, commandId, args);
int reactNativeViewId = args.getInt(0);
int commandIdInt = Integer.parseInt(commandId);

switch (commandIdInt) {
case COMMAND_CREATE:
createFragment(root, reactNativeViewId);
break;
default: {}
}
}

@ReactPropGroup(names = {"width", "height"}, customType = "Style")
public void setStyle(FrameLayout view, int index, Integer value) {
if (index == 0) {
propWidth = value;
}

if (index == 1) {
propHeight = value;
}
}

/**
* 用自定义 fragment 替换你的 React Native 视图
*/
public void createFragment(FrameLayout root, int reactNativeViewId) {
ViewGroup parentView = (ViewGroup) root.findViewById(reactNativeViewId);
setupLayout(parentView);

final MyFragment myFragment = new MyFragment();
FragmentActivity activity = (FragmentActivity) reactContext.getCurrentActivity();
activity.getSupportFragmentManager()
.beginTransaction()
.replace(reactNativeViewId, myFragment, String.valueOf(reactNativeViewId))
.commit();
}

public void setupLayout(View view) {
Choreographer.getInstance().postFrameCallback(new Choreographer.FrameCallback() {
@Override
public void doFrame(long frameTimeNanos) {
manuallyLayoutChildren(view);
view.getViewTreeObserver().dispatchOnGlobalLayout();
Choreographer.getInstance().postFrameCallback(this);
}
});
}

/**
* 正确布局所有子元素
*/
public void manuallyLayoutChildren(View view) {
// propWidth 和 propHeight 来自 react-native 属性
int width = propWidth;
int height = propHeight;

view.measure(
View.MeasureSpec.makeMeasureSpec(width, View.MeasureSpec.EXACTLY),
View.MeasureSpec.makeMeasureSpec(height, View.MeasureSpec.EXACTLY));

view.layout(0, 0, width, height);
}
}

4. 注册 ViewManager

MyPackage.java
// 替换为你的包名
package com.mypackage;

import com.facebook.react.ReactPackage;
import com.facebook.react.bridge.ReactApplicationContext;
import com.facebook.react.uimanager.ViewManager;

import java.util.Arrays;
import java.util.List;

public class MyPackage implements ReactPackage {

@Override
public List<ViewManager> createViewManagers(ReactApplicationContext reactContext) {
return Arrays.<ViewManager>asList(
new MyViewManager(reactContext)
);
}

}

5. 注册 Package

MainApplication.java
@Override
protected List<ReactPackage> getPackages() {
List<ReactPackage> packages = new PackageList(this).getPackages();
// 尚未自动链接的包可以手动添加到这里,例如:
// packages.add(new MyReactNativePackage());
packages.add(new MyAppPackage());
return packages;
}

6. 实现 JavaScript 模块

I. 从自定义 View manager 开始:

MyViewManager.tsx
import {requireNativeComponent} from 'react-native';

export const MyViewManager =
requireNativeComponent('MyViewManager');

II. 然后实现调用 create 方法的自定义 View:

MyView.tsx
import React, {useEffect, useRef} from 'react';
import {
PixelRatio,
UIManager,
findNodeHandle,
} from 'react-native';

import {MyViewManager} from './my-view-manager';

const createFragment = viewId =>
UIManager.dispatchViewManagerCommand(
viewId,
// 我们正在调用 'create' 命令
UIManager.MyViewManager.Commands.create.toString(),
[viewId],
);

export const MyView = () => {
const ref = useRef(null);

useEffect(() => {
const viewId = findNodeHandle(ref.current);
createFragment(viewId);
}, []);

return (
<MyViewManager
style={{
// 将 dpi 转换为 px,提供所需高度
height: PixelRatio.getPixelSizeForLayoutSize(200),
// 将 dpi 转换为 px,提供所需宽度
width: PixelRatio.getPixelSizeForLayoutSize(200),
}}
ref={ref}
/>
);
};

如果你想使用 @ReactProp(或 @ReactPropGroup)注解暴露属性 setter,请参阅上面的 ImageView 示例