在原生组件上调用原生函数

在编写新原生组件的基本指南中，您已经了解了如何创建新组件，如何将属性从 JS 端传递到原生端，以及如何从原生端向 JS 发送事件。

自定义组件还可以命令式地调用原生代码中实现的一些函数，以实现一些更高级的功能，例如通过编程方式重新加载网页。

在本指南中，您将学习如何使用一个新概念：原生命令（Native Commands）来实现这一点。

本指南以原生组件指南为基础，并假设您熟悉该指南以及Codegen。

1. 更新组件规范

第一步是更新组件规范以声明 NativeCommand。

TypeScript
Flow

如下更新 WebViewNativeComponent.ts

Demo/specs/WebViewNativeComponent.ts
import type {HostComponent, ViewProps} from 'react-native';
import type {BubblingEventHandler} from 'react-native/Libraries/Types/CodegenTypes';
import codegenNativeComponent from 'react-native/Libraries/Utilities/codegenNativeComponent';
+import codegenNativeCommands from 'react-native/Libraries/Utilities/codegenNativeCommands';

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

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

+interface NativeCommands {
+    reload: (viewRef: React.ElementRef<HostComponent<NativeProps>>) => void;
+}

+export const Commands: NativeCommands = codegenNativeCommands<NativeCommands>({
+    supportedCommands: ['reload'],
+});

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

如下更新 WebViewNativeComponent.js

Demo/specs/WebViewNativeComponent.js
// @flow strict-local

import type {HostComponent, ViewProps} from 'react-native';
import type {BubblingEventHandler} from 'react-native/Libraries/Types/CodegenTypes';
import codegenNativeComponent from 'react-native/Libraries/Utilities/codegenNativeComponent';
+import codegenNativeCommands from 'react-native/Libraries/Utilities/codegenNativeCommands';

type WebViewScriptLoadedEvent = $ReadOnly<{|
  result: "success" | "error",
|}>;

type NativeProps = $ReadOnly<{|
  ...ViewProps,
  sourceURL?: string;
  onScriptLoaded?: BubblingEventHandler<WebViewScriptLoadedEvent>?;
|}>;

+interface NativeCommands {
+    reload: (viewRef: React.ElementRef<HostComponent<NativeProps>>) => void;
+}

+export const Commands: NativeCommands = codegenNativeCommands<NativeCommands>({
+    supportedCommands: ['reload'],
+});

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

这些更改要求您

从 react-native 导入 codegenNativeCommands 函数。这会指示 codegen 生成 NativeCommands 的代码。
定义一个接口，其中包含我们要在原生代码中调用的方法。所有原生命令的第一个参数都必须是 React.ElementRef 类型。
导出 Commands 变量，它是 codegenNativeCommands 调用并传入支持命令列表的结果。

警告

在 TypeScript 中，React.ElementRef 已弃用。正确的类型实际上是 React.ComponentRef。但是，由于 Codegen 中的一个错误，使用 ComponentRef 会导致应用程序崩溃。我们已经有了修复方案，但需要发布新版本的 React Native 才能应用它。

2. 更新应用代码以使用新命令

现在您可以在应用程序中使用该命令。

TypeScript
Flow

打开 App.tsx 文件并进行如下修改

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

function App(): React.JSX.Element {
+    const webViewRef = React.useRef<React.ElementRef<typeof View> | null>(null);
+
+    const refresh = () => {
+        if (webViewRef.current) {
+            Commands.reload(webViewRef.current);
+        }
+    };

  return (
    <View style={styles.container}>
      <WebView
+       ref={webViewRef}
        sourceURL="https://reactjs.ac.cn/"
        style={styles.webview}
        onScriptLoaded={() => {
          Alert.alert('Page Loaded');
        }}
      />
+      <View style={styles.tabbar}>
+        <Pressable onPress={refresh} style={styles.button}>
+            {({pressed}) => (
+                !pressed ? <Text style={styles.buttonText}>Refresh</Text> : <Text style={styles.buttonTextPressed}>Refresh</Text>) }
+        </Pressable>
+      </View>
    </View>
  );
}

const styles = StyleSheet.create({
  container: {
    flex: 1,
    alignItems: 'center',
    alignContent: 'center',
  },
  webview: {
    width: '100%',
-    height: '100%',
+    height: '90%',
  },
+  tabbar: {
+    flex: 1,
+    backgroundColor: 'gray',
+    width: '100%',
+    alignItems: 'center',
+    alignContent: 'center',
+  },
+  button: {
+    margin: 10,
+  },
+  buttonText: {
+    fontSize: 20,
+    fontWeight: 'bold',
+    color: '#00D6FF',
+    width: '100%',
+  },
+  buttonTextPressed: {
+    fontSize: 20,
+    fontWeight: 'bold',
+    color: '#00D6FF77',
+    width: '100%',
+  },
});

export default App;

打开 App.tsx 文件并进行如下修改

App.jsx
import React from 'react';
-import {Alert, StyleSheet, View} from 'react-native';
-import WebView from '../specs/WebViewNativeComponent';
+import {Alert, StyleSheet, Pressable, Text, View} from 'react-native';
+import WebView, {Commands} from '../specs/WebViewNativeComponent';

function App(): React.JSX.Element {
+    const webViewRef = React.useRef<React.ElementRef<typeof View> | null>(null);
+
+    const refresh = () => {
+        if (webViewRef.current) {
+            Commands.reload(webViewRef.current);
+        }
+    };

  return (
    <View style={styles.container}>
      <WebView
+       ref={webViewRef}
        sourceURL="https://reactjs.ac.cn/"
        style={styles.webview}
        onScriptLoaded={() => {
          Alert.alert('Page Loaded');
        }}
      />
+      <View style={styles.tabbar}>
+        <Pressable onPress={refresh} style={styles.button}>
+            {({pressed}) => (
+                !pressed ? <Text style={styles.buttonText}>Refresh</Text> : <Text style={styles.buttonTextPressed}>Refresh</Text>) }
+        </Pressable>
+      </View>
    </View>
  );
}

const styles = StyleSheet.create({
  container: {
    flex: 1,
    alignItems: 'center',
    alignContent: 'center',
  },
  webview: {
    width: '100%',
-    height: '100%',
+    height: '90%',
  },
+  tabbar: {
+    flex: 1,
+    backgroundColor: 'gray',
+    width: '100%',
+    alignItems: 'center',
+    alignContent: 'center',
+  },
+  button: {
+    margin: 10,
+  },
+  buttonText: {
+    fontSize: 20,
+    fontWeight: 'bold',
+    color: '#00D6FF',
+    width: '100%',
+  },
+  buttonTextPressed: {
+    fontSize: 20,
+    fontWeight: 'bold',
+    color: '#00D6FF77',
+    width: '100%',
+  },
});

export default App;

此处的相关更改如下：

从规范文件中导入 Commands 常量。Command 是一个对象，它允许我们调用原生代码中的方法。
使用 useRef 声明对 WebView 自定义原生组件的引用。您需要将此引用传递给原生命令。
实现 refresh 函数。此函数检查 WebView 的引用是否为空，如果不为空，则调用命令。
添加一个可按元素，以便在用户点击按钮时调用命令。

剩余的更改是常规的 React 更改，用于添加 Pressable 并设置视图样式，使其看起来更美观。

3. 重新运行 Codegen

现在规范已更新，代码也已准备好使用命令，是时候实现原生代码了。然而，在深入编写原生代码之前，您必须重新运行 codegen，让它生成原生代码所需的新类型。

Android
iOS

Codegen 通过 generateCodegenArtifactsFromSchema Gradle 任务执行

bash
cd android
./gradlew generateCodegenArtifactsFromSchema

BUILD SUCCESSFUL in 837ms
14 actionable tasks: 3 executed, 11 up-to-date

当您构建 Android 应用程序时，此操作会自动运行。

Codegen 作为 CocoaPods 生成的项目中自动添加的脚本阶段的一部分运行。

bash
cd ios
bundle install
bundle exec pod install

输出将如下所示

shell
...
Framework build type is static library
[Codegen] Adding script_phases to ReactCodegen.
[Codegen] Generating ./build/generated/ios/ReactCodegen.podspec.json
[Codegen] Analyzing /Users/me/src/TurboModuleExample/package.json
[Codegen] Searching for codegen-enabled libraries in the app.
[Codegen] Found TurboModuleExample
[Codegen] Searching for codegen-enabled libraries in the project dependencies.
[Codegen] Found react-native
...

4. 实现原生代码

现在是时候实现原生更改了，这将使您的 JS 能够直接在您的原生视图上调用方法。

Android
iOS

要让您的视图响应原生命令，您只需修改 ReactWebViewManager。

如果您现在尝试构建，构建将会失败，因为当前的 ReactWebViewManager 未实现新的 reload 方法。要修复构建错误，让我们修改 ReactWebViewManager 来实现它。

Java
Kotlin

ReactWebViewManager.java

//...
  @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<>());
  }

+  @Override
+  public void reload(ReactWebView view) {
+    view.reload();
+  }

  public static final String REACT_CLASS = "CustomWebView";
//...

ReactWebViewManager.kt
  @ReactProp(name = "sourceUrl")
  override fun setSourceURL(view: ReactWebView, sourceURL: String?) {
    if (sourceURL == null) {
      view.emitOnScriptLoaded(ReactWebView.OnScriptLoadedEventResult.error)
      return;
    }
    view.loadUrl(sourceURL, emptyMap())
  }

+  override fun reload(view: ReactWebView) {
+    view.reload()
+  }

  companion object {
    const val REACT_CLASS = "CustomWebView"
  }

在这种情况下，直接调用 view.reload() 方法就足够了，因为我们的 ReactWebView 继承自 Android 的 WebView，并且它直接提供了 reload 方法。如果您正在实现一个自定义函数，而该函数在您的自定义视图中不可用，您可能还需要在由 React Native 的 ViewManager 管理的 Android 视图中实现所需的方法。

为了让您的视图响应原生命令，我们需要在 iOS 上实现几个方法。

让我们打开 RCTWebView.mm 文件并进行如下修改

RCTWebView.mm
  // Event emitter convenience method
  - (const CustomWebViewEventEmitter &)eventEmitter
  {
  return static_cast<const CustomWebViewEventEmitter &>(*_eventEmitter);
  }

+  - (void)handleCommand:(const NSString *)commandName args:(const NSArray *)args
+  {
+  RCTCustomWebViewHandleCommand(self, commandName, args);
+  }
+
+  - (void)reload
+  {
+  [_webView reloadFromOrigin];
+  }

  + (ComponentDescriptorProvider)componentDescriptorProvider
  {
  return concreteComponentDescriptorProvider<CustomWebViewComponentDescriptor>();
  }

要使您的视图响应原生命令，您需要应用以下更改

添加一个 handleCommand:args 函数。此函数由组件基础设施调用以处理命令。该函数的实现对于每个组件都类似：您需要调用一个由 Codegen 为您生成的 RCT<componentNameInJS>HandleCommand 函数。RCT<componentNameInJS>HandleCommand 会执行一系列验证，检查我们需要调用的命令是否在支持的命令中，以及传递的参数是否与预期匹配。如果所有检查都通过，RCT<componentNameInJS>HandleCommand 将调用相应的原生方法。
实现 reload 方法。在此示例中，reload 方法调用 WebKit 的 WebView 的 reloadFromOrigin 函数。

5. 运行您的应用

最后，您可以使用常用命令运行您的应用。应用运行后，您可以点击刷新按钮查看页面重新加载。

Android	iOS

1. 更新组件规范​

2. 更新应用代码以使用新命令​

3. 重新运行 Codegen​

4. 实现原生代码​

5. 运行您的应用​

1. 更新组件规范

2. 更新应用代码以使用新命令

3. 重新运行 Codegen

4. 实现原生代码

5. 运行您的应用