跳到主要内容

原生组件

如果您想构建*新的* React Native 组件，这些组件封装了一个 主机组件（例如 Android 上一种独特的复选框 CheckBox，或 iOS 上的按钮 UIButton），则应使用 Fabric 原生组件。

本指南将向您展示如何通过实现一个 web 视图组件来构建 Fabric 原生组件。具体步骤如下：

  1. 使用 Flow 或 TypeScript 定义 JavaScript 规范。
  2. 配置依赖管理系统，以便从提供的规范生成代码并自动链接。
  3. 实现原生代码。
  4. 在应用中使用组件。

您需要一个由普通模板生成的应用程序来使用该组件

bash
npx @react-native-community/cli@latest init Demo --install-pods false

创建 WebView 组件​

本指南将向您展示如何创建一个 Web View 组件。我们将使用 Android 的 WebView 组件和 iOS 的 WKWebView 组件来创建该组件。

让我们首先创建用于存放组件代码的文件夹结构

bash
mkdir -p Demo/{specs,android/app/src/main/java/com/webview}

这将为您提供以下工作目录结构

Demo
├── android/app/src/main/java/com/webview
└── ios
└── specs
  • android/app/src/main/java/com/webview 文件夹是包含我们 Android 代码的文件夹。
  • ios 文件夹是包含我们 iOS 代码的文件夹。
  • specs 文件夹是包含 Codegen 规范文件的文件夹。

1. 定义 Codegen 规范​

您的规范必须以 TypeScript 或 Flow 定义（详情请参阅 Codegen 文档）。Codegen 使用它来生成 C++、Objective-C++ 和 Java 代码，以便将您的平台代码连接到 React 运行的 JavaScript 运行时。

规范文件必须命名为 <MODULE_NAME>NativeComponent.{ts|js} 才能与 Codegen 配合使用。后缀 NativeComponent 不仅是一个约定，Codegen 实际上就是使用它来检测规范文件。

使用此规范创建我们的 WebView 组件

Demo/specs/WebViewNativeComponent.ts
import type {
  CodegenTypes,
  HostComponent,
  ViewProps,
} from 'react-native';
import {codegenNativeComponent} from 'react-native';

type WebViewScriptLoadedEvent = {
  result: 'success' | 'error';
};

export interface NativeProps extends ViewProps {
  sourceURL?: string;
  onScriptLoaded?: CodegenTypes.BubblingEventHandler<WebViewScriptLoadedEvent> | null;
}

export default codegenNativeComponent<NativeProps>(
  'CustomWebView',
) as HostComponent<NativeProps>;

此规范由三个主要部分组成，不包括导入部分

  • WebViewScriptLoadedEvent 是事件需要从原生传递到 JavaScript 的数据的支持数据类型。
  • NativeProps 是我们可以在组件上设置的 props 的定义。
  • codegenNativeComponent 语句允许我们为自定义组件生成代码，并定义组件名称，用于匹配原生实现。

与原生模块一样，您可以在 specs/ 目录中拥有多个规范文件。有关您可以使用的类型以及这些类型映射到的平台类型的更多信息，请参阅附录。

2. 配置 Codegen 运行​

React Native 的 Codegen 工具使用该规范为我们生成特定于平台的接口和样板代码。为此，Codegen 需要知道在哪里找到我们的规范以及如何处理它。更新您的 package.json 以包含以下内容

json
    "start": "react-native start",
    "test": "jest"
  },
  "codegenConfig": {
    "name": "AppSpec",
    "type": "components",
    "jsSrcsDir": "specs",
    "android": {
      "javaPackageName": "com.webview"
    },
    "ios": {
      "componentProvider": {
        "CustomWebView": "RCTWebView"
      }
    }
  },
  "dependencies": {

配置好 Codegen 后，我们需要准备我们的原生代码以连接到生成的代码。

请注意，对于 iOS，我们声明性地将规范导出的 JS 组件名称 (`CustomWebView`) 与将原生实现该组件的 iOS 类进行映射。

2. 构建您的原生代码​

现在是编写原生平台代码的时候了，这样当 React 需要渲染一个视图时，平台就可以创建正确的原生视图并在屏幕上渲染它。

您应该同时处理 Android 和 iOS 平台。

注意

本指南向您展示如何创建仅适用于新架构的原生组件。如果您需要同时支持新架构和旧架构，请参阅我们的向后兼容性指南。

现在是编写一些 Android 平台代码以便能够渲染 web 视图的时候了。您需要遵循的步骤是

  • 运行 Codegen
  • 编写 ReactWebView 的代码
  • 编写 ReactWebViewManager 的代码
  • 编写 ReactWebViewPackage 的代码
  • 在应用中注册 ReactWebViewPackage

1. 通过 Gradle 运行 Codegen​

运行一次以生成您的首选 IDE 可以使用的样板代码。

Demo/
cd android
./gradlew generateCodegenArtifactsFromSchema

Codegen 将生成您需要实现的 ViewManager 接口和 web 视图的 ViewManager 委托。

2. 编写 ReactWebView​

ReactWebView 是封装 Android 原生视图的组件，React Native 在使用我们的自定义组件时将渲染该视图。

在 android/src/main/java/com/webview 文件夹中创建一个 ReactWebView.java 或 ReactWebView.kt 文件，并包含以下代码

Demo/android/src/main/java/com/webview/ReactWebView.java
package com.webview;

import android.content.Context;
import android.util.AttributeSet;
import android.webkit.WebView;
import android.webkit.WebViewClient;

import com.facebook.react.bridge.Arguments;
import com.facebook.react.bridge.WritableMap;
import com.facebook.react.bridge.ReactContext;
import com.facebook.react.uimanager.UIManagerHelper;
import com.facebook.react.uimanager.events.Event;

public class ReactWebView extends WebView {
  public ReactWebView(Context context) {
    super(context);
    configureComponent();
  }

  public ReactWebView(Context context, AttributeSet attrs) {
    super(context, attrs);
    configureComponent();
  }

  public ReactWebView(Context context, AttributeSet attrs, int defStyleAttr) {
    super(context, attrs, defStyleAttr);
    configureComponent();
  }

  private void configureComponent() {
    this.setLayoutParams(new LayoutParams(LayoutParams.MATCH_PARENT, LayoutParams.MATCH_PARENT));
    this.setWebViewClient(new WebViewClient() {
      @Override
      public void onPageFinished(WebView view, String url) {
        emitOnScriptLoaded(OnScriptLoadedEventResult.success);
      }
    });
  }

  public void emitOnScriptLoaded(OnScriptLoadedEventResult result) {
    ReactContext reactContext = (ReactContext) context;
    int surfaceId = UIManagerHelper.getSurfaceId(reactContext);
    EventDispatcher eventDispatcher = UIManagerHelper.getEventDispatcherForReactTag(reactContext, getId());
    WritableMap payload = Arguments.createMap();
    payload.putString("result", result.name());

    OnScriptLoadedEvent event = new OnScriptLoadedEvent(surfaceId, getId(), payload);
    if (eventDispatcher != null) {
      eventDispatcher.dispatchEvent(event);
    }
  }

  public enum OnScriptLoadedEventResult {
    success,
    error
  }

  private class OnScriptLoadedEvent extends Event<OnScriptLoadedEvent> {
    private final WritableMap payload;

    OnScriptLoadedEvent(int surfaceId, int viewId, WritableMap payload) {
      super(surfaceId, viewId);
      this.payload = payload;
    }

    @Override
    public String getEventName() {
      return "onScriptLoaded";
    }

    @Override
    public WritableMap getEventData() {
      return payload;
    }
  }
}

ReactWebView 扩展了 Android WebView，因此您可以轻松地重用平台已经定义的所有属性。

该类定义了三个 Android 构造函数，但将其实际实现委托给私有的 configureComponent 函数。此函数负责初始化所有组件的特定属性：在此示例中，您正在设置 WebView 的布局并定义用于自定义 WebView 行为的 WebClient。在此代码中，ReactWebView 通过实现 WebClient 的 onPageFinished 方法，在页面加载完成时发出一个事件。

然后代码定义了一个辅助函数来实际发出事件。要发出事件，您需要

  • 获取 ReactContext 的引用；
  • 检索您正在呈现的视图的 surfaceId；
  • 获取与该视图关联的 eventDispatcher 的引用；
  • 使用 WritableMap 对象构建事件的 payload；
  • 创建您需要发送到 JavaScript 的事件对象；
  • 调用 eventDispatcher.dispatchEvent 发送事件。

文件的最后一部分包含发送事件所需的数据类型的定义

  • OnScriptLoadedEventResult，包含 OnScriptLoaded 事件的可能结果。
  • 实际的 OnScriptLoadedEvent，需要扩展 React Native 的 Event 类。

3. 编写 WebViewManager​

WebViewManager 是连接 React Native 运行时和原生视图的类。

当 React 接收到应用渲染特定组件的指令时，React 会使用注册的视图管理器创建视图并传递所有必需的属性。

这是 ReactWebViewManager 的代码。

Demo/android/src/main/java/com/webview/ReactWebViewManager.java
package com.webview;

import com.facebook.react.bridge.ReactApplicationContext;
import com.facebook.react.module.annotations.ReactModule;
import com.facebook.react.uimanager.SimpleViewManager;
import com.facebook.react.uimanager.ThemedReactContext;
import com.facebook.react.uimanager.ViewManagerDelegate;
import com.facebook.react.uimanager.annotations.ReactProp;
import com.facebook.react.viewmanagers.CustomWebViewManagerInterface;
import com.facebook.react.viewmanagers.CustomWebViewManagerDelegate;

import java.util.HashMap;
import java.util.Map;

@ReactModule(name = ReactWebViewManager.REACT_CLASS)
class ReactWebViewManager extends SimpleViewManager<ReactWebView> implements CustomWebViewManagerInterface<ReactWebView> {
  private final CustomWebViewManagerDelegate<ReactWebView, ReactWebViewManager> delegate =
          new CustomWebViewManagerDelegate<>(this);

  @Override
  public ViewManagerDelegate<ReactWebView> getDelegate() {
    return delegate;
  }

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

  @Override
  public ReactWebView createViewInstance(ThemedReactContext context) {
    return new ReactWebView(context);
  }

  @ReactProp(name = "sourceUrl")
  @Override
  public void setSourceURL(ReactWebView view, String sourceURL) {
    if (sourceURL == null) {
      view.emitOnScriptLoaded(ReactWebView.OnScriptLoadedEventResult.error);
      return;
    }
    view.loadUrl(sourceURL, new HashMap<>());
  }

  public static final String REACT_CLASS = "CustomWebView";

  @Override
  public Map<String, Object> getExportedCustomBubblingEventTypeConstants() {
    Map<String, Object> map = new HashMap<>();
    Map<String, Object> bubblingMap = new HashMap<>();
    bubblingMap.put("phasedRegistrationNames", new HashMap<String, String>() {{
      put("bubbled", "onScriptLoaded");
      put("captured", "onScriptLoadedCapture");
    }});
    map.put("onScriptLoaded", bubblingMap);
    return map;
  }
}

ReactWebViewManager 扩展了 React 的 SimpleViewManager 类，并实现了由 Codegen 生成的 CustomWebViewManagerInterface。

它持有 CustomWebViewManagerDelegate 的引用，这是 Codegen 生成的另一个元素。

然后它重写 getName 函数，该函数必须返回与规范的 codegenNativeComponent 函数调用中使用的名称相同。

createViewInstance 函数负责实例化一个新的 ReactWebView。

然后，ViewManager 需要定义 React 的所有组件 props 将如何更新原生视图。在此示例中，您需要决定如何处理 React 将在 WebView 上设置的 sourceURL 属性。

最后，如果组件可以发出事件，您需要通过重写 getExportedCustomBubblingEventTypeConstants（用于冒泡事件）或 getExportedCustomDirectEventTypeConstants（用于直接事件）来映射事件名称。

4. 编写 ReactWebViewPackage​

与原生模块一样，原生组件也需要实现 ReactPackage 类。这是一个对象，您可以使用它在 React Native 运行时中注册组件。

这是 ReactWebViewPackage 的代码

Demo/android/src/main/java/com/webview/ReactWebViewPackage.java
package com.webview;

import com.facebook.react.BaseReactPackage;
import com.facebook.react.bridge.NativeModule;
import com.facebook.react.bridge.ReactApplicationContext;
import com.facebook.react.module.model.ReactModuleInfo;
import com.facebook.react.module.model.ReactModuleInfoProvider;
import com.facebook.react.uimanager.ViewManager;

import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class ReactWebViewPackage extends BaseReactPackage {
  @Override
  public List<ViewManager<?, ?>> createViewManagers(ReactApplicationContext reactContext) {
    return Collections.singletonList(new ReactWebViewManager(reactContext));
  }

  @Override
  public NativeModule getModule(String s, ReactApplicationContext reactApplicationContext) {
    if (ReactWebViewManager.REACT_CLASS.equals(s)) {
      return new ReactWebViewManager(reactApplicationContext);
    }
    return null;
  }

  @Override
  public ReactModuleInfoProvider getReactModuleInfoProvider() {
    return new ReactModuleInfoProvider() {
      @Override
      public Map<String, ReactModuleInfo> getReactModuleInfos() {
        Map<String, ReactModuleInfo> map = new HashMap<>();
        map.put(ReactWebViewManager.REACT_CLASS, new ReactModuleInfo(
                ReactWebViewManager.REACT_CLASS, // name
                ReactWebViewManager.REACT_CLASS, // className
                false,                           // canOverrideExistingModule
                false,                           // needsEagerInit
                false,                           // isCxxModule
                true                             // isTurboModule
        ));
        return map;
      }
    };
  }
}

ReactWebViewPackage 扩展了 BaseReactPackage 并实现了正确注册我们的组件所需的所有方法。

  • createViewManagers 方法是创建管理自定义视图的 ViewManager 的工厂方法。
  • getModule 方法根据 React Native 需要渲染的视图返回相应的 ViewManager。
  • getReactModuleInfoProvider 提供在运行时注册模块所需的所有信息，

5. 在应用中注册 ReactWebViewPackage​

最后，您需要在应用中注册 ReactWebViewPackage。我们通过修改 MainApplication 文件，将 ReactWebViewPackage 添加到 getPackages 函数返回的包列表中来实现此操作。

Demo/app/src/main/java/com/demo/MainApplication.kt
package com.demo

import android.app.Application
import com.facebook.react.PackageList
import com.facebook.react.ReactApplication
import com.facebook.react.ReactHost
import com.facebook.react.ReactNativeHost
import com.facebook.react.ReactPackage
import com.facebook.react.defaults.DefaultNewArchitectureEntryPoint.load
import com.facebook.react.defaults.DefaultReactHost.getDefaultReactHost
import com.facebook.react.defaults.DefaultReactNativeHost
import com.facebook.react.soloader.OpenSourceMergedSoMapping
import com.facebook.soloader.SoLoader
import com.webview.ReactWebViewPackage

class MainApplication : Application(), ReactApplication {

  override val reactNativeHost: ReactNativeHost =
      object : DefaultReactNativeHost(this) {
        override fun getPackages(): List<ReactPackage> =
            PackageList(this).packages.apply {
              add(ReactWebViewPackage())
            }

        override fun getJSMainModuleName(): String = "index"

        override fun getUseDeveloperSupport(): Boolean = BuildConfig.DEBUG

        override val isNewArchEnabled: Boolean = BuildConfig.IS_NEW_ARCHITECTURE_ENABLED
        override val isHermesEnabled: Boolean = BuildConfig.IS_HERMES_ENABLED
      }

  override val reactHost: ReactHost
    get() = getDefaultReactHost(applicationContext, reactNativeHost)

  override fun onCreate() {
    super.onCreate()
    SoLoader.init(this, OpenSourceMergedSoMapping)
    if (BuildConfig.IS_NEW_ARCHITECTURE_ENABLED) {
      load()
    }
  }
}

3. 使用您的原生组件​

最后，您可以在应用中使用新的组件。更新您生成的 App.tsx 为

Demo/App.tsx
import React from 'react';
import {Alert, StyleSheet, View} from 'react-native';
import WebView from './specs/WebViewNativeComponent';

function App(): React.JSX.Element {
  return (
    <View style={styles.container}>
      <WebView
        sourceURL="https://reactjs.ac.cn/"
        style={styles.webview}
        onScriptLoaded={() => {
          Alert.alert('Page Loaded');
        }}
      />
    </View>
  );
}

const styles = StyleSheet.create({
  container: {
    flex: 1,
    alignItems: 'center',
    alignContent: 'center',
  },
  webview: {
    width: '100%',
    height: '100%',
  },
});

export default App;

此代码创建了一个应用，该应用使用我们创建的新 WebView 组件来加载 react.dev 网站。

当网页加载完成时，应用还会显示一个提示。

4. 使用 WebView 组件运行您的应用​

bash
yarn run android
AndroidiOS